From 05ea806a9f1c97f3a6db506a47b562f95cf1c09f Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Mon, 25 Nov 2024 09:31:52 -0500 Subject: [PATCH] chore: doc prometheus for analytics Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com> --- configuration/analytics.mdx | 31 +++++++++++++++++++++++++++++++ configuration/overview.mdx | 7 +++++++ 2 files changed, 38 insertions(+) diff --git a/configuration/analytics.mdx b/configuration/analytics.mdx index 6a2c6d4..c009ffc 100644 --- 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 + +## 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: + + + + + ```bash + FLIPT_ANALYTICS_STORAGE_PROMETHEUS_ENABLED=true + FLIPT_ANALYTICS_STORAGE_PROMETHEUS_URL=http://prometheus:9090 + ``` + + + + + ```yaml + analytics: + storage: + prometheus: + enabled: true + url: http://prometheus:9090 + ``` + + + diff --git a/configuration/overview.mdx b/configuration/overview.mdx index b91a8c6..c8e8e06 100644 --- 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 |