Skip to content

Update metric expiry and cardinality docs to mention sidecar.istio.io/statsEvictionInterval and Telemetry resource#17043

Merged
istio-testing merged 4 commits intoistio:masterfrom
ringerc:metric-expiry-docs
Jan 5, 2026
Merged

Update metric expiry and cardinality docs to mention sidecar.istio.io/statsEvictionInterval and Telemetry resource#17043
istio-testing merged 4 commits intoistio:masterfrom
ringerc:metric-expiry-docs

Conversation

@ringerc
Copy link
Copy Markdown
Contributor

@ringerc ringerc commented Dec 18, 2025

Description

  • Update the FAQ for metric expiry to mention sidecar.istio.io/statsEvictionInterval now that support for metric expiry was added by telemetry: add bootstrap annotations for stats flush and eviction istio#57736
  • Mention the Telemetry resource's features for overriding metrics and dimensions in the FAQ for metric cardinality
  • Link to the Telemetry resource and the docs for customising metrics in the reference docs for standard labels
  • Warn that dropping labels scrape-side in Prometheus will have undesired results

Reviewers

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@ringerc ringerc requested a review from a team as a code owner December 18, 2025 03:59
@istio-policy-bot
Copy link
Copy Markdown

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, our style guidelines,
    and the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be built with
    a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
    valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    lint_istio.io entry in the status section. Click on the Details link to get a list of the
    problems with your PR. Fix those problems and push an update; this will automatically re-run the
    tests. Hopefully this time everything will be perfect!

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).
    To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
    release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 18, 2025
@istio-testing
Copy link
Copy Markdown
Contributor

Hi @ringerc. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link
Copy Markdown
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

@istio-testing istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Dec 19, 2025
@Ajay-singh1
Copy link
Copy Markdown
Member

The tests are failing you need to run make lint to fix the linting errors.

@ringerc ringerc force-pushed the metric-expiry-docs branch 2 times, most recently from 7fef343 to 4aec16c Compare December 30, 2025 01:40
@ringerc
Copy link
Copy Markdown
Contributor Author

ringerc commented Dec 30, 2025

@Ajay-singh1 Fixed, thanks

Comment thread content/en/about/faq/metrics-and-logs/metric-expiry.md Outdated
Comment thread content/en/about/faq/metrics-and-logs/metric-expiry.md Outdated
Comment thread content/en/about/faq/metrics-and-logs/telemetry-v1-vs-v2.md Outdated
Copy link
Copy Markdown
Member

@zirain zirain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this.

in in-proxy telemetry for latency metrics at the lower latency levels.

* **No metric expiration for short-lived metrics**
* ~~**No metric expiration for short-lived metrics**~~
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not do strikethroughs. If you're striking through, typically means it no longer applies and should be removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. Better? I'd rather not remove the section completely, especially since expiry is not enabled by default.

@ringerc ringerc force-pushed the metric-expiry-docs branch from 804e905 to e0336aa Compare January 1, 2026 07:02
In the documentation listing metrics and labels, list the names used to
refer to these labels in configuration - and the actual label used in
telemetry. Also link to the Telemetry API resource that can be used to
customise them.
The FAQ on metric expiry and the telemetry v1 to v2 transition
FAQ claim that metric expiry is not supported, but as-of the
introduction of sidecar.istio.io/statsEvictionInterval in
istio/istio#57736 this is no longer the case.

API docs were added with the feature PR but other docs need updating
to reflect that metrics may now be expired.
@ringerc ringerc force-pushed the metric-expiry-docs branch from e0336aa to 8116e0d Compare January 4, 2026 22:35
@ringerc
Copy link
Copy Markdown
Contributor Author

ringerc commented Jan 4, 2026

Rebased to current master and I think I should've addressed the review comments @dhawton and @zirain

@dhawton dhawton added the cherrypick/release-1.28 Set this label on a PR to auto-merge it to the release-1.28 branch label Jan 5, 2026
@istio-testing istio-testing merged commit 15d7c58 into istio:master Jan 5, 2026
6 checks passed
wilsonwu added a commit to wilsonwu/istio.io that referenced this pull request Jan 6, 2026
… sidecar.istio.io/statsEvictionInterval and Telemetry resource into Chinese
istio-testing pushed a commit that referenced this pull request Jan 11, 2026
… sidecar.istio.io/statsEvictionInterval and Telemetry resource into Chinese (#17077)

* Sync #17043 update metric expiry and cardinality docs to mention sidecar.istio.io/statsEvictionInterval and Telemetry resource into Chinese

* fix lint
istio-testing pushed a commit to istio-testing/istio.io that referenced this pull request Jan 11, 2026
… sidecar.istio.io/statsEvictionInterval and Telemetry resource into Chinese
istio-testing added a commit that referenced this pull request Jan 14, 2026
…docs to mention sidecar.istio.io/statsEvictionInterval and Telemetry resource into Chinese (#17086)

* Sync #17043 update metric expiry and cardinality docs to mention sidecar.istio.io/statsEvictionInterval and Telemetry resource into Chinese

* fix lint

---------

Co-authored-by: Wilson Wu <iwilsonwu@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherrypick/release-1.28 Set this label on a PR to auto-merge it to the release-1.28 branch ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants