Skip to content

Commit

Permalink
docs: Fix incorrect FQDN metrics which are disabled by default
Browse files Browse the repository at this point in the history
This metrics were incorrectly stating that they were enabled by default
which confused users. Fix it to mention they are disabled by default and
must be enabled explicitly via --metrics.

Fixes: 1133bd5 ("docs: Added `Default` column in metrics details")
Fixes: cilium#20255

Signed-off-by: Chris Tarazi <chris@isovalent.com>
  • Loading branch information
christarazi authored and joestringer committed Nov 22, 2022
1 parent e3b0095 commit f072dbd
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions Documentation/observability/metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -435,14 +435,14 @@ Name Labels Default Des
FQDN
~~~~

================================== ================================ =========== ========================================================
Name Labels Default Description
================================== ================================ =========== ========================================================
``fqdn_gc_deletions_total`` Enabled Number of FQDNs that have been cleaned on FQDN garbage collector job
``fqdn_active_names`` ``endpoint`` Enabled Number of domains inside the DNS cache that have not expired (by TTL), per endpoint
``fqdn_active_ips`` ``endpoint`` Enabled Number of IPs inside the DNS cache associated with a domain that has not expired (by TTL), per endpoint
``fqdn_alive_zombie_connections`` ``endpoint`` Enabled Number of IPs associated with domains that have expired (by TTL) yet still associated with an active connection (aka zombie), per endpoint
================================== ================================ =========== ========================================================
================================== ================================ ============ ========================================================
Name Labels Default Description
================================== ================================ ============ ========================================================
``fqdn_gc_deletions_total`` Enabled Number of FQDNs that have been cleaned on FQDN garbage collector job
``fqdn_active_names`` ``endpoint`` Disabled Number of domains inside the DNS cache that have not expired (by TTL), per endpoint
``fqdn_active_ips`` ``endpoint`` Disabled Number of IPs inside the DNS cache associated with a domain that has not expired (by TTL), per endpoint
``fqdn_alive_zombie_connections`` ``endpoint`` Disabled Number of IPs associated with domains that have expired (by TTL) yet still associated with an active connection (aka zombie), per endpoint
================================== ================================ ============ ========================================================

.. _metrics_api_rate_limiting:

Expand Down

0 comments on commit f072dbd

Please sign in to comment.