Skip to content

Commit

Permalink
chore: doc prometheus for analytics
Browse files Browse the repository at this point in the history 
Signed-off-by: Mark Phelps <[email protected]>
  • Loading branch information
@markphelps
markphelps committed Nov 25, 2024
1 parent cbdc34e commit 05ea806
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
31 changes: 31 additions & 0 deletions configuration/analytics.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Check warning on line 83 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 83, "column": 57}}}, "severity": "WARNING"}

<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>
7 changes: 7 additions & 0 deletions configuration/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

Check warning on line 473 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.

Raw Output:
{"message": "[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 473, "column": 42}}}, "severity": "WARNING"}

### Metrics

| Property | Description | Default | Since |
Expand Down

0 comments on commit 05ea806

Please sign in to comment.