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

Update analytics.mdx #183

Merged
merged 4 commits into from
Feb 8, 2024
Merged

Update analytics.mdx #183

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
52523ca
Update analytics.mdx
markphelps Feb 8, 2024
ff2c673
chore: format code
markphelps Feb 8, 2024
d34cccd
chore: more words
markphelps Feb 8, 2024
9bdfa29
Merge branch 'markphelps-patch-1' of https://github.com/flipt-io/docs…
markphelps Feb 8, 2024
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
21 changes: 13 additions & 8 deletions configuration/analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,35 @@ description: This document describes various configuration mechanisms for contro

Since [v1.37.0](https://github.com/flipt-io/flipt/releases/tag/v1.37.0) Flipt includes functionality for reporting analytical data to a configurable storage engine.

Currently, Flipt has support for reporting data into:
Currently, Flipt has support for collecting data into:

- [Clickhouse](https://clickhouse.com/)

The data that gets reported into the storage backends are currently:
The data that gets collected currently includes:

- Flag Evaluation Count

All of these analytics are viewable on the UI, and users can look back up to 24 hours of data for each metric.
Once a storage backend is configured, these analytics are viewable in the UI allowing users to visualize up to 24 hours of data for each metric.

![UI For Analytics](/images/configuration/analytics_quick_view.png)

The image above shows the past 30 minutes of evaluation(s) count for the flag `flag1`.
The image above shows the past 30 minutes of the flag `flag1` evaluation counts.

## Considerations

### Database

It's important to note that we do \*recommend\*\* for you to a separate database for analytics produced by Flipt so that the data can logically isolated from the rest of your Clickhouse data.
It's important to note that we do \*recommend\*\* to use a separate database for analytics produced by Flipt. This ensures that Flipt analytic data can be logically isolated from the rest of your Clickhouse data.

The reason for this isn't just a separation of concerns on a general level, but for possible data migrations and other related things via data on a technical level if changes do arise on our end.
<Note>
The analytics database must be created before Flipt will be able to write
analytical data and run any migrations. See our
[migration](https://www.flipt.io/docs/configuration/storage#migrations)
section for more info.
</Note>

### Origin of Analytics

Analytics are only produced currently as they pass through the server, which means if you use the [server sdks](/integration/server/rest) or the various [grpc sdks](/integration/server/grpc), analytical data will be sent to the backing store.
Analytics are currently only collected as they pass through the evaluation server. This means that analytics will be captured if you are using the REST or GRPC APIs via one of our [Server SDKs](/integration/server/rest) or [GRPC SDKs](/integration/server/grpc) for evaluations.

For client-side evaluation no metrics will be sent into clickhouse, but we're working on a feature to get it supported.
We have plans to support collecting analytics for client-side evaluations in the future.