Repository navigation
docs(proxy-metrics): fix identity certificate metric names - #2164
Open
NopeCharon wants to merge 1 commit into
Open
NopeCharon wants to merge 1 commit into
NopeCharon wants to merge 1 commit into
Conversation
Problem The Identity Metrics section of the proxy metrics reference still lists `identity_cert_expiration_timestamp_seconds` and `identity_cert_refresh_count`, which no longer match what the proxy exports: - linkerd2-proxy#2617 (proxy v2.221.0, Linkerd 2.15) renamed `identity_cert_refresh_count` to `identity_cert_refreshes_total`, gave it a `result` label, and added `identity_cert_refresh_timestamp_seconds`. - linkerd2-proxy#2887 (edge-24.5.1, Linkerd 2.16) registered these metrics under the `control_identity` prefix, so they are now exported as `control_identity_cert_*`. Users building dashboards or alerts from the docs end up querying metrics that do not exist. Solution Document the metric names that each version actually exports: - 2.15: `identity_cert_expiration_timestamp_seconds`, `identity_cert_refresh_timestamp_seconds` and `identity_cert_refreshes_total`. - 2.16 through 2.19, edge and docs: the same metrics with the `control_identity_cert_` prefix. Also describe the `result` label (`ok`/`error`) of the refreshes counter. Docs for 2.14 and earlier are unchanged, since those proxies still export `identity_cert_refresh_count`. Fixes linkerd#1776 Signed-off-by: NopeCharon <115794254+NopeCharon@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Identity Metrics section of the proxy metrics reference lists
identity_cert_expiration_timestamp_secondsandidentity_cert_refresh_count. Neither name matches what current proxies export:identity_cert_refresh_counttoidentity_cert_refreshes_totaland added aresultlabel. It also addedidentity_cert_refresh_timestamp_seconds.control_identityprefix. Since then they have been exported ascontrol_identity_cert_*, which matches what the issue reports.This PR documents the names each version actually exports:
identity_cert_expiration_timestamp_seconds,identity_cert_refresh_timestamp_seconds,identity_cert_refreshes_totalcontrol_identity_cert_expiration_timestamp_seconds,control_identity_cert_refresh_timestamp_seconds,control_identity_cert_refreshes_totalIt also documents the
resultlabel (ok/error) on the refreshes counter. I left 2.14 and earlier unchanged because their proxy (v2.210.x) still exportsidentity_cert_refresh_count.The names come from the proxy source at the release tags each version ships (
.proxy-versionin linkerd2):linkerd/identity/src/metrics.rs, plus the registry prefixes inlinkerd/app/src/{lib,identity}.rs.Testing:
make lintpasses, and a localhugobuild renders the updated lists on the 2.15, 2.19 and edge pages.Fixes #1776