Using AWS IoT TwinMaker knowledge graph with Grafana

You can add a query editor panel to your AWS IoT TwinMaker Grafana dashboard to run and display queries.

AWS IoT TwinMaker query editor prerequisites

Before using the AWS IoT TwinMaker knowledge graph in Grafana, make sure you have reviewed the following prerequisites:

• You have an AWS IoT TwinMaker workspace. You can create a workspace in the AWS IoT TwinMaker console.

• You have configured AWS IoT TwinMaker for use with Grafana. For information, see AWS IoT TwinMaker Grafana dashboard integration.

Note

In order to use the AWS IoT TwinMaker knowledge graph, you need to be in either the standard or tiered bundle pricing modes. For more information, see Switch AWS IoT TwinMaker pricing modes.

AWS IoT TwinMaker query editor permissions

In order to use the AWS IoT TwinMaker query editor in Grafana, you must have an IAM role with permission for the action iottwinmaker:ExecuteQuery. Add that permission to your workspace dashboard role, as shown in the following example:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetObject"
            ],
            "Resource": [
                "{s3Arn}",
                "{s3Arn}/"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "iottwinmaker:Get",
                "iottwinmaker:List",
                "iottwinmaker:ExecuteQuery"
            ],
            "Resource": [
                "{workspaceArn}",
                "{workspaceArn}/*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": "iottwinmaker:ListWorkspaces",
            "Resource": "*"
        }
    ]
}

Note

When configuring your AWS IoT TwinMaker Grafana data source, make sure to use the role with this permission for the Assume role ARN field. After you add it, you can select your workspace from the dropdown next to Worksapce.

For more information, see Creating a dashboard IAM role.

Set up the AWS IoT TwinMaker query editor panel

Use the following procedure to set up a new Grafana dashbaord panel for knowledge graph.

1. Open your AWS IoT TwinMaker Grafana dashbaord.

2. Create a new dashboard panel. For detailed steps on panel creation, see the Grafana documentation Create a dashboard.

3. From the list of visualizations, select AWS IoT TwinMaker Query Editor, as shown in the following screenshot.

   

4. Select the data source to run queries against.

5. (Optional) Add a name for the new panel in the provided field.

6. Choose Apply to save and confirm your new panel.

The knoweledge graph panel works simillarly to the query editor provided in the AWS IoT TwinMaker console. You can run, write, and clear queries you make in the panel. For more inforation on writing queries, see AWS IoT TwinMaker knowledge graph additional resources.

Using the AWS IoT TwinMaker query editor

The results of your queries are displayed in three ways, as shown in the following images: visualized in a graph, listed in a table, or presented as a run summary.

• Graph visualization:

  

  The visual graph only displays data for queries that have at least one relation in the result. The graph displays entities as nodes and relations as directed edges in the graph.

• Tabular data

  

  The tabular data format displays the data for all queries. You can search the table for certain results or subsets of the results. The data can be exported in a JSON or CSV format.

• Run summary

  

  The run summary displays the query and metadata about the status of the query.