You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Feature Health is an upcoming feature that's not yet available.
8
+
9
+
:::
10
+
11
+
Feature Health enables users to monitor observability metrics within Flagsmith, specifically in relation to Flagsmith's Features and Environments. Flagsmith receives alert notifications from your observability provider and, based on this data, marks your Features and optionally Environments with an **Unhealthy** status, providing details about the alerts. This enhances your team's observability, allowing for quicker, more informed decisions.
12
+
13
+
## Integrations
14
+
15
+
The following is an overview of the Feature Health providers currently supported.
16
+
17
+
### Grafana / Prometheus Alertmanager
18
+
19
+
[Learn more](/integrations/apm/grafana/#feature-health-provider-setup) about configuring Grafana / Prometheus Alertmanager Feature Health provider.
20
+
21
+
### Sample Provider
22
+
23
+
We provide a Sample Provider for your custom integrations. To create a Sample Feature Health webhook:
24
+
25
+
1. Go to Project Settings > Feature Health.
26
+
2. Select "Sample" from the Provider Name drop-down menu.
27
+
3. Click Create and copy the Webhook URL.
28
+
29
+
You can use the webhook in your custom integration. Refer to the payload schema below:
Flag change events will now be sent to Grafana as _Organisation Level_[Annotations](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/).
41
+
42
+
To view the annotations in Grafana, go to Dashboard Settings > Annotations, select the `Grafana` data source, and filter by the `flagsmith` tag.
43
+
44
+
Annotations for feature-specific events include project tags, user-defined tags, and environment tags for flag change events.
45
+
46
+
## Feature Health Provider Setup
47
+
48
+
:::info
49
+
50
+
Feature Health is an upcoming feature that is not yet available.
51
+
52
+
:::
53
+
54
+
### In Flagsmith:
55
+
56
+
1. Go to Project Settings > Feature Health.
57
+
2. Select "Grafana" from the Provider Name drop-down menu.
58
+
3. Click Create and copy the Webhook URL.
59
+
60
+
### In Grafana:
61
+
62
+
1. Create a new Webhook contact point using the Webhook URL from Flagsmith. Refer to the [Grafana documentation on contact points](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/#add-a-contact-point) for details.
63
+
2. Leave Optional Webhook settings empty. Ensure the "Disable resolved message" checkbox is unchecked.
64
+
3. Add the `flagsmith_feature` label to your alert rule, specifying the Flagsmith Feature name. Refer to the [Grafana documentation on alert rule labels](https://grafana.com/docs/grafana/latest/alerting/fundamentals/alert-rules/annotation-label/#labels) for more information.
65
+
4. Optionally, include the `flagsmith_environment` label in your alert rule, using the Flagsmith Environment name as the value.
66
+
5. Set the previously created contact point as the alert rule recipient.
67
+
68
+
You can create multiple alert rules pointing to the Feature Health Provider webhook. Ensure they include the `flagsmith_feature` label with a Feature name from the Project you created the Feature Health Provider for, to see Feature Health status changes for your features.
40
69
41
-
You can view the annotations in your Grafana dashboards but going to Dashboard Settings > Annotations, selecting the
42
-
`Grafana` data source and then filtering on annotations that are tagged with the `flagsmith` tag.
70
+
You can integrate Grafana Feature Health with Prometheus Alertmanager. For detailed instructions on adding Flagsmith labels to your alerts in Prometheus, refer to the [Prometheus Alertmanager webhook configuration](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config) and [Alerting rules configuration](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/#defining-alerting-rules) documentation.
43
71
44
-
Annotations reporting feature-specific events include the project tag and Flagsmith user-defined tags, and flag change
45
-
events include the environment tag as well.
72
+
The Feature Health UI will display the following information:
73
+
- Alert name
74
+
- Link to the alert instance in your Alertmanager
75
+
- Alert description (if provided in alert annotations)
76
+
- Alert summary (if provided in alert annotations)
0 commit comments