Plugins 〉AWS IoT SiteWise

Data Source

grafana

AWS IoT SiteWise

Overview
Installation
Change log
Related content

Warning
We recommend customers to use Grafana version 10.4.0 or higher for the AWS IoT SiteWise Datasource. Grafana instances with versions prior to 10.4.0 are unable to use AWS IoT SiteWise data source versions beyond 1.25.2.

AWS IoT SiteWise Datasource

This datasource supports reading data from AWS IoT SiteWise and showing it in a Grafana dashboard.

Add the data source

In the side menu under the Configuration link, click on Data Sources.
Click the Add data source button.
Select IoT SiteWise in the Industrial & IoT section.

Authentication

The IoT SiteWise plugin authentication matches the standard Cloudwatch plugin system. See the grafana cloudwatch documentation for authentication options and setup.

Once authentication is configured, click "Save and Test" to verify the service is working. Once this is configured, you can specify default values for the configuration.

Querying data

Users can choose between the UI driven Query builder and the Query code editor, that uses IoT SiteWise query language queries to fetch data. The Query builder offers a guided, less technical interface, whereas the Query code editor is more technical but also more powerful.

Query builder

Use the "query type" selector to pick an appropriate query.

query-editor

Click on the "Explore" button to open an asset/model navigation interface:

query-editor

Multiple aggregations can be shown for a single property:

query-editor

Alerting

Standard grafana alerting is support with this plugin, however note that alert queries may not include template variables. See the Alerting documentation for more on Grafana alerts.

Configure the data source with provisioning

You can configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the provisioning docs page.

Here are some provisioning examples for this data source.

Using a credentials file

If you are using Credentials file authentication type, then you should use a credentials file with a config like this.

apiVersion: 1
datasources:

name: IoT SiteWise
type: grafana-iot-sitewise-datasource
jsonData:
authType: credentials
defaultRegion: us-east-1

Using `accessKey` and `secretKey`

apiVersion: 1
datasources:

name: IoT SiteWise
type: grafana-iot-sitewise-datasource
jsonData:
authType: keys
defaultRegion: us-east-1
secureJsonData:
accessKey: ‘<your access key>’
secretKey: ‘<your secret key>’

Installing AWS IoT SiteWise on Grafana Cloud:

For more information, visit the docs on plugin installation.

Change Log

All notable changes to this project will be documented in this file.

2.2.0

Add support for listing associated assets for multiple assets in #439
chore: refactor additional class components in #445
chore(deps): bump the all-go-dependencies group with 2 updates in #447
Chore: add label to external contributions in #408
chore(deps): bump the all-node-dependencies group across 1 directory with 14 updates in #452
fix: client cache switch should control the correct query in #449
fix: client cache should respect variable changes in #456
chore: grafana instance version support warning in #457

2.1.0

chore refactor metadata inspector in #442
chore remove dead code in #443
chore(deps-dev): bump the all-node-dependencies group with 16 updates in #438
chore(deps): bump the all-go-dependencies group with 2 updates in #437
fix: remove unsupported regions in #441
feat: support template var for interpolated resolution; make UX consistent for the resolution field on the GetInterpolatedAssetPropertyValues query in #433
feat: Support nested variable UX for modelId in #432
Feat: Add support for 15min resolution; Improve UI in dropdowns for variables and add support for variables in Resolution in #429
chore(deps): bump the all-node-dependencies group with 16 updates in #426
chore(deps): bump the all-go-dependencies group with 2 updates in #427
Add variable interpolation for model id in #428
fix: isValidQuery broken for listAssets and listAssetModels in #425
chore(deps): bump the all-node-dependencies group across 1 directory with 19 updates in #420
chore(deps): bump github.com/grafana/grafana-plugin-sdk-go from 0.265.0 to 0.266.0 in the all-go-dependencies group in #419

2.0.0

(Breaking change:) Migrate to plugin-ui from grafana/experimental in #384
chore(deps): bump the all-go-dependencies group across 1 directory with 2 updates in #413
chore(deps): bump the all-node-dependencies group across 1 directory with 20 updates in [#405](https://github.com/grafana/iot-sitewise-datasource/pull/ 405)
Bugfix: Filter out invalid queries in variable editor in #399
Chore: update docker compose to support improved backend development in #397
Bump the all-node-dependencies group with 7 updates in #396
fix: list associated assets query fields in #394
feat: support asset selection by external id in #390

1.25.2

Bump the all-node-dependencies group across 1 directory with 17 updates in #389
Bump the all-go-dependencies group with 3 updates in #388
Bump github.com/grafana/grafana-plugin-sdk-go from 0.260.3 to 0.261.0 in the all-go-dependencies group in #385
Bump the all-node-dependencies group across 1 directory with 20 updates in #382
Bump the all-go-dependencies group across 1 directory with 2 updates in #379

1.25.1

Chore: Update plugin.json keywords #359
Bump the all-github-action-dependencies group with 3 updates #372
Bump the all-go-dependencies group with 4 updates #373
Bump the all-node-dependencies group with 30 updates #374

1.25.0

Fix: batch entries up to the limit specified in the API #355

1.24.0

fix: add check for nil for property value #352
Fix golangci-lint errors #353
fix: migrate asset id on the frontend in the query editor #350
Remove "ANY" as a query quality option #347
Chore: Rename datasource file #344
Add precommit hook #338
Remove unused fields from Get property value query editor #343
Remove ANY option for interpolated property quality #342

1.23.0

Feat: add list time series to query editor by @ssjagad in #336
Chore: update dependencies in #337
Migrate to new form styling in config and query editors #332

1.22.1

Fix: use ReadAuthSettings to get authSettings in #333

1.22.0

Update to use GetSessionWithAuthSettings #330

1.21.0

Refactor Paginator #313
Fix e2e tests #316
Added Stalebot #314
Added lint rule #319
Add a frontend cache for relative time range queries #318
Removed unsupported time ordering from interpolated query and fix issue with caching aggregates queries #323

1.20.0

Perf: Update batch api queries to request maximum number of dependencies in (#310)[https://github.com/grafana/iot-sitewise-datasource/pull/310]

1.19.0

Fetch properties using both AssetId and AssetIds in (#307)[https://github.com/grafana/iot-sitewise-datasource/pull/307]
Migrate to CustomVariableSupport in (#304)[https://github.com/grafana/iot-sitewise-datasource/pull/304]

1.18.0

Fix fetching asset properties in (#302)[https://github.com/grafana/iot-sitewise-datasource/pull/302]
Feature: L4E struct support in (#300)[https://github.com/grafana/iot-sitewise-datasource/pull/300]
Response processing: Add struct data type handling in (#297)[https://github.com/grafana/iot-sitewise-datasource/pull/297]
Query Editor: Improve menu placement for dropdowns in (#292)[https://github.com/grafana/iot-sitewise-datasource/pull/292]
Add keywords in (#291)[https://github.com/grafana/iot-sitewise-datasource/pull/291]
E2E: Add happy path playwright query tests in (#290)[https://github.com/grafana/iot-sitewise-datasource/pull/290]
Query Editor: Stop running queries on every change in (#274)[https://github.com/grafana/iot-sitewise-datasource/pull/274]

1.17.0

Update grafana-aws-sdk to 0.21.0 and prepare 1.16.2 in (#282)[https://github.com/grafana/iot-sitewise-datasource/pull/282]
fix: clear selected property when assets are removed (#278)[https://github.com/grafana/iot-sitewise-datasource/pull/278]
E2E Tests (#285)[https://github.com/grafana/iot-sitewise-datasource/pull/285]
Add support for composite model properties (#279)[https://github.com/grafana/iot-sitewise-datasource/pull/279]
Use non-batch APIs at the edge (#281)[https://github.com/grafana/iot-sitewise-datasource/pull/281]

1.16.1

Upgrade aws-sdk-go to v1.49.6 to have access to the ExecuteQuery API (#266)
Fix: Infer data type for disassociated streams for property value queries by alias (#275)

1.16.0

Use query region to get client for queries (#258)
Feat: implement an "all" option for list associated assets query (#261)

1.15.0

Support multiple assets for interpolated queries in (#256)[https://github.com/grafana/iot-sitewise-datasource/pull/256]

1.14.0

Query and Config editors: Migrate to new form styling under feature toggle in (#244)[https://github.com/grafana/iot-sitewise-datasource/pull/244]

1.13.0

Update dependencies and create-plugin configuration by @idastambuk in https://github.com/grafana/iot-sitewise-datasource/pull/243
Property aggregate processing: Move out ErrorEntries processing from SuccessEntries block by @idastambuk in https://github.com/grafana/iot-sitewise-datasource/pull/240
Bump go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace from 0.37.0 to 0.44.0 by @dependabot in https://github.com/grafana/iot-sitewise-datasource/pull/241
Bump @babel/traverse from 7.17.10 to 7.23.2 by @dependabot in https://github.com/grafana/iot-sitewise-datasource/pull/245
Bump loader-utils from 2.0.2 to 2.0.4 by @dependabot in https://github.com/grafana/iot-sitewise-datasource/pull/248
Bump semver from 5.7.1 to 5.7.2 by @dependabot in https://github.com/grafana/iot-sitewise-datasource/pull/247
Bump google.golang.org/grpc from 1.58.2 to 1.58.3 by @dependabot in https://github.com/grafana/iot-sitewise-datasource/pull/246
Upgrade yaml package by @fridgepoet in https://github.com/grafana/iot-sitewise-datasource/pull/249
Upgrade underscore, debug dependencies by @fridgepoet in https://github.com/grafana/iot-sitewise-datasource/pull/252
Bump yaml from 2.2.1 to 2.3.4 by @dependabot in https://github.com/grafana/iot-sitewise-datasource/pull/253
Bump json5 from 2.2.1 to 2.2.3 by @dependabot in https://github.com/grafana/iot-sitewise-datasource/pull/254

Full Changelog: https://github.com/grafana/iot-sitewise-datasource/compare/v1.12.1...v1.13.0

v1.12.1

Disassociated streams: Hash entryId to fix bug with property aliases longer than 64 characters in #239

v1.12.0

Query by property alias: Add support for unassociated streams in #231

v1.11.1

Revert "Replace deprecated setVariableQueryEditor with CustomVariableSupport" in #229

v1.11.0

Update backend grafana-aws-sdk to v0.19.1 to add il-central-1 to the opt-in region list
Update frontend grafana/aws-sdk to v0.1.2 to limit grafana_assume_role only to enabled datasources

v1.10.3

Update grafana/aws-sdk-react dependency https://github.com/grafana/iot-sitewise-datasource/pull/20

v1.10.2

Fix: Fix scoped variables replacement in assetids such as repeat panels by @ahom https://github.com/grafana/iot-sitewise-datasource/pull/205

v1.10.1

Fix: Property aggregate queries returning duplicated data https://github.com/grafana/iot-sitewise-datasource/pull/203
Fix: Query with expression only returns partial data https://github.com/grafana/iot-sitewise-datasource/pull/206

v1.10.0

Include propertyName in data frame name for 'raw' queries https://github.com/grafana/iot-sitewise-datasource/pull/199

v1.9.2

Fetch asset property info if asset id and property id are available https://github.com/grafana/iot-sitewise-datasource/pull/192
Handle expression queries with more than 250 data points https://github.com/grafana/iot-sitewise-datasource/pull/194

v1.9.1

Replace deprecated setVariableQueryEditor with CustomVariableSupport in https://github.com/grafana/iot-sitewise-datasource/pull/184

v1.9.0

Add ability to perform property queries by only specifying a property alias (#179)

1.8.1

Update grafana-aws-sdk version to include new region in opt-in region list https://github.com/grafana/grafana-aws-sdk/pull/80
Security: Upgrade Go in build process to 1.20.4
Update grafana-plugin-sdk-go version to 0.161.0 to avoid a potential http header problem. https://github.com/grafana/athena-datasource/issues/233

v1.8.0

Update backend dependencies

v1.7.0

Variables: Fix assetId field variable replacement (#172)
Bump coverage to version 0.1.19 (#173)
Update aws-sdk-go for the opt-in region list (#168)
Modify templates and add workflows for AWS Datasources squad (#163)
Migrate to create-plugin (#159) (#159)

v1.6.0

Add Batch API support

v1.5.1

Add response format selection to time series queries

v1.5.0

Renamed last observed value feature to 'Expand Time Range'
The expand time range toggle now queries for the previous known value before the start of the current time range, and the next known value after the current time range.