Prometheus metrics
Air Pipe exposes a Prometheus /metrics endpoint and lets actions emit custom
metrics. For distributed tracing see OpenTelemetry tracing.
Enable it
Set expose_metrics: true at the config root. /metrics is served in self-hosted
modes and is unauthenticated (Prometheus convention — isolate it by network).
name: my-api
expose_metrics: true
interfaces:
# ...
As of engine 1.7.2, /metrics is served on a dedicated bind, default
127.0.0.1:9090 — not the public API port — so it isn't exposed alongside your
API. Configure with --metrics-address (env AIRPIPE__METRICS_BIND):
| Value | Effect |
|---|---|
127.0.0.1:9090 (default) | loopback — scrape locally or via a sidecar |
0.0.0.0:9090 | all interfaces — firewall the port |
off | disable the endpoint (and the per-request instrumentation) |
(Before 1.7.2, /metrics was served on the API port.)
Scrape config:
scrape_configs:
- job_name: airpipe
static_configs:
# engine >= 1.7.2: the dedicated metrics bind (default 127.0.0.1:9090).
# If Prometheus runs elsewhere, start AirPipe with --metrics-address 0.0.0.0:9090.
- targets: ["127.0.0.1:9090"]
Built-in metrics
| Metric | Type | Labels |
|---|---|---|
airpipe_interface_requests_total | counter | config, interface |
airpipe_interface_duration_ms | histogram | config, interface |
airpipe_http_action_duration_ms | histogram | config, interface, action |
axum_http_requests_total | counter | route/method/status |
axum_http_requests_duration_seconds | histogram | route/method/status |
axum_http_requests_pending | gauge | — |
Custom metrics
Emit your own metrics from an action with emit_metric. Full fields:
EmitMetric reference.
actions:
- name: RecordSignup
emit_metric:
name: signups_total # must be a valid Prometheus metric name
type: counter # counter (default) | gauge | histogram
value: 1
labels:
plan: a|body::plan|
- counter — increments by
1whenvalueis omitted. - gauge / histogram — require a
value. - Air Pipe auto-attaches
config,interfaceandactionlabels to every custom metric, in addition to anylabelsyou set.