Skip to content

plugins(stats_over_http): Add Prometheus v2 output with metric labels #12792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
itsh3sam wants to merge 1 commit into
base: master
Choose a base branch
from
+487 −28
Open

plugins(stats_over_http): Add Prometheus v2 output with metric labels #12792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions doc/admin-guide/plugins/stats_over_http.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,29 @@ if you wish to have it in CSV format you can do so by passing an ``Accept`` head

.. option:: Accept: text/csv

Prometheus formatted output is also supported via the ``Accept`` header:
Prometheus formatted output is also supported via the ``Accept`` header. Version 0.0.4
(flat metric names) and version 2.0.0 (labeled metrics for better aggregation)
are supported:

.. option:: Accept: text/plain; version=0.0.4
.. option:: Accept: text/plain; version=2.0.0

Alternatively, the output format can be specified as a suffix to the configured
path in the HTTP request target. The supported suffixes are ``/json``,
``/csv``, and ``/prometheus``. For example, if the path is set to ``/_stats``
(the default), you can access the stats in CSV format by using the URL::
``/csv``, ``/prometheus``, and ``/prometheus_v2``. For example, if the path
is set to ``/_stats`` (the default), you can access the stats in CSV format by
using the URL::

http://host:port/_stats/csv

The Prometheus format can be requested by using the URL::
The Prometheus version 0.0.4 format (flat) can be requested by using the URL::

http://host:port/_stats/prometheus

The Prometheus v2 labeled format can be requested by using the URL::

http://host:port/_stats/prometheus_v2

The JSON format is the default, but you can also access it explicitly by using the URL::

http://host:port/_stats/json
Expand All @@ -129,9 +137,11 @@ specify a path suffix, the plugin will return the data in that format regardless
the ``Accept`` header.

In either case the ``Content-Type`` header returned by ``stats_over_http.so`` will
reflect the content that has been returned: ``text/json``, ``text/csv``, or
``text/plain; version=0.0.4; charset=utf-8`` for JSON, CSV, and Prometheus
formats respectively.
reflect the content that has been returned: ``text/json``, ``text/csv``,
``text/plain; version=0.0.4; charset=utf-8``, or
``text/plain; version=2.0.0; charset=utf-8`` for JSON, CSV, Prometheus v1, and
Prometheus v2 formats respectively.


Stats over http also accepts returning data in gzip or br compressed format per the
``Accept-encoding`` header. If the header is present, the plugin will return the
Expand Down
Loading