Skip to content

Latest commit

 

History

History
57 lines (32 loc) · 2.79 KB

README.md

File metadata and controls

57 lines (32 loc) · 2.79 KB
Raw

GitHub_headerImage

Discord Shield

This repo contains resources shared between all of the Autometrics implementations.

Autometrics Specification

Dashboards

You can find the Grafana dashboard JSON files in the dashboards directory.

These will work out of the box once you have imported them into Grafana and selected the Prometheus data source for them to use.

Prometheus Recording & Alerting Rules

The autometrics.rules.yml file contains the default recording and alerting rules for Prometheus.

This should work for most autometrics-instrumented projects without modification.

Specifically, these rules will work for any project that uses the following objective percentiles: 90%, 95%, 99%, 99.9%. Projects that want to use other percentiles can generate a new rules file, specifying the objectives for the autometrics-cli's generate-sloth-file command (see here).

Adding the rules to Prometheus

Prometheus can be configured to use the autometrics.rules.yml file using the rule_files field in the Prometheus config:

# prometheus.yml

rule_files:
  - /path/to/autometrics.rules.yml

How it works

This file sets up a number of recording and alerting rules that are dormant by default and are only enabled when the autometrics libraries product metrics with special labels: function_calls_total{objective_name="", objective_percentile=""} or function_calls_duration_seconds_bucket{objective_name="", objective_latency_threshold="", objective_percentile=""}.

To read more details about the label tricks we use to make these rules work across autometrics-instrumented projects, see An adventure with SLOs, generic Prometheus alerting rules, and complex PromQL queries.

Re-generating the alerting rules file

The file is generated using the autometrics-cli and the Sloth tool.

To regenerate the file, you'll need:

  • Rust
  • Docker

Then run:

git clone https://github.com/autometrics-dev/autometrics-rs.git`
cargo run -p autometrics-cli generate-sloth-file > sloth.yml
docker run -v $(pwd):/data  ghcr.io/slok/sloth generate -i /data/sloth.yml -o /data/autometrics.rules.yml