chore: document Prometheus headers (#293)

* chore: document prometheus headers support Signed-off-by: Mark Phelps <[email protected]> * chore: add example Signed-off-by: Mark Phelps <[email protected]> --------- Signed-off-by: Mark Phelps <[email protected]>
flipt-io · Nov 27, 2024 · ab027b3 · ab027b3
1 parent 5d43f69
commit ab027b3
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/configuration/analytics.mdx b/configuration/analytics.mdx
@@ -103,3 +103,15 @@ To configure Flipt to use Prometheus for analytics, you will need to add the fol
 
   </Tab>
 </Tabs>
+
+### Custom Headers
+
+You can also add custom headers to the Prometheus requests by setting the `analytics.storage.prometheus.headers` configuration property. This can be useful if you are using a proxy or need to add additional authentication headers.
+
+```yaml
+analytics:
+  storage:
+    prometheus:
+      headers:
+        "Authorization": "Bearer <token>"
+```
diff --git a/configuration/overview.mdx b/configuration/overview.mdx
@@ -471,6 +471,7 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001"
 | ------------------------------------ | ----------------------------------- | ------- | ------- |
 | analytics.storage.prometheus.enabled | Enable Prometheus support           | false   | v1.52.0 |
 | analytics.storage.prometheus.url     | URL to connect to prometheus server |         | v1.52.0 |
+| analytics.storage.prometheus.headers  | Additional headers to send with Prometheus requests (map[string]string) |                       | v1.52.1 |
 
 ### Metrics