From cbe5ea1115e3e77e86d69a4dc2b29e508724e18e Mon Sep 17 00:00:00 2001
From: Florian Sesser <florian@private.storage>
Date: Wed, 15 Sep 2021 11:28:39 +0000
Subject: [PATCH] OpenMetrics: Add docstring

---
 src/allmydata/web/status.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/allmydata/web/status.py b/src/allmydata/web/status.py
index 7b16a60b2..65647f491 100644
--- a/src/allmydata/web/status.py
+++ b/src/allmydata/web/status.py
@@ -1554,6 +1554,12 @@ class Statistics(MultiFormatResource):
 
     @render_exception
     def render_OPENMETRICS(self, req):
+        """
+        Render our stats in `OpenMetrics <https://openmetrics.io/>` format.
+        For example Prometheus and Victoriametrics can parse this.
+        Point the scraper to ``/statistics?t=openmetrics`` (instead of the
+        default ``/metrics``).
+        """
         req.setHeader("content-type", "application/openmetrics-text; version=1.0.0; charset=utf-8")
         stats = self._provider.get_stats()
         ret = []