Documentation Plugins AWS IoT SiteWise Annotations

AWS IoT SiteWise annotations

Annotations let you overlay event information on top of graphs. You can add annotations from AWS IoT SiteWise data through Dashboard settings > Annotations.

Before you begin

Before you create an annotation query, ensure you have:

• Configured the AWS IoT SiteWise data source.
• Reviewed the AWS IoT SiteWise query editor, because annotation queries use the same query editor.

Create an annotation query

To create an annotation query:

1. Open the dashboard where you want to add annotations.
2. Click the dashboard settings icon.
3. Select Annotations from the left-side menu.
4. Click Add annotation query.
5. Select the AWS IoT SiteWise data source.
6. Build a query that returns the values you want to display as events.

Annotation columns

Grafana maps query result columns to annotation fields by name. The column names are matched case-insensitively. The following table describes the columns that AWS IoT SiteWise annotation queries use to render annotations.

Example annotation queries

The following SQL query creates an annotation for each property value that exceeds a threshold. It aliases event_timestamp as time, uses the property alias as the annotation text, and uses the value quality as a tag:

SQL Copy

select
  event_timestamp as time,
  property_alias as text,
  quality as tags
from raw_time_series
where $__timeFilter(event_timestamp) and double_value > 95
order by event_timestamp asc

You can also use a visual query, such as Get property value history, to return timestamped values for an asset property. Grafana renders each returned value as an annotation using the timestamp and value.

Next steps

• AWS IoT SiteWise query editor
• Grafana annotations