docs: document exporter.staleness_threshold in README#78
Merged
softberries merged 1 commit intomainfrom Apr 21, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the operator documentation to clarify how the exporter’s metrics staleness filtering behaves, specifically introducing and explaining exporter.staleness_threshold and its default behavior as poll_interval * 3.
Changes:
- Adds a commented
staleness_thresholdexample to the main[exporter]config snippet inREADME.md. - Adds guidance in the large-cluster tuning section explaining that the default staleness threshold scales with
poll_interval(×3) and when to override it.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
staleness_thresholdto the main[exporter]config block in README.md.poll_interval(×3) — important context for operators raising poll interval to 60–180s on large clusters.Follow-up documentation for #76 (code, merged) and #77 (helm chart, open).
Why
Operators landing in the large-cluster section to bump
poll_intervalpreviously had no signal about how the staleness threshold behaves — they might assume it's still 90s and see metrics disappear between cycles. Now they know the default scales automatically and how to override it.Test plan
poll_interval * 3fallback,Option<Duration>override in config).