Skip to content

Commit 5cc2aa5

Browse files
authored
Clarify that autometrics isn't tied to axum or vergen (#84)
1 parent 878f90e commit 5cc2aa5

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

autometrics/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ The Rust library provides a macro that makes it easy to instrument any function
1010

1111
To make it easy for you to spot and debug issues in production, Autometrics inserts links to live charts directly into each function’s doc comments and provides dashboards that work out of the box. It also enables you to create powerful alerts based on Service-Level Objectives (SLOs) directly in your source code. Lastly, Autometrics writes queries that correlate your software’s version info with anomalies in the metrics to help you quickly identify commits that introduced bugs or latency.
1212

13-
## Example
13+
## Example Axum App
14+
15+
Autometrics isn't tied to any web framework, but this shows how you can use the library in an [Axum](https://github.com/tokio-rs/axum) server.
1416

1517
```rust
1618
use autometrics::autometrics;
@@ -68,7 +70,7 @@ It produces a `build_info` metric and uses the following labels to expose the ve
6870
| `commit` | `AUTOMETRICS_COMMIT` or `VERGEN_GIT_COMMIT` | `""` |
6971
| `branch` | `AUTOMETRICS_BRANCH` or `VERGEN_GIT_BRANCH` | `""` |
7072

71-
### Using [`vergen`](https://crates.io/crates/vergen) to set the Git details
73+
### (Optional) Using [`vergen`](https://crates.io/crates/vergen) to set the Git details
7274

7375
```toml
7476
# Cargo.toml

0 commit comments

Comments
 (0)