chore: doc prometheus for analytics (#291)

Signed-off-by: Mark Phelps <[email protected]>
flipt-io · Nov 25, 2024 · 5d43f69 · 5d43f69
1 parent cbdc34e
commit 5d43f69
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/configuration/analytics.mdx b/configuration/analytics.mdx
@@ -10,6 +10,7 @@ Flipt includes functionality for reporting analytical data to a configurable sto
 Currently, Flipt has support for collecting data into the following storage engines:
 
 - [ClickHouse](https://clickhouse.com/)
+- [Prometheus](https://prometheus.io/)
 
 The data that gets collected currently includes:
 
@@ -72,3 +73,33 @@ To configure Flipt to use ClickHouse for analytics, you will need to add the fol
 
   </Tab>
 </Tabs>
+
+## Prometheus
+
+You can use any [Prometheus](https://prometheus.io/docs/introduction/overview/) server to store your analytics data.
+
+### Configuration
+
+To configure Flipt to use Prometheus for analytics, you will need to add the following configuration to your `config.yml` file or environment variables:
+
+<Tabs>
+  <Tab title="Environment Variables">
+
+    ```bash
+    FLIPT_ANALYTICS_STORAGE_PROMETHEUS_ENABLED=true
+    FLIPT_ANALYTICS_STORAGE_PROMETHEUS_URL=http://prometheus:9090
+    ```
+
+  </Tab>
+  <Tab title="Configuration YAML">
+
+    ```yaml
+    analytics:
+      storage:
+        prometheus:
+          enabled: true
+          url: http://prometheus:9090
+    ```
+
+  </Tab>
+</Tabs>
diff --git a/configuration/overview.mdx b/configuration/overview.mdx
@@ -465,6 +465,13 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001"
 | analytics.storage.clickhouse.enabled | Enable Clickhouse support           | false   | v1.37.0 |
 | analytics.storage.clickhouse.url     | URL to connect to clickhouse server |         | v1.37.0 |
 
+#### Analytics: Prometheus
+
+| Property                             | Description                         | Default | Since   |
+| ------------------------------------ | ----------------------------------- | ------- | ------- |
+| analytics.storage.prometheus.enabled | Enable Prometheus support           | false   | v1.52.0 |
+| analytics.storage.prometheus.url     | URL to connect to prometheus server |         | v1.52.0 |
+
 ### Metrics
 
 | Property         | Description                            | Default    | Since   |