Plugins 〉AWS IoT SiteWise
AWS IoT SiteWise
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.
Query editor
Use the "query type" selector to pick an appropriate query.
Click on the "Explore" button to open an asset/model navigation interface:
Multiple aggregations can be shown for a single property:
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>’
Grafana Cloud Pro
- $25 / user / month and includes a free trial for new users
- Available with a Grafana Cloud Pro plan
- Access to 1 Enterprise plugin
- Fully managed service (not available to self-manage)
Grafana Cloud Advanced / Grafana Enterprise
- Available with a Grafana Cloud Advanced plan or Grafana Enterprise license
- Access to all Enterprise plugins
- Run fully managed or self-manage on your own infrastructure
Installing AWS IoT SiteWise on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Data Source
Use the grafana-cli tool to install AWS IoT SiteWise from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Configure the Data Source
Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.
Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.
To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.
Change Log
All notable changes to this project will be documented in this file.
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.
v1.4.1
- Update Grafana AWS SDK dependencies to the latest versions
- Update Grafana dependencies to 8.5.0
v1.4.0
- Add support for interpolated property value queries
- Add support for last observed value in property value queries
- Switch from long to wide series to support alerting
v1.3.0
- Add support to define template variables using iot-sitewise datasource queries
- Add dashboard variable support in query editor
v1.2.6
- Make asset/model descriptions optional.
v1.2.5
- Fixes issue with asset explorer.
- Adds support for query by property alias.
v1.2.4
- Add linux/LDAP based authentication for Edge region.
v1.2.3
- Update
AUTO
aggregation to better select the resolution, and switch to the raw asset property value data when higher than 1m resolution is needed.
v1.2.2
- Adds resource cache for describe calls in the plugin back-end
v1.2.1
- Updates shared aws configuration library
- Bumps min version to 7.5
v1.2.0
- Shares auth configuration with cloudwatch
- Bumps min version to 7.4
v1.1.0
- Allowing 'Edge' region
- Support nil values in response #82
- Update aws libraries
v1.0.0
- Initial Release