Icycoide/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng.git synced 2025-08-02 10:02:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

[feat] metrics: support for open metrics

Browse source
This commit is contained in:
Bnyro 2024-09-17 16:43:48 +02:00 • committed by Markus Heiser
parent 7927baf545
commit 8744dd3c71
6 changed files with 130 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/admin/settings/settings_general.rst
View file

@ -13,6 +13,7 @@
donation_url: false
contact_url: false
enable_metrics: true
open_metrics: ''
``debug`` : ``$SEARXNG_DEBUG``
Allow a more detailed log if you run SearXNG directly. Display *detailed* error
@ -32,3 +33,10 @@
``enable_metrics``:
Enabled by default. Record various anonymous metrics available at ``/stats``,
``/stats/errors`` and ``/preferences``.
``open_metrics``:
Disabled by default. Set to a secret password to expose an
`OpenMetrics API <https://github.com/prometheus/OpenMetrics>`_ at ``/metrics``,
e.g. for usage with Prometheus. The ``/metrics`` endpoint is using HTTP Basic Auth,
where the password is the value of ``open_metrics`` set above. The username used for
Basic Auth can be randomly chosen as only the password is being validated.