Import python3-prometheus-client 0.8.0 source.

Author: gizmoguy

.travis.yml

@@ -1,3 +1,4 @@
+dist: xenial
 sudo: false
 cache:
   directories:
@@ -9,6 +10,7 @@ matrix:
   include:
     - python: "2.6"
       env: TOXENV=py26
+      dist: trusty
     - python: "2.7"
       env: TOXENV=py27
     - python: "2.7"
@@ -21,11 +23,12 @@ matrix:
       env: TOXENV=py36
     - python: "3.7"
       env: TOXENV=py37
-      dist: xenial
       sudo: true
-    - python: "3.7"
-      env: TOXENV=py37-nooptionals
-      dist: xenial
+    - python: "3.8"
+      env: TOXENV=py38
+      sudo: true
+    - python: "3.8"
+      env: TOXENV=py38-nooptionals
       sudo: true
     - python: "pypy"
       env: TOXENV=pypy

MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include tests *
+prune tests/__pycache__

README.md

@@ -306,6 +306,19 @@ from prometheus_client import start_wsgi_server
 start_wsgi_server(8000)
 ```
 
+#### ASGI
+
+To use Prometheus with [ASGI](http://asgi.readthedocs.org/en/latest/), there is
+`make_asgi_app` which creates an ASGI application.
+
+```python
+from prometheus_client import make_asgi_app
+
+app = make_asgi_app()
+```
+Such an application can be useful when integrating Prometheus metrics with ASGI
+apps.
+
 #### Flask
 
 To use Prometheus with [Flask](http://flask.pocoo.org/) we need to serve metrics through a Prometheus WSGI application. This can be achieved using [Flask's application dispatching](http://flask.pocoo.org/docs/latest/patterns/appdispatch/). Below is a working example.
@@ -314,7 +327,7 @@ Save the snippet below in a `myapp.py` file
 
 ```python
 from flask import Flask
-from werkzeug.wsgi import DispatcherMiddleware
+from werkzeug.middleware.dispatcher import DispatcherMiddleware
 from prometheus_client import make_wsgi_app
 
 # Create my app
@@ -452,7 +465,7 @@ used to predetermine the names of time series a `CollectorRegistry` exposes and
 thus to detect collisions and duplicate registrations.
 
 Usually custom collectors do not have to implement `describe`. If `describe` is
-not implemented and the CollectorRegistry was created with `auto_desribe=True`
+not implemented and the CollectorRegistry was created with `auto_describe=True`
 (which is the case for the default registry) then `collect` will be called at
 registration time instead of `describe`. If this could cause problems, either
 implement a proper `describe`, or if that's not practical have `describe`
@@ -476,31 +489,25 @@ This comes with a number of limitations:
 
 There's several steps to getting this working:
 
-**One**: Gunicorn deployment
+**1. Gunicorn deployment**:
 
 The `prometheus_multiproc_dir` environment variable must be set to a directory
 that the client library can use for metrics. This directory must be wiped
 between Gunicorn runs (before startup is recommended).
 
-Put the following in the config file:
-```python
-from prometheus_client import multiprocess
+This environment variable should be set from a start-up shell script,
+and not directly from Python (otherwise it may not propagate to child processes).
 
-def child_exit(server, worker):
-    multiprocess.mark_process_dead(worker.pid)
-```
+**2. Metrics collector**:
+
+The application must initialize a new `CollectorRegistry`,
+and store the multi-process collector inside.
 
-**Two**: Inside the application
 ```python
 from prometheus_client import multiprocess
-from prometheus_client import generate_latest, CollectorRegistry, CONTENT_TYPE_LATEST, Gauge
-
-# Example gauge.
-IN_PROGRESS = Gauge("inprogress_requests", "help", multiprocess_mode='livesum')
-
+from prometheus_client import generate_latest, CollectorRegistry, CONTENT_TYPE_LATEST
 
 # Expose metrics.
-@IN_PROGRESS.track_inprogress()
 def app(environ, start_response):
     registry = CollectorRegistry()
     multiprocess.MultiProcessCollector(registry)
@@ -514,19 +521,36 @@ def app(environ, start_response):
     return iter([data])
 ```
 
-**Three**: Instrumentation
+**3. Gunicorn configuration**:
 
-Counters, Summarys and Histograms work as normal.
+The `gunicorn` configuration file needs to include the following function:
 
-Gauges have several modes they can run in, which can be selected with the
-`multiprocess_mode` parameter.
+```python
+from prometheus_client import multiprocess
+
+def child_exit(server, worker):
+    multiprocess.mark_process_dead(worker.pid)
+```
+
+**4. Metrics tuning (Gauge)**:
+
+When `Gauge` metrics are used, additional tuning needs to be performed.
+Gauges have several modes they can run in, which can be selected with the `multiprocess_mode` parameter.
 
 - 'all': Default. Return a timeseries per process alive or dead.
 - 'liveall': Return a timeseries per process that is still alive.
 - 'livesum': Return a single timeseries that is the sum of the values of alive processes.
 - 'max': Return a single timeseries that is the maximum of the values of all processes, alive or dead.
 - 'min': Return a single timeseries that is the minimum of the values of all processes, alive or dead.
 
+```python
+from prometheus_client import Gauge
+
+# Example gauge
+IN_PROGRESS = Gauge("inprogress_requests", "help", multiprocess_mode='livesum')
+```
+
+
 ## Parser
 
 The Python client supports parsing the Prometheus text format.

prometheus_client/__init__.py

@@ -24,6 +24,11 @@
 generate_latest = exposition.generate_latest
 MetricsHandler = exposition.MetricsHandler
 make_wsgi_app = exposition.make_wsgi_app
+try:
+    # Python >3.5 only
+    make_asgi_app = exposition.make_asgi_app
+except:
+    pass
 start_http_server = exposition.start_http_server
 start_wsgi_server = exposition.start_wsgi_server
 write_to_textfile = exposition.write_to_textfile

prometheus_client/asgi.py

@@ -0,0 +1,34 @@
+from urllib.parse import parse_qs
+
+from .exposition import _bake_output
+from .registry import REGISTRY
+
+
+def make_asgi_app(registry=REGISTRY):
+    """Create a ASGI app which serves the metrics from a registry."""
+
+    async def prometheus_app(scope, receive, send):
+        assert scope.get("type") == "http"
+        # Prepare parameters
+        params = parse_qs(scope.get('query_string', b''))
+        accept_header = "Accept: " + ",".join([
+            value.decode("utf8") for (name, value) in scope.get('headers')
+            if name.decode("utf8") == 'accept'
+        ])
+        # Bake output
+        status, header, output = _bake_output(registry, accept_header, params)
+        # Return output
+        payload = await receive()
+        if payload.get("type") == "http.request":
+            await send(
+                {
+                    "type": "http.response.start",
+                    "status": int(status.split(' ')[0]),
+                    "headers": [
+                        tuple(x.encode('utf8') for x in header)
+                    ]
+                }
+            )
+            await send({"type": "http.response.body", "body": output})
+
+    return prometheus_app