From ba81ac714ad30088115ef57245b619cc264509a5 Mon Sep 17 00:00:00 2001 From: Evan Schwartz <3262610+emschwartz@users.noreply.github.com> Date: Tue, 9 May 2023 15:35:40 +0200 Subject: [PATCH] Fix links in readme on crates.io --- README.md | 2 +- autometrics/README.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a4b69ef4..1a1bde09 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Here is a demo of jumping from function docs to live Prometheus charts: - [⚙️ Configurable](https://docs.rs/autometrics/latest/autometrics/#metrics-libraries) metric collection library ([`opentelemetry`](https://crates.io/crates/opentelemetry), [`prometheus`](https://crates.io/crates/prometheus), or [`metrics`](https://crates.io/crates/metrics)) - ⚡ Minimal runtime overhead -See [Why Autometrics?](https://github.com/autometrics-dev#why-autometrics) for more details on the ideas behind autometrics. +See [Why Autometrics?](https://github.com/autometrics-dev#4-why-autometrics) for more details on the ideas behind autometrics. ## Quickstart diff --git a/autometrics/README.md b/autometrics/README.md index 5d9a6145..1dc4ee93 100644 --- a/autometrics/README.md +++ b/autometrics/README.md @@ -47,16 +47,16 @@ pub async fn main() { ## Features -- ✨ [`#[autometrics]`](autometrics) macro instruments any function or `impl` block to track the most useful metrics +- ✨ [`#[autometrics]`](https://docs.rs/autometrics/latest/autometrics/attr.autometrics.html) macro instruments any function or `impl` block to track the most useful metrics - 💡 Writes Prometheus queries so you can understand the data generated without knowing PromQL - 🔗 Injects links to live Prometheus charts directly into each function's doc comments - [🔍 Identify commits](#identifying-commits-that-introduced-problems) that introduced errors or increased latency -- [🚨 Define alerts](objectives) using SLO best practices directly in your source code +- [🚨 Define alerts](https://docs.rs/autometrics/latest/autometrics/objectives/index.html) using SLO best practices directly in your source code - [📊 Grafana dashboards](https://github.com/autometrics-dev#5-configuring-prometheus) work out of the box to visualize the performance of instrumented functions & SLOs - [⚙️ Configurable](#metrics-libraries) metric collection library ([`opentelemetry`](https://crates.io/crates/opentelemetry), [`prometheus`](https://crates.io/crates/prometheus), or [`metrics`](https://crates.io/crates/metrics)) - ⚡ Minimal runtime overhead -See [Why Autometrics?](https://github.com/autometrics-dev#why-autometrics) for more details on the ideas behind autometrics. +See [Why Autometrics?](https://github.com/autometrics-dev#4-why-autometrics) for more details on the ideas behind autometrics. ## Identifying commits that introduced problems