From 2fe3a92b003c5349df935dfe59de667fa92d73f8 Mon Sep 17 00:00:00 2001 From: ArthurChiao Date: Tue, 15 Nov 2022 16:51:26 +0800 Subject: [PATCH] doc: add section to show how to customize cilium-agent metrics Signed-off-by: ArthurChiao --- Documentation/observability/metrics.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/Documentation/observability/metrics.rst b/Documentation/observability/metrics.rst index 5d07cb6d0955..e262de42e69d 100644 --- a/Documentation/observability/metrics.rst +++ b/Documentation/observability/metrics.rst @@ -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 ~~~~~~~~