From bb343c4de514b11189bcf7084810a7af7e92f6f5 Mon Sep 17 00:00:00 2001 From: Laurynas Keturakis Date: Thu, 6 Jul 2023 13:44:00 +0200 Subject: [PATCH 1/3] add references to Autometrics CLI in the README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d00cc0b5..b1c81b90 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,7 @@ https://github.com/autometrics-dev/autometrics-rs/assets/3262610/966ed140-1d6c-4 - 4. [Configure Prometheus](https://github.com/autometrics-dev#5-configuring-prometheus) to scrape your metrics endpoint + 4. Run Prometheus locally with [Autometrics CLI]() or [configure it manually](https://github.com/autometrics-dev#5-configuring-prometheus) to scrape your metrics endpoint 5. (Optional) If you have Grafana, import the [Autometrics dashboards](https://github.com/autometrics-dev/autometrics-shared#dashboards) for an overview and detailed view of the function metrics ## [API Docs](https://docs.rs/autometrics) @@ -190,7 +190,7 @@ https://github.com/autometrics-dev/autometrics-rs/assets/3262610/966ed140-1d6c-4 To see autometrics in action: -1. Install [prometheus](https://prometheus.io/download/) locally +1. Install [prometheus](https://prometheus.io/download/) locally or download [Autometrics CLI](https://docs.autometrics.dev/local-development#getting-started-with-am) which will install and configure Prometheus for you locally. 2. Run the [complete example](./examples/full-api): ```shell From e4ffcfa9aae4f479077c9af589e8fea64e33150a Mon Sep 17 00:00:00 2001 From: Laurynas Keturakis Date: Thu, 6 Jul 2023 13:52:19 +0200 Subject: [PATCH 2/3] Update README.md Co-authored-by: Benno van den Berg --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1c81b90..5ab76a66 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,7 @@ https://github.com/autometrics-dev/autometrics-rs/assets/3262610/966ed140-1d6c-4 - 4. Run Prometheus locally with [Autometrics CLI]() or [configure it manually](https://github.com/autometrics-dev#5-configuring-prometheus) to scrape your metrics endpoint + 4. Run Prometheus locally with [Autometrics CLI](https://docs.autometrics.dev/local-development#getting-started-with-am) or [configure it manually](https://github.com/autometrics-dev#5-configuring-prometheus) to scrape your metrics endpoint 5. (Optional) If you have Grafana, import the [Autometrics dashboards](https://github.com/autometrics-dev/autometrics-shared#dashboards) for an overview and detailed view of the function metrics ## [API Docs](https://docs.rs/autometrics) From 7ee29977b7bcd764c661c297a8b079c6a5d8d27a Mon Sep 17 00:00:00 2001 From: Laurynas Keturakis Date: Mon, 10 Jul 2023 10:46:11 +0200 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Evan Schwartz --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5ab76a66..f0828b90 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,7 @@ https://github.com/autometrics-dev/autometrics-rs/assets/3262610/966ed140-1d6c-4 - 4. Run Prometheus locally with [Autometrics CLI](https://docs.autometrics.dev/local-development#getting-started-with-am) or [configure it manually](https://github.com/autometrics-dev#5-configuring-prometheus) to scrape your metrics endpoint + 4. Run Prometheus locally with the [Autometrics CLI](https://docs.autometrics.dev/local-development#getting-started-with-am) or [configure it manually](https://github.com/autometrics-dev#5-configuring-prometheus) to scrape your metrics endpoint 5. (Optional) If you have Grafana, import the [Autometrics dashboards](https://github.com/autometrics-dev/autometrics-shared#dashboards) for an overview and detailed view of the function metrics ## [API Docs](https://docs.rs/autometrics) @@ -190,7 +190,7 @@ https://github.com/autometrics-dev/autometrics-rs/assets/3262610/966ed140-1d6c-4 To see autometrics in action: -1. Install [prometheus](https://prometheus.io/download/) locally or download [Autometrics CLI](https://docs.autometrics.dev/local-development#getting-started-with-am) which will install and configure Prometheus for you locally. +1. Install [prometheus](https://prometheus.io/download/) locally or download the [Autometrics CLI](https://docs.autometrics.dev/local-development#getting-started-with-am) which will install and configure Prometheus for you locally. 2. Run the [complete example](./examples/full-api): ```shell