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 alerting_rules.md #7252

Merged
merged 1 commit into from Sep 7, 2020
Merged

Conversation

justinwalz
Copy link
Contributor

Docs only change. Fix ALERTS example to use regex.

@roidelapluie
Copy link
Member

roidelapluie commented May 12, 2020

Thanks for your PR.

This is not a promql expression, therefore I don't think this should be fixed.

@justinwalz
Copy link
Contributor Author

Interesting. Why's that?

Someone could be reading the docs, see this expression, copy and paste it into their expression executor, run it, and not seeing anything.

Copy:

ALERTS{alertname="<alert name>", alertstate="pending|firing", <additional alert labels>}

Paste and Adjust to:

ALERTS{alertstate="pending|firing"}

No results, head-scratch. Or simply believe they don't have any firing or pending alerts.

@stale stale bot added the stale label Jul 11, 2020
@roidelapluie
Copy link
Member

Mmh indeed it does not seem harmful.

@roidelapluie
Copy link
Member

We have discussed this in the bug scrub and decided that in both case this is confusing, we should improve that part of the documentation to make it more meta-syntactic.

Something like alertstate="<pending or firing>".

Are you willing to update this pull request in that direction? Thanks!

@stale stale bot removed the stale label Sep 7, 2020
Update `ALERTS` example be more meta-syntactic.

Signed-off-by: Justin Walz <justin.walz10@gmail.com>
@justinwalz
Copy link
Contributor Author

Sure thing, that works for me. Updated.

@brian-brazil brian-brazil merged commit 808a145 into prometheus:master Sep 7, 2020
@brian-brazil
Copy link
Contributor

Thanks!

damnever pushed a commit to damnever/prometheus that referenced this pull request Sep 9, 2020
Update `ALERTS` example be more meta-syntactic.

Signed-off-by: Justin Walz <justin.walz10@gmail.com>
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.

None yet

3 participants