Skip to main content
Skip table of contents

Amazon Timestream for LiveAnalytics

JVM AGENT

Item Type Support

SIGNALS SCALARS CONDITION

Overview

The AWS Timestream for Live Analytics connector enables Seeq to access data from AWS Timestream for Live Analytics via the TimeStream Query API.

Prerequisites

You will need to create Access Keys for an IAM user that has read access to the Timestream tables of interest.

Configuration

This is an example configuration template that is displayed in the Additional Configuration box that appears when you click Configure for an existing datasource (or if a new datasource is being created, in the Create new datasource connection modal that appears after clicking Add Datasource) on the Datasources administration page.

JSON
{
    "RootAssetName": null,
    "GenerateTableAsset": true,
    "Tables": [
        {
            "Id": "4af550dc-1c83-4a0f-b2de-5e8a06345705",
            "Name": null,
            "NameQuery": null,
            "GroupBy": null,
            "GroupByLimit": 0,
            "DataColumns": null,
            "DataColumnQuery": null,
            "Database": null
        }
    ],
    "AccessKeyId": null,
    "SecretAccessKey": null,
    "Region": "us-east-1"
}
Google BigQuery Additional Configuration

Property Name

Default Value

Data Type

Description

RootAssetName

null

String

This will be the name for the root asset of the Asset Tree that is created after indexing your table. If it is set to null it will be set to the name of the Datasource Connection.

GenerateTableAsset

true

Boolean

unused

Tables

An empty Table Definition

A List of TimeStreamTables

The collection of table configurations which provide the necessary information to create signals in Seeq.

AccessKeyId

null

String

The IAM Access Key ID for the account that has read access to Timestream.

SecretAccessKey

null

String/SecretFile

The IAM Access Key Secret for the account that has read access to Timestream.

Region

us-east-1

String

The AWS region that your Timestream database is hosted in.

TimeStreamTable Configuration

Property Name

Default Value

Data Type

Description

Id

<Enter ID>

String

This is the unique ID for the table configuration itself. Note that changing the Id field will cause the relevant signals to be indexed under a different dataId in Seeq. You can use a GUID generator like https://guidgenerator.com/ to create a new one for each definition.

Name

null

String

This is the name of the Timestream table.

At least Name or NameQuery must be defined within each SignalTableDefinition. It is possible to provide Name and NameQuery parameters at the same time. Duplicate table names are ignored.

NameQuery

null

String

This is a query that defines how to obtain a list of tables with identical schemas. This property can hold a query like SHOW TABLES FROM connectordb LIKE 'dataset%' which will pull all tables from the database called connectordb that start wtih dataset.

At least Name or NameQuery must be defined within each SignalTableDefinition. It is possible to provide Name and NameQuery parameters at the same time. Duplicate table names are ignored.

GroupBy

Empty list

A list of Strings

This is a list of columns that can be used to group signals into an asset hierarchy based on distinct column value combinations. The column name order is important - it is used to generate the asset hierarchy. Example: "GroupBy" : [ "country", "region_name", "province_name" ] parameter definition produces the following hierarchy: <country>\<region_name>\<province_name>. When GroupBy is provided - the associated signal collection is linked to the asset defined by the GroupBy leaf element. When GroupBy parameter is not provided, the signal collection is linked to the asset representing BigQuery table.

GroupByLimit

0

Integer

A limit on the number of results (asset paths) that can be returned from the GroupBy. A GroupByLimit of 0 indicates no limit.

DataColumns

[]

A list of Strings

The list of columns that contain data that should be synced to Seeq as signal values . Each listed column name creates a unique Seeq signal. By default, signal name is equal to data column name. For example: "DataColumns" : [ "average_temperature_celsius" ].

At least DataColumns or DataColumnQuery parameter must be defined within each table configuration. It is possible to provide DataColumns and DataColumnQuery parameters at the same time. Duplicate column names are ignored.

DataColumnQuery

null

String

User provided query which allows to obtain the list of columns within the same table which data fields used as Seeq signal’s values. DataColumnQuery can contain the placeholders %projectid%, %dataset% and %tablename%, which will be replaced with actual values when querying the source system. For example: "DataColumnQuery" : "SHOW MEASURES FROM %database%.%tablename% LIKE 'data%'"

At least DataColumns or DataColumnQuery parameter must be defined within each table configuration. It is possible to provide DataColumns and DataColumnQuery parameters at the same time. Duplicate column names are ignored.

Known Issues

Please report any other issues you find to our support portal.

Troubleshooting

If you are running into other issues with connecting to or access data from AWS Timestream, view our guide for troubleshooting datasource issues.

Performance considerations

The AWS Timestream connector does not have any special performance considerations. View our guide on optimizing datasource performance for general guidance.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.