Files
OpenROAD/etc/monitoring/compose.yaml
Ethan Mahintorabi d39b0061f4 utl: Adds live prometheus monitoring to OpenROAD
OpenROAD includes a metrics endpoint server that can track internal tool metrics over time.

To use this feature you need to do the following start the prometheus and grafana collectors

[Detailed instructions](/etc/monitoring/README.md):
```shell
$ cd etc/monitoring
$ docker compose up -d
```

This will start a grafana endpoint ready to collect from the OpenROAD application you would
like to track. By default it's looking for an http server running on port 8080 on your localhost.

To start the metrics endpoint in OpenROAD, run:
```tcl
utl::startPrometheusEndpoint 8080
```

This is all configurable in the docker compose file, and you should be able to access grafana by going to
http://localhost:3000 username: admin, password: grafana. Go to the dashboard tab and click service,
then OpenROAD to see the pre-made dashboard.

Signed-off-by: Ethan Mahintorabi <ethanmoon@google.com>
2025-02-20 00:01:05 +00:00

31 lines
805 B
YAML

services:
prometheus:
image: prom/prometheus
container_name: prometheus
command:
- '--config.file=/etc/prometheus/prometheus.yml'
ports:
- 9090:9090
restart: unless-stopped
volumes:
- ./prometheus:/etc/prometheus
- prom_data:/prometheus
extra_hosts:
- "host.docker.internal:host-gateway"
grafana:
image: grafana/grafana
container_name: grafana
ports:
- 3000:3000
restart: unless-stopped
environment:
- GF_SECURITY_ADMIN_USER=admin
- GF_SECURITY_ADMIN_PASSWORD=grafana
volumes:
- ./grafana/datasource:/etc/grafana/provisioning/datasources
- ./grafana/dashboards:/etc/grafana/provisioning/dashboards
- ./grafana/dashboard_definitions:/var/lib/grafana/dashboards
volumes:
prom_data: