Skip to content

Commit ab7dda1

Browse files
committed
Metrics config reference
1 parent a7db468 commit ab7dda1

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

doc/reference/configuration/configuration_reference.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2661,6 +2661,64 @@ The ``memtx`` section is used to configure parameters related to the :ref:`memtx
26612661
| Default: box.NULL
26622662
| Environment variable: TT_MEMTX_SORT_THREADS
26632663
2664+
2665+
2666+
2667+
.. _configuration_reference_metrics:
2668+
2669+
metrics
2670+
-------
2671+
2672+
The ``metrics`` section defines configuration parameters for :ref:`metrics <monitoring>`.
2673+
2674+
.. NOTE::
2675+
2676+
``metrics`` can be defined in any :ref:`scope <configuration_scopes>`.
2677+
2678+
- :ref:`metrics.exclude <configuration_reference_metrics_exclude>`
2679+
- :ref:`metrics.include <configuration_reference_metrics_include>`
2680+
- :ref:`metrics.labels <configuration_reference_metrics_labels>`
2681+
2682+
2683+
.. _configuration_reference_metrics_exclude:
2684+
2685+
.. confval:: metrics.exclude
2686+
2687+
**Example**
2688+
2689+
.. literalinclude:: /code_snippets/snippets/config/instances.enabled/metrics/config.yaml
2690+
:end-before: roles:
2691+
:language: yaml
2692+
:dedent:
2693+
2694+
|
2695+
| Type: array
2696+
| Default: nil
2697+
| Environment variable: TT_METRICS_EXCLUDE
2698+
2699+
2700+
.. _configuration_reference_metrics_include:
2701+
2702+
.. confval:: metrics.include
2703+
2704+
|
2705+
| Type: array
2706+
| Default: nil
2707+
| Environment variable: TT_METRICS_INCLUDE
2708+
2709+
2710+
.. _configuration_reference_metrics_labels:
2711+
2712+
.. confval:: metrics.labels
2713+
2714+
|
2715+
| Type: map
2716+
| Default: nil
2717+
| Environment variable: TT_METRICS_LABELS
2718+
2719+
2720+
2721+
26642722
.. _configuration_reference_process:
26652723

26662724
process

0 commit comments

Comments
 (0)