starlette-prometheus-middleware 0.9.0

Prometheus integration for Starlette

Starlette Prometheus

:warning: This repository is a fork of the original starlette_prometheus middleware, using upgraded dependencies.

Introduction

Prometheus integration for Starlette.

Requirements

• Python 3.6+
• Starlette 0.9+

Installation

$ pip install starlette-prometheus-middleware

Usage

A complete example that exposes prometheus metrics endpoint under /metrics/ path.

from starlette.applications import Starlette
from starlette_prometheus import metrics, PrometheusMiddleware

app = Starlette()

app.add_middleware(PrometheusMiddleware)
app.add_route("/metrics/", metrics)

Metrics for paths that do not match any Starlette route can be filtered by passing filter_unhandled_paths=True argument to add_middleware method.

Contributing

This project is absolutely open to contributions so if you have a nice idea, create an issue to let the community discuss it.