Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/analytics-documentation' into an…
Browse files Browse the repository at this point in the history 
…alytics-documentation
  • Loading branch information
@yquansah
yquansah committed Feb 7, 2024
2 parents 3c8c2eb + faeaeda commit 9b0f631
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
2 changes: 2 additions & 0 deletions configuration/analytics.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ 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:

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

Check failure on line 12 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'Clickhouse'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'Clickhouse'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 12, "column": 4}}}, "severity": "ERROR"}

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

- 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.

Check warning on line 18 in configuration/analytics.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'these' instead of 'All of these'.

Raw Output:
{"message": "[Microsoft.Wordiness] Consider using 'these' instead of 'All of these'.", "location": {"path": "configuration/analytics.mdx", "range": {"start": {"line": 18, "column": 1}}}, "severity": "WARNING"}
Expand Down
18 changes: 9 additions & 9 deletions configuration/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -322,18 +322,18 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001"

### Analytics

| Property | Description | Default | Since |
| ------------------------------| -------------------------------------------------- | ------- | ------- |
| analytics.buffer.flush_period | Duration to wait before sending events to sinks | 10s | v1.37.0 |
| Property | Description | Default | Since |
| ----------------------------- | ----------------------------------------------- | ------- | ------- |
| analytics.buffer.flush_period | Duration to wait before sending events to sinks | 10s | v1.37.0 |

#### Analytics: Clickhouse

Check failure on line 329 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'Clickhouse'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'Clickhouse'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 329, "column": 17}}}, "severity": "ERROR"}

| Property | Description | Default | Since |
| ------------------------------| ------------------------------------------------------------------------ | ------- | ------- |
| analytics.clickhouse.enabled | Switch for connection to clickhouse | false | v1.37.0 |
| analytics.clickhouse.url | URL for the clickhouse server | | v1.37.0 |
| analytics.clickhouse.username | Username for the clickhouse server | | v1.37.0 |
| analytics.clickhouse.password | Password for the clickhouse server | | v1.37.0 |
| Property | Description | Default | Since |
| ----------------------------- | ----------------------------------- | ------- | ------- |
| analytics.clickhouse.enabled | Switch for connection to clickhouse | false | v1.37.0 |

Check failure on line 333 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'clickhouse'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'clickhouse'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 333, "column": 60}}}, "severity": "ERROR"}
| analytics.clickhouse.url | URL for the clickhouse server | | v1.37.0 |

Check failure on line 334 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Flipt.Spelling] Check the spelling of 'clickhouse'. If the spelling is correct, add this word to the spelling exception list.

Raw Output:
{"message": "[Flipt.Spelling] Check the spelling of 'clickhouse'. If the spelling is correct, add this word to the spelling exception list.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 334, "column": 47}}}, "severity": "ERROR"}
| analytics.clickhouse.username | Username for the clickhouse server | | v1.37.0 |
| analytics.clickhouse.password | Password for the clickhouse server | | v1.37.0 |

### Tracing

Expand Down

0 comments on commit 9b0f631

Please sign in to comment.