diff options
| author | Bnyro <bnyro@tutanota.com> | 2024-09-17 16:43:48 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarIT.de> | 2024-11-24 14:25:49 +0100 |
| commit | 8744dd3c71bcf29e8df7fdaf18448c3ff65c1035 (patch) | |
| tree | e4c1b50f1aa53b8b2023ca8b5c1d94551b1b4cdb /docs/admin/settings/settings_general.rst | |
| parent | 7927baf545013b829611834c20042c7b17e18ca0 (diff) | |
| download | searxng-8744dd3c71bcf29e8df7fdaf18448c3ff65c1035.tar.gz searxng-8744dd3c71bcf29e8df7fdaf18448c3ff65c1035.zip | |
[feat] metrics: support for open metrics
Diffstat (limited to 'docs/admin/settings/settings_general.rst')
| -rw-r--r-- | docs/admin/settings/settings_general.rst | 8 |
1 files changed, 8 insertions, 0 deletions
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 <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. |