Skip to content

Commit 46bf839

Browse files
committed
Metrics config
1 parent 31bf30f commit 46bf839

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

doc/reference/configuration/configuration_reference.rst

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2988,6 +2988,73 @@ The ``memtx`` section is used to configure parameters related to the :ref:`memtx
29882988
| Default: box.NULL
29892989
| Environment variable: TT_MEMTX_SORT_THREADS
29902990
2991+
2992+
2993+
2994+
.. _configuration_reference_metrics:
2995+
2996+
metrics
2997+
-------
2998+
2999+
The ``metrics`` section defines configuration parameters for :ref:`metrics <monitoring>`.
3000+
3001+
.. NOTE::
3002+
3003+
``metrics`` can be defined in any :ref:`scope <configuration_scopes>`.
3004+
3005+
- :ref:`metrics.exclude <configuration_reference_metrics_exclude>`
3006+
- :ref:`metrics.include <configuration_reference_metrics_include>`
3007+
- :ref:`metrics.labels <configuration_reference_metrics_labels>`
3008+
3009+
3010+
.. _configuration_reference_metrics_exclude:
3011+
3012+
.. confval:: metrics.exclude
3013+
3014+
Metrics to turn off.
3015+
This option accepts the same values as the ``exclude`` configuration parameter passed to :ref:`metrics.cfg() <metrics_cfg>`.
3016+
3017+
**Example**
3018+
3019+
.. literalinclude:: /code_snippets/snippets/sharding/instances.enabled/sharded_cluster_crud_metrics/config.yaml
3020+
:start-at: metrics:
3021+
:end-at: instance_name
3022+
:language: yaml
3023+
:dedent:
3024+
3025+
|
3026+
| Type: array
3027+
| Default: nil
3028+
| Environment variable: TT_METRICS_EXCLUDE
3029+
3030+
3031+
.. _configuration_reference_metrics_include:
3032+
3033+
.. confval:: metrics.include
3034+
3035+
Metrics to turn on.
3036+
This option accepts the same values as the ``include`` configuration parameter passed to :ref:`metrics.cfg() <metrics_cfg>`.
3037+
3038+
|
3039+
| Type: array
3040+
| Default: nil
3041+
| Environment variable: TT_METRICS_INCLUDE
3042+
3043+
3044+
.. _configuration_reference_metrics_labels:
3045+
3046+
.. confval:: metrics.labels
3047+
3048+
Global :ref:`labels <metrics-api_reference-labels>` to be added to every observation.
3049+
3050+
|
3051+
| Type: map
3052+
| Default: nil
3053+
| Environment variable: TT_METRICS_LABELS
3054+
3055+
3056+
3057+
29913058
.. _configuration_reference_process:
29923059

29933060
process

0 commit comments

Comments
 (0)