Skip to content
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.

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

Update exemplar docs based on changes to exemplar storage configuration #9868

Merged
merged 2 commits into from
Dec 1, 2021

Conversation

cstyan
Copy link
Member

@cstyan cstyan commented Nov 25, 2021

@LeviHarrison pointed out that we hadn't updated the docs based on the changes from #8974

@roidelapluie not sure how we go about backporting docs into the right releases. Releases from 2.29 forward should have the docs changes from this PR (https://github.com/prometheus/prometheus/releases/tag/v2.29.0)

Signed-off-by: Callum Styan callumstyan@gmail.com

Signed-off-by: Callum Styan <callumstyan@gmail.com>

Note that exemplar storage is still considered experimental and must be enabled via `--enable-feature=exemplar-storage`.

```yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

There should be a closing ``` after the following documentation.

Comment on lines 2852 to 2853
# Configures the maximum size of the circular buffer used to store exemplars for all series. Resizable during runtime.
[ max_exemplars: <int> | default = 100000 ]
Copy link
Contributor

Choose a reason for hiding this comment

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

No indent is needed here.

Suggested change
# Configures the maximum size of the circular buffer used to store exemplars for all series. Resizable during runtime.
[ max_exemplars: <int> | default = 100000 ]
# Configures the maximum size of the circular buffer used to store exemplars for all series. Resizable during runtime.
[ max_exemplars: <int> | default = 100000 ]

Signed-off-by: Callum Styan <callumstyan@gmail.com>
Copy link
Contributor

@LeviHarrison LeviHarrison left a comment

Choose a reason for hiding this comment

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

Thanks!

@juliusv
Copy link
Member

juliusv commented Dec 1, 2021

👍 Thanks!

@juliusv juliusv merged commit 086ca90 into main Dec 1, 2021
@juliusv juliusv deleted the exemplar-docs-update-20211125 branch December 1, 2021 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants