feat: add metrics to proxy

CHANGELOG.md

@@ -4,7 +4,6 @@
 
 ### Changes
 
-- Added tracing to the `miden-tx-prover` CLI (#1014).
 - Added health check endpoints to the prover service (#1006).
 - Implemented serialization for `AccountHeader` (#996).
 - Updated Pingora crates to 0.4 and added polling time to the configuration file (#997).
@@ -19,6 +18,8 @@
 - [BREAKING] Added `miden::note::get_script_hash` procedure (#995).
 - [BREAKING] Refactor error messages in `miden-lib` and `miden-tx` and use `thiserror` 2.0 (#1005).
 - Removed workers list from the proxy configuration file (#1018).
+- Added tracing to the `miden-tx-prover` CLI (#1014).
+- Added metrics to the `miden-tx-prover` proxy (#1017).
 
 ## 0.6.2 (2024-11-20)
 

bin/tx-prover/Cargo.toml

@@ -54,6 +54,8 @@ figment = { version = "0.10", features = ["toml", "env"] }
 miden-lib = { workspace = true, default-features = false }
 miden-objects = { workspace = true, default-features = false }
 miden-tx = { workspace = true, default-features = false }
+lazy_static = "1.5"
+prometheus = "0.13"
 prost = { version = "0.13", default-features = false, features = ["derive"] }
 reqwest = { version = "0.11" }
 serde = { version = "1.0", features = ["derive"] }

bin/tx-prover/README.md

@@ -120,6 +120,26 @@ Then access the Jaeger UI at `http://localhost:16686/`.
 
 If Docker is not an option, Jaeger can also be set up directly on your machine or hosted in the cloud. See the [Jaeger documentation](https://www.jaegertracing.io/docs/) for alternative installation methods.
 
+## Metrics
+
+The proxy includes a service that provides metrics for [Prometheus](https://prometheus.io/docs/introduction/overview/). This service is always enabled and uses the host and port defined in the configuration file. The metrics are available at the `/metrics` endpoint.
+
+To consume and display the metrics, you can use Prometheus and Grafana. The simplest way to install Prometheus and Grafana is by using Docker containers. To do so, run:
+
+```bash
+docker run \
+    -d \
+    -p 9090:9090 \
+    -v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml \
+    prom/prometheus
+
+docker run -d -p 3000:3000 --name grafana grafana/grafana-enterprise:latest
+```
+
+A prometheus configuration file is provided in this repository, you will need to modify the `scrape_configs` section to include the host and port of the proxy service.
+
+Then, to add the new Prometheus collector as a datasource for Grafana, you can [follow this tutorial](https://grafana.com/docs/grafana-cloud/connect-externally-hosted/existing-datasource/). A Grafana dashboard under the name `proxy_grafana_dashboard.json` is provided, see this [link](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/) to import it.
+
 ## Features
 
 Description of this crate's feature:

bin/tx-prover/prometheus.yml

@@ -0,0 +1,11 @@
+global:
+  scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
+  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
+  # scrape_timeout is set to the global default (10s).
+
+# A scrape configuration containing exactly one endpoint to scrape:
+scrape_configs:
+  - job_name: "proxy"
+    # Here you need to specify the address of the Prometheus service endpoint in the proxy
+    static_configs:
+      - targets: ["127.0.0.1:6192"]