Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Metrics & access-log fields

boatramp exports Prometheus metrics and a structured access log from the same serving path. This page lists the exported metrics and the access-log fields. For how to scrape and read them, see Observe a running server.

The Prometheus exporter at /api/metrics is admin-scoped. The handler and consumer metrics are present only when the binary is built with the handlers feature.

Prometheus metrics

Exported at /api/metrics.

MetricTypeLabelsMeaning
boatramp_http_requests_totalcounterstatus_class, cache_resultRequests by status class (2xx / 3xx / …) and cache result.
boatramp_http_response_bytes_totalcounterTotal response body bytes streamed.
boatramp_deployments_totalcounterDeployment manifests created.
boatramp_activations_totalcounterActivations (live / alias pointer flips).
boatramp_cert_renewals_totalcounterACME certificate issues and renewals.

With the handlers feature the exporter also renders per-(site, trigger, route) handler-invocation counters and per-consumer queue-depth and dead-letter gauges.

Access-log fields

Every request is logged on the boatramp::access tracing target. Set BOATRAMP_LOG_FORMAT=json for a machine-readable sink; verbosity follows RUST_LOG (default boatramp=info).

FieldMeaning
methodHTTP request method.
pathRequest path.
hostRequest host.
client_ipClient IP address.
statusResponse status code.
bytesResponse body bytes.
encodingContent encoding applied to the response.
cache_resultCache outcome for the request (see below).
duration_msTime taken to serve the request, in milliseconds.

cache_result values

ValueMeaning
fullServed fully from cache.
partialPartial-content (Range) response.
not-modifiedConditional request answered 304.
redirectAnswered with a redirect.
errorAnswered with an error.