Enable events

Enable change events

You can enable change events for charts and panels on both classic dashboards and standard dashboards by adding annotations with a defined change events query. When enabled, change events display as a lined annotation on your dashboard panels. You must enable annotations on each dashboard where you want them to display.

Standard dashboards

Complete the following steps to enable change events on standard dashboard panels.

To enable change events on standard dashboard panels:

From a standard dashboard, click Edit to display all dashboard options.
In the dashboard options toolbar, click Events to display the Dashboard events panel.
In the Dashboard events dialog, click Add event.
In the Add event dialog, enter a name for your event, such as Alerts from Slack receiver.
In the Datasource menu, select Timeline events.
In the box, enter the change events filter you want to display in your panel. Use the change event filtering syntax to build your filter. For example, the following filter includes all deploy change events in the production environment:
```
category = "deploys" AND labels.environment = "production"
```
💡
If you're unsure what syntax is available, press Ctrl+Space to display available syntax options.
In the Add event dialog, click Add to add your filter.
In the Dashboard events dialog, click Apply to apply your filter to your dashboard panels.
In your dashboard, click Save to save your changes.

Change events matching the filter display as lined annotations on your dashboard panels, with icons representing the change event type.

To open a change event in Changes Explorer, click the event to pin it to the panel, and then click Open in Changes Explorer. Observability Platform directs you to the Summary tab for the specific event in Changes Explorer.

Classic dashboards

Complete the following steps to enable change events on classic dashboards panels.

You can use Grafana variable syntax (opens in a new tab) in your query, such as including $varname to interpolate values from your dashboard. Defining variables enables dropdowns in dashboards to better filter your displayed data. In conjunction with annotations, you can display change events relevant to your other telemetry data, such as metrics and traces. For example, if you filter your dashboard to display only metric data for your staging environment, you can display relevant change events for that environment only.

Limitations

The following limitations apply to change events for classic dashboards:

Change events created using the CreateEvent API (opens in a new tab) don't display as ranged annotations on Grafana charts. Only built-in change events, such as alerting monitors, and change events created through webhook integrations display as ranged annotations.
Change events display as annotations on Grafana graph panels only. If you use classic dashboards and want to display change events, your dashboard must use the graph panel type. Annotations aren't supported on other panel types, such as time series panels.

To enable change events on classic dashboard panels:

From a classic dashboard, click Settings > Advanced settings to display all dashboard options.
Optional: You can define variables and include them in your annotation. When the Grafana query evaluates, the current value replaces the variable.
1. Click the Variables tab, and then click New.
2. In the General section, enter a name for your variable in the Name field.
3. In the Query Options section, select a Refresh interval and enter your query in the Regex field. For example, you might create a variable named cluster with the following query:
```
label_values(frontend_requests, k8s_cluster)
```
4. In the Selection Options section, choose the options for how to display your data in the dashboard:
  - Multi-value: Presents each value for variable data as a checkbox in the variable dropdown to let you select multiple values.
  - Include all option: Provides an All option in the variable dropdown menu to let you select all available values.
  Refer to Grafana selection options for more information and examples about these options.
Click the Annotations tab, and then click Add Annotation Query.
In the Annotations page, enter a name for your annotation and select Chronosphere Timeline as the data source.
In the Query field, enter a change events query to define the data you want to display on your dashboard. If you defined variables, you can enter them in your query.

For example, the following query displays all change events categorized as deploys that contain an environment label including production-, and includes the $cluster variable you defined previously:
```
category = "deploys" AND labels.environment =~ "production-.*" AND title =~ ".*($cluster).*"
```
In the Include Labels field, enter a comma-separated list of labels you want to display in the annotation tooltip. If you enter a label that isn't mapped to an event, Observability Platform doesn't display that label in the annotation. For example:
```
deployment_id,target_service,user_email
```
Click Add to add your annotation, then click Save dashboard to save your changes.

Grafana selection options

When enabling change events for Grafana dashboards, you can define variables to include in your annotation. In the Selection Options section, you can choose Multi-value, Include all option, or both options. The approach you choose depends on your use case and user requirements, in addition to whether you integrate with other annotation plugins.

Multi-value: This option lets you select multiple values simultaneously, which is ideal for scenarios where you must associate annotations with various tags or categories.
Include all option: This option lets you select all values simultaneously. You can also enter a custom value to display annotations across all available values.

The following examples show how these settings operate for the Chronosphere Timeline data source. The query you construct and the end result differs depending on the data source you choose when defining a Grafana annotation.

Each of the following examples use the same query in the Query field of the Query Options section when defining a variable called cluster for a Grafana annotation:

label_values(production_request_ms_bucket, production_k8s_cluster)

Select neither option

If you select neither Multi-value or Include all option, the cluster dropdown in your classic dashboard lets you select only one value at a time.

Select include all with custom value

If you select Include all option and enter a wildcard (.*) value in the Custom all value field, the cluster dropdown in your Grafana dashboard includes an All option. Selecting All in the dropdown selects all values and is equivalent to the following query:

cluster =~ ".*.*.*"

Select multi-value only

If you select only Multi-value, you can select multiple values from the cluster dropdown in your classic dashboard. Selecting multiple values is equivalent to the following query, where production-a|production-b|... are the values:

cluster =~ “production-a|production-b|production-c|test-a|test-b”

Select both multi-value and include all

If you select both Multi-value and Include all option, and enter a wildcard (.*) value in the Custom all value field, the cluster dropdown in your classic dashboard both includes an All option and lets you select multiple values.

Selecting All in the dropdown is equivalent to the following query:

cluster =~ ".*.*.*"

Selecting multiple values in the dropdown is equivalent to the following query where production-a|production-b|... are the values:

cluster =~ “production-a|production-b|production-c|test-a|test-b”

View and create Distributed traces