Skip to content

Add references to the Autometrics CLI in the README #124

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 3 commits into from
Jul 10, 2023
Merged

Add references to the Autometrics CLI in the README #124

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb343c4
add references to Autometrics CLI in the README
laulauland Jul 6, 2023
e4ffcfa
Update README.md
laulauland Jul 6, 2023
7ee2997
Apply suggestions from code review
laulauland Jul 10, 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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ https://github.com/autometrics-dev/autometrics-rs/assets/3262610/966ed140-1d6c-4

</details>

4. [Configure Prometheus](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)
Expand All @@ -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
Expand Down