From 8744dd3c71bcf29e8df7fdaf18448c3ff65c1035 Mon Sep 17 00:00:00 2001 From: Bnyro Date: Tue, 17 Sep 2024 16:43:48 +0200 Subject: [feat] metrics: support for open metrics --- docs/admin/settings/settings_general.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/admin/settings') diff --git a/docs/admin/settings/settings_general.rst b/docs/admin/settings/settings_general.rst index 02a2156b3..75acb4f6d 100644 --- a/docs/admin/settings/settings_general.rst +++ b/docs/admin/settings/settings_general.rst @@ -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 `_ 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. -- cgit v1.2.3