Skip to content

Move alerting rules to autometrics-shared #62

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Apr 12, 2023
Merged

Move alerting rules to autometrics-shared #62

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
884f427
Move alerting rules file to autometrics-common
emschwartz Apr 12, 2023
066442b
Add CLI readme
emschwartz Apr 12, 2023
cb98f59
Add small code snippet to readme
emschwartz Apr 12, 2023
ba97b66
Fix typo
emschwartz Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Fix typo
  • Loading branch information
@emschwartz
emschwartz committed Apr 12, 2023
commit ba97b6623e3012718acabeb538bbc0a3fdab819b
2 changes: 1 addition & 1 deletion autometrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ If you are already using one of these to collect and export metrics, simply conf

Autometrics makes it easy to add Prometheus alerts using Service-Level Objectives (SLOs) to a function or group of functions.

This works using pre-defined [Prometheus alerting rules](https://github.com/autometrics-dev/autometrics-shared#prometheus-recording--alerting-rules). By default, most of the recording rules are dormaint. They are enabled by specific metric labels that can be automatically attached by autometrics.
This works using pre-defined [Prometheus alerting rules](https://github.com/autometrics-dev/autometrics-shared#prometheus-recording--alerting-rules). By default, most of the recording rules are dormant. They are enabled by specific metric labels that can be automatically attached by autometrics.

To use autometrics SLOs and alerts, create one or multiple [`Objective`s](https://docs.rs/autometrics/latest/autometrics/objectives/struct.Objective.html) based on the function(s) success rate and/or latency, as shown below. The `Objective` can be passed as an argument to the `autometrics` macro to include the given function in that objective.

Expand Down