diff --git a/website/docs/reference/insights.mdx b/website/docs/reference/insights.mdx index 01bef48a9d..526b74e950 100644 --- a/website/docs/reference/insights.mdx +++ b/website/docs/reference/insights.mdx @@ -1,4 +1,3 @@ - --- title: Insights --- @@ -7,7 +6,7 @@ import Figure from '@site/src/components/Figure/Figure.tsx' :::info Availability -Insights is available in all Unleash versions from Unleash 6.0.0 onwards. +Insights is released in Unleash 6.0 and is available for Enterprise and Pro customers. Pro customers only see the first two charts. ::: @@ -15,47 +14,47 @@ Insights is a feature designed to help you better understand and gain insights i In total, there are 6 different charts available that show information over time: -- Total Users -- Total Flags -- Average Health -- Median Time to Production -- Flag Evaluation Metrics -- Updates per Environment Type +- Total users +- Total flags +- Average health +- Median time to production +- Flag evaluation metrics +- Updates per environment type -### Total Users +### Total users -The Total Users chart provides information about the total number of current users in your Unleash instance. This chart helps you understand how the user base is growing or changing over time. Additionally, it shows the number of users in selected projects and how the user distribution varies among them. Monitoring this chart can help identify trends and make data-driven decisions to improve user engagement. +The Total users chart provides information about the total number of current users in your Unleash instance. This chart helps you understand how the user base is growing or changing over time. Additionally, it shows the number of users in selected projects and how the user distribution varies among them. -
+
-### Total Flags +### Total flags -The Total Flags chart displays the total number of active (not archived) feature flags across all projects. It provides insights into how the number of flags has changed over time, helping you track the growth and usage of feature flags. You can also view the data for specific projects to understand how feature flag usage varies across different teams or applications. +The Total flags chart displays the total number of active (not archived) feature flags across all projects. It provides insights into how the number of flags has changed over time, helping you track the growth and usage of feature flags. You can also view the data for specific projects. -
+
-### Average Health +### Average health -The Average Health chart represents the percentage of flags in the selected projects that are not stale or potentially stale. This chart helps you monitor the overall health of your feature flags, ensuring that they are actively maintained and relevant. The chart also shows how the overall health changes over time, allowing you to identify potential issues early and take corrective actions. Tracking health per project provides more granular insights into individual project performance. +The average health chart represents the percentage of flags in the selected projects that are not stale or potentially stale. This chart helps you monitor the overall health of your feature flags, ensuring that they are actively maintained and relevant. The chart also shows how the overall health changes over time, allowing you to identify potential issues early and take corrective actions. -
+
-### Median Time to Production +### Median time to production -The Median Time to Production chart measures the average time from when a feature flag is created until it is enabled in a "production" type environment. This metric is calculated only for feature flags of the type "release" and is the median across the selected projects. Understanding this metric helps in assessing the efficiency of your development and deployment processes. It also highlights areas where you can improve to reduce time to market for new features. +The median time to production chart measures the average time from when a feature flag is created until it is enabled in a "production" type environment. This metric is calculated only for feature flags of the type "release" and is the median across the selected projects. Understanding this metric helps in assessing the efficiency of your development and deployment processes. It also highlights areas where you can improve to reduce time to market for new features. -
+
-### Flag Evaluation Metrics +### Flag evaluation metrics -The Flag Evaluation Metrics chart provides a summary of all flag evaluations reported by SDKs across all projects. This chart helps you understand how often feature flags are being evaluated and used within your applications. It can indicate the performance impact and the effectiveness of your feature flag implementations. By analyzing these metrics per project, you can gain deeper insights into the usage patterns and optimize accordingly. +The flag evaluation metrics chart provides a summary of all flag evaluations reported by SDKs across all projects. This chart helps you understand how often feature flags are being evaluated and used within your applications. It can indicate the performance impact and the effectiveness of your feature flag implementations. By analyzing these metrics per project, you can gain deeper insights into the usage patterns and optimize accordingly. -
+
-### Updates per Environment Type +### Updates per environment type -The Updates per Environment Type chart summarizes all configuration updates per environment type. This chart is crucial for understanding how configuration changes propagate across different environments, such as development, testing, and production. It helps in tracking the frequency and impact of updates, ensuring that changes are consistently and safely deployed. Monitoring updates per environment type can also help identify potential bottlenecks or issues in the deployment pipeline. +The updates per environment type chart summarizes all feature configuration updates per environment type. This chart is crucial for understanding how configuration changes propagate across different environments, such as development, testing, and production. It helps in tracking the frequency and impact of updates, ensuring that changes are consistently and safely deployed. Monitoring updates per environment type can also help identify potential bottlenecks or issues in the deployment pipeline. -
+
diff --git a/website/sidebars.js b/website/sidebars.js index 7c6f280ac8..b61dc39d34 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -250,6 +250,7 @@ module.exports = { 'reference/feature-toggle-variants', 'reference/front-end-api', 'reference/impression-data', + 'reference/insights', 'reference/login-history', 'reference/maintenance-mode', 'reference/network-view',