Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: doc prometheus for analytics #291

Merged
merged 1 commit into from
Nov 25, 2024
Merged

chore: doc prometheus for analytics #291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions configuration/analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
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 @@

</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
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,13 @@
| 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
Loading