Merge pull request #47 from Cdayz/feature/#8

Add use_prometheus_metrics function, to automaticaly enable metrics

Author: Nikita Tomchik

README.md

@@ -22,16 +22,14 @@ $ pip install blacksheep-prometheus
 
 ## Usage
 
-A complete example that exposes prometheus metrics endpoint under `/metrics/` path.
+A complete example that exposes prometheus metrics endpoint under default `/metrics/` endpoint.
 
 ```python
 from blacksheep.server import Application
-from blacksheep_prometheus import PrometheusMiddleware, metrics
+from blacksheep_prometheus import use_prometheus_metrics
 
 app = Application()
-
-app.middlewares.append(PrometheusMiddleware())
-app.router.add_get('/metrics/', metrics)
+use_prometheus_metrics(app)
 ```
 
 ### Options

blacksheep_prometheus/__init__.py

@@ -1,7 +1,27 @@
+from typing import Optional
+
+from blacksheep.server import Application
+
 from .middleware import PrometheusMiddleware
 from .view import metrics
 
+
+def use_prometheus_metrics(
+    app: Application,
+    *,
+    endpoint: str = "/metrics/",
+    middleware: Optional[PrometheusMiddleware] = None,
+) -> None:
+    """
+    Configures the given application to use Prometheus and provide services that can be
+    injected in request handlers.
+    """
+    middleware = middleware or PrometheusMiddleware()
+    app.middlewares.append(middleware)
+    app.router.add_get(endpoint, metrics)
+
+
 __all__ = [
-    'metrics',
+    'use_prometheus_metrics',
     'PrometheusMiddleware',
 ]