Skip to content

stats: add bootstrap annotations for stats flush and eviction #3562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
istio-testing merged 2 commits into from
Sep 18, 2025
+138 −0
Merged

stats: add bootstrap annotations for stats flush and eviction #3562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4183d8f
add bootstrap annotations
kyessenov Sep 4, 2025
3707c10
histogram bin sizes
kyessenov Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions annotation/annotations.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

66 changes: 66 additions & 0 deletions annotation/annotations.pb.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions annotation/annotations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,35 @@ annotations:
resources:
- Pod

- name: sidecar.istio.io/statsFlushInterval
Copy link
Copy Markdown
Contributor

@keithmattix keithmattix Sep 18, 2025

Choose a reason for hiding this comment

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

Does the sidecar prefix mean this doesn't work for gateways/waypoints? I would guess no (that this is just convention) but wanted to confirm

Copy link
Copy Markdown
Contributor Author

@kyessenov kyessenov Sep 18, 2025

Choose a reason for hiding this comment

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

No, it's interpreted by pilot-agent which is the same for gateways and sidecars.

featureStatus: Alpha
description: Specifies the flush interval for push-based stat sinks, e.g. OTLP. Default interval is `5s`.
Copy link
Copy Markdown
Contributor

@keithmattix keithmattix Sep 4, 2025

Choose a reason for hiding this comment

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

qq: if this is only for push-based stats sinks, what about prometheus (pull based)?

Copy link
Copy Markdown
Contributor Author

@kyessenov kyessenov Sep 4, 2025

Choose a reason for hiding this comment

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

Flush interval doesn't matter for prometheus. However, eviction piggy backs on flush timer, and eviction works for prometheus.

Copy link
Copy Markdown
Member

@howardjohn howardjohn Sep 4, 2025

Choose a reason for hiding this comment

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

I don't get it. if it doesn't matter, but we evict when we flush, then it does matter...? And if the default is 5s, isn't that going to break prometheus?

Copy link
Copy Markdown
Contributor Author

@kyessenov kyessenov Sep 4, 2025

Choose a reason for hiding this comment

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

Envoy always runs a stats flush timer, regardless of prometheus. During that timer, server stats are published (e.g. memory allocations, etc), and some other work is done, e.g. eviction.

Prometheus endpoint can snip stats are any point through, in between flushes.

So flush impacts prometheus only indirectly, e.g. by updating/removing some metrics.

Copy link
Copy Markdown
Member

@howardjohn howardjohn Sep 4, 2025

Choose a reason for hiding this comment

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

Maybe more concretely... I send 1 request to foo.com. I get an istio_request_total metric for it.

When, with prometheus, will this metric stop showing up in /stats/prometheus with/without this annotation set?

Copy link
Copy Markdown
Contributor Author

@kyessenov kyessenov Sep 4, 2025

Choose a reason for hiding this comment

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

For flush annotation: it will show up immediately and stay forever.
For eviction annotation: same, but it will disappear after 2*eviction interval unless the metric gets another hit.

Copy link
Copy Markdown
Member

@howardjohn howardjohn Sep 4, 2025

Choose a reason for hiding this comment

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

Thanks! Sorry I was being a bit dense, github UI was hiding part of the PR

Copy link
Copy Markdown
Member

@zirain zirain Sep 8, 2025

Choose a reason for hiding this comment

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

@howardjohn @keithmattix can we move this forward?

deprecated: false
hidden: false
resources:
- Pod

- name: sidecar.istio.io/statsEvictionInterval
featureStatus: Alpha
description: Specifies the expiration interval for the Istio standard
metrics. This gets rounded to a multiple of the flush interval. A time
series is expected to be evicted after 2 iterations of this interval from
the last measurement.
deprecated: false
hidden: false
resources:
- Pod

- name: sidecar.istio.io/statsHistogramBins
featureStatus: Alpha
description: Specifies the bin size per time series for the Istio standard
metrics histograms. Reducing this value from the default `100` decreases
overall memory usage for sparse and/or high cardinality histograms.
deprecated: false
hidden: false
resources:
- Pod

- name: sidecar.istio.io/userVolume
featureStatus: Alpha
description: Specifies one or more user volumes (as a JSON array) to be added to
Expand Down