[documentation] Update rollup rules documentation to provide an example of aggregating gauges #3852
Conversation
This file contains 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
…le of aggregating gauges
wesleyk
approved these changes
Oct 18, 2021
ryanhall07
approved these changes
Oct 18, 2021
| - name: "job queue length sum across pods pod" | ||
| filter: "__name__:job_queue_length k8s_pod:*" | ||
| transforms: | ||
| - aggregate: |
There was a problem hiding this comment.
nit: this is not required. not sure if it's worth documenting anything about the "default aggregation" applied if one is not set.
There was a problem hiding this comment.
Fair, I think it's worth keeping here just for a level of understanding of the reader of the explicit steps happening for each of the aggregations.
We should document the default aggregation somewhere else though to your point, perhaps in a followup change.
| type: "Last" | ||
| - rollup: | ||
| metricName: "job_queue_length:sum" | ||
| excludeBy: ["k8s_pod"] |
There was a problem hiding this comment.
nit: maybe show a groupBy in addition to an excludeBy
There was a problem hiding this comment.
Good point, I might do that in a followup.
soundvibe
pushed a commit
that referenced
this pull request
Oct 26, 2021
* master: Remove unused message-read-error metric (#3869) Add p75/p25 as aggregation options (#3867) [aggregator] track dirty values to consume instead of scanning all within buffer past (#3847) [rules] Correctly match rollup tags for excludeBy operations (#3865) [dbnode] Create empty warm index fileset (#3859) [aggregator] Allow wait during tick to be interrupted on close (#3861) [aggregator] Add support for default configuration (#3856) [dbnode] Add WriteAttempt integration test index helper method (#3860) [tools] Allow reading all the shards in the directory in read_data_files (#3857) [tests] Add test for in-process aggregator writes [tools] Add annotation_checker tool (#3854) [tests] Convert docker-integration-tests/simple/test.sh to in-process test (#3850) [documentation] Update rollup rules documentation to provide an example of aggregating gauges (#3852)
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.
What this PR does / why we need it:
Adds examples of how to write rollup rules that aggregate gauges across a set of instances.
Special notes for your reviewer:
Does this PR introduce a user-facing and/or backwards incompatible change?:
Does this PR require updating code package or user-facing documentation?: