GitHub

prometheus

API reference for prometheus.

The metrics registry over HTTP (Effect's PrometheusMetrics.layerHttp). Add layer_http() to an app's routes for a Prometheus scrape endpoint.

Functions

layer_http

layer_http(*, path='/metrics', prefix=None, metric_name_mapper=None) -> Layer[Never, Never, HttpRouter]

A GET route at path answering with prometheus_format.

ParameterTypeDescription
pathstr = '/metrics'
prefixstr | None = None
metric_name_mapperMetricNameMapper | None = None

Returns Layer[Never, Never, HttpRouter]

def layer_http(
    *,
    path: str = "/metrics",
    prefix: str | None = None,
    metric_name_mapper: MetricNameMapper | None = None,
) -> Layer[Never, Never, HttpRouter]:
    """A ``GET`` route at ``path`` answering with ``prometheus_format``."""
    text = prometheus_format(prefix=prefix, metric_name_mapper=metric_name_mapper)
    return router.add(
        "GET",
        path,
        text.map(
            lambda body: response.text(
                body, content_type="text/plain; version=0.0.4; charset=utf-8"
            )
        ),
    )