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

[DPE-5658] Update COS alert rules #727

Merged
merged 15 commits into from
Oct 29, 2024
Merged

[DPE-5658] Update COS alert rules #727

merged 15 commits into from
Oct 29, 2024

Conversation

a-velasco
Copy link
Contributor

@a-velasco a-velasco commented Oct 7, 2024

Issue

Alert rule descriptions do not provide much guidance about what actions the user can take.

Solution

Improve the descriptions of the COS alert rule expressions.

The format should be:

  1. What happened, or what is the problem
  2. What can the user do to recover, or investigate further (this is the part that's usually missing)

Here is a good example:

summary: PostgresSQL SSL compression active (instance {{ $labels.instance }})
description: |
Database connections have SSL compression enabled. This may add significant jitter in replication delay.
Replicas can turn off SSL compression via `sslcompression=0` in `recovery.conf`.

Minor edits and polished yaml formatting
Copy link

codecov bot commented Oct 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.74%. Comparing base (b5711ae) to head (8fdfac6).
Report is 23 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #727      +/-   ##
==========================================
+ Coverage   70.65%   71.74%   +1.08%     
==========================================
  Files          11       12       +1     
  Lines        2999     3047      +48     
  Branches      523      465      -58     
==========================================
+ Hits         2119     2186      +67     
+ Misses        767      754      -13     
+ Partials      113      107       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Minor edits and polished yaml formatting
Minor edits and polished yaml formatting
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
@a-velasco a-velasco changed the title Update COS alert rules [WIP] Update COS alert rules Oct 10, 2024
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/patroni_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/patroni_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/postgresql_rules.yaml Outdated Show resolved Hide resolved
src/prometheus_alert_rules/pgbouncer_rules.yaml Outdated Show resolved Hide resolved
Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com>
Using backticks for the alert manager to render newlines correctly.
Using backticks for the alert manager to render newlines correctly.
@a-velasco a-velasco changed the title [WIP] Update COS alert rules Update COS alert rules Oct 11, 2024
@a-velasco a-velasco marked this pull request as ready for review October 11, 2024 11:50
@a-velasco a-velasco changed the title Update COS alert rules [DPE-5658] Update COS alert rules Oct 11, 2024
Copy link
Member

@marceloneppel marceloneppel left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks Andreia!

@a-velasco a-velasco requested a review from 7annaba3l October 14, 2024 07:33
Copy link
Member

@lucasgameiroborges lucasgameiroborges left a comment

Choose a reason for hiding this comment

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

Nice! Thanks!

Copy link
Contributor

@taurus-forever taurus-forever left a comment

Choose a reason for hiding this comment

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

Same question "VALUE" has been randomly removed. Can you please explain it. Tnx!

@a-velasco
Copy link
Contributor Author

@taurus-forever Merging to keep updated with other SQL repos. Future work is planned to investigate these variables and continue improving the rules.

@a-velasco a-velasco merged commit de7d805 into main Oct 29, 2024
98 of 99 checks passed
@a-velasco a-velasco deleted the alert-rules-updates branch October 29, 2024 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants