Skip to content

Commit

Permalink
doc: add section to show how to customize cilium-agent metrics
Browse files Browse the repository at this point in the history
Signed-off-by: ArthurChiao <arthurchiao@hotmail.com>
  • Loading branch information
ArthurChiao authored and tklauser committed Nov 16, 2022
1 parent ef4eea9 commit 2fe3a92
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions Documentation/observability/metrics.rst
Expand Up @@ -203,8 +203,18 @@ To expose any metrics, invoke ``cilium-agent`` with the
passing an empty IP (e.g. ``:9962``) will bind the server to all available
interfaces (there is usually only one in a container).

Exported Metrics
^^^^^^^^^^^^^^^^
To customize ``cilium-agent`` metrics, configure the ``--metrics`` option with
``"+metric_a -metric_b -metric_c"``, where ``+/-`` means to enable/disable
the metric. For example, for really large clusters, users may consider to
disable the following two metrics as they generate too much data:

- ``cilium_node_connectivity_status``
- ``cilium_node_connectivity_latency_seconds``

You can then configure the agent with ``--metrics="-cilium_node_connectivity_status -cilium_node_connectivity_latency_seconds"``.

Exported Metrics by Default
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Endpoint
~~~~~~~~
Expand Down

0 comments on commit 2fe3a92

Please sign in to comment.