/starlette-prometheus

Prometheus integration for Starlette.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Starlette Prometheus

Build Status codecov PyPI version

  • Version: 0.1.1
  • Status: Production/Stable
  • Author: José Antonio Perdiguero López

Introduction

Prometheus integration for Starlette.

Requirements

  • Python 3.6+
  • Starlette 0.9+

Installation

$ pip install starlette-prometheus

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)

Contributing

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