diff --git a/.vale/styles/Flipt/spelling-exceptions.txt b/.vale/styles/Flipt/spelling-exceptions.txt index 85fe6d4..6a1f767 100644 --- a/.vale/styles/Flipt/spelling-exceptions.txt +++ b/.vale/styles/Flipt/spelling-exceptions.txt @@ -4,6 +4,7 @@ auditable backoff boolean caddy +clickhouse codeowners codespaces config @@ -52,7 +53,6 @@ protoc Quicksort redis regexes -rflipt rollout rollouts SCMs @@ -66,6 +66,4 @@ uncomment uncompromised URIs yaml -zipkin -clickhouse -Clickhouse \ No newline at end of file +zipkin \ No newline at end of file diff --git a/configuration/analytics.mdx b/configuration/analytics.mdx index 7b9c9ed..02f9dfc 100644 --- a/configuration/analytics.mdx +++ b/configuration/analytics.mdx @@ -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 -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. +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. -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. + + 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. + ### Origin of Analytics -Analytics are only produced currently as they pass through the server. This means you will receive data in your analytics database if your use either the [server sdks](/integration/server/rest) or the various [grpc sdks](/integration/server/grpc). +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](/integration/client) evaluations in the future. diff --git a/configuration/overview.mdx b/configuration/overview.mdx index b7b2d4f..b84fd4b 100644 --- a/configuration/overview.mdx +++ b/configuration/overview.mdx @@ -236,7 +236,7 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001" | storage.git.authentication.basic.username | The username to use for basic authentication | | v1.25.0 | | storage.git.authentication.basic.password | The password to use for basic authentication | | v1.25.0 | | storage.git.authentication.token | The access token to use for authentication | | v1.25.0 | -| storage.git.authentication.ssh.password | Password used to generate the SSH keypair | | v1.30.0 | +| storage.git.authentication.ssh.password | Password used to generate the SSH key pair | | v1.30.0 | | storage.git.authentication.ssh.private_key_path | Path to private key on the filesystem | | v1.30.0 | | storage.git.authentication.ssh.private_key_bytes | (Alternative) Raw private key bytes | | v1.30.0 | | storage.git.authentication.ssh.insecure_ignore_host_key | Skip verifying the known hosts key (avoid in production) | false | v1.30.0 | @@ -328,12 +328,10 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001" #### Analytics: Clickhouse -| 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.storage.clickhouse.enabled | Enable Clickhouse support | false | v1.37.0 | +| analytics.storage.clickhouse.url | URL to connect to clickhouse server | | v1.37.0 | ### Tracing