https://github.com/autometrics-dev/quickmetrics
a docker compose setup with prometheus, alertmanager, grafana, an aggregation gateway
https://github.com/autometrics-dev/quickmetrics
Last synced: 3 months ago
JSON representation
a docker compose setup with prometheus, alertmanager, grafana, an aggregation gateway
- Host: GitHub
- URL: https://github.com/autometrics-dev/quickmetrics
- Owner: autometrics-dev
- Created: 2023-04-11T14:37:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T14:07:55.000Z (over 1 year ago)
- Last Synced: 2025-03-27T06:02:00.384Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 121 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quickmetrics
> NOTE: This is for demonstration purposes only. Not intended for use in production infrastructure.
Quickly set up metrics with Prometheus and an Aggregation Gateway, so you can push metrics to Prometheus locally with [Autometrics](https://autometrics.dev/).
Test out Autometrics Grafana dashboards as well.
> TODO!!! Instructions
## Setup
To run, you need Docker installed locally, and a local copy of this repository.
```sh
# Start things up
docker compose up
# NOTE - If you ever make changes, e.g., to the api, you'll want to rebuild the docker images
docker compose up --build
```
- Prometheus runs locally on `localhost:9090`, and loads autometrics alerting rules from `prometheus/autometrics.rules.yml`
- Prometheus will try to scrape `localhost:8080/metrics` by default. You can change this under `scrape_configs` in `prometheus/prometheus.yml`
- The aggregation gateway runs on `localhost:8081`
- Grafana runs on `localhost:9011` and does not require a username/password to log in
- An API runs on `localhost:8082` and will proxy requests to `/metrics` to the aggregation gateway, setting proper CORS headers so you can push metrics from the browser
Prometheus will scrape the aggregation gateway every 5 seconds, but you can change this in the `prometheus/prometheus.yml` config file.
Go to http://localhost:9090/targets to check the health of the aggregation gateway.
## Configuration
You can configure the ports on which services are exposed by modifying the `.env` file:
- `FP_PROMETHEUS_PORT` - The port that Prometheus runs on, on your machine
- `FP_PUSH_GATEWAY_PORT` - The port that the aggregation gateway runs on, on your machine
- `FP_GRAFANA_PORT` - The port that Grafana runs on, on your machine
- `FP_ALERTMANAGER_PORT` - The port that Alertmanager runs on, on your machine
- `FP_API_PORT` - The port that the api proxy to the aggregation gateway port runs on, on your machine
To configure the Prometheus scrape interval, modify the `prometheus/prometheus.yml` file
To load the Grafana Autometrics dashboards, go to Grafana, and import the JSON files located in this repo under `./grafana/dashboards`. These are copy-pasted from the autometrics-shared repo, see [here](https://github.com/autometrics-dev/autometrics-shared#dashboards).
(In a future version, we will try to autoload these dashboards.)
## Test it out
Once you've spun up the containers, you can push metrics to the api that's sitting in front of the aggregation gateway:
```sh
echo '
http_requests_total{result="ok", function="curl", module=""} 1027
http_errors_total{result="error", function="curl", module=""} 6
' | curl --data-binary @- http://localhost:8081/metrics/
```
Then, look for the metrics in Prometheus: http://localhost:9090/graph. Search for `http_requests_total{function="curl"}` or `http_errors_total{function="curl"}`.
## Thanks
This makes use of Zapier's [prom-aggregation-gateway](https://github.com/zapier/prom-aggregation-gateway) to support client-side (browser) metrics.