Skip to content

Commit

Permalink
Update analytics.mdx (#183)
Browse files Browse the repository at this point in the history 
* Update analytics.mdx

* chore: format code

* chore: more words

---------

Co-authored-by: markphelps <[email protected]>
  • Loading branch information
@markphelps
markphelps and markphelps authored Feb 8, 2024
1 parent 4dc397c commit 95bc5ef
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions configuration/analytics.mdx
View file
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.

Check warning on line 18 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 18, "column": 1}}}, "severity": "WARNING"}

Check warning on line 18 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.

Raw Output:
{"message": "[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 18, "column": 16}}}, "severity": "WARNING"}

![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.
We highly **recommend** using 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.

Check warning on line 28 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 28, "column": 1}}}, "severity": "WARNING"}

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

Check warning on line 31 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": 31, "column": 55}}}, "severity": "WARNING"}
analytical data and run any migrations. See our

Check warning on line 32 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 32, "column": 47}}}, "severity": "WARNING"}
[migration](https://www.flipt.io/docs/configuration/storage#migrations)
section for more info.
</Note>

### Origin of Analytics

Check warning on line 37 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Origin of Analytics' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Origin of Analytics' should be in sentence case", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 37, "column": 5}}}, "severity": "WARNING"}

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.

Check warning on line 39 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 39, "column": 84}}}, "severity": "WARNING"}

Check warning on line 39 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": 39, "column": 110}}}, "severity": "WARNING"}

Check warning on line 39 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 39, "column": 177}}}, "severity": "WARNING"}

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](/integration/client) evaluations in the future.

Check failure on line 41 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'we've' instead of 'We have'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'we've' instead of 'We have'.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 41, "column": 1}}}, "severity": "ERROR"}

0 comments on commit 95bc5ef

Please sign in to comment.