Canary v24

.NET AGENT

Item Type Support

SIGNALS ASSETS

This connector only supports Canary versions 24 and newer.

Overview

The Canary Connector allows Seeq access data from the Canary Labs Historian over gRPC endpoints.

Prerequisites

You must have configured your Canary Views, set up a user with access to the tags you want Seeq to have access to, and created an API token for the created user.

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

{
      "HostName": "<Your Canary Historian address>",
      "Port": 55321,
      "UserName": "<Your User Name>",
      "IdentityApiToken": "<Your Identity API Token>",
      "ViewName": "ROOT",
      "ServerProtocol": "https",
      "IncludedQualities": [],
      "VerboseLogging": false,
      "AllowUntrustedSelfSignedServerCerts": false,
      "ReadTagValuesForDataTypeDuringIndexing": false
}

Canary Additional Configuration

Property Name	Default Value	Data Type	Description
`HostName`		String	The hostname for the server hosting your Canary Views. It may be an IP address or something like `sub-domain.domain.tld`.
`Port`	`55321`	Integer	The port on which your Canary Views gRPC API is configured to communicate on.
`UserName`		String	The name of the user account to which the Identity API token is for. This is useful for audit purposes indicating which requests your Remote Agent is making
`IdentityApiToken`		String	The API token the connector requires to make request to your Canary Views server.
`ServerProtocol`	`Https`	String	The protocol to be used to communicate with the Canary server. In addition to the default, `Http` is also supported but not recommended.
`VerboseLogging`	`false`	Boolean	A flag that determines whether additional logging should be made. This flag should be set to `true` if you encounter any issues as it could allow for valuable troubleshooting information to be logged.
`ViewName`	`ROOT`	String	This field determines what View the connector begins to retrieve data from.
`HistorianQualityFilter`	`[192]`	A List of positive integers	Values indicating what tag data values to consider as GOOD in the returned samples. Any tag data value with a Quality not included in this list is considered BAD and is returned as an invalid sample.
`AllowUntrustedSelfSignedServerCerts`	`false`	Boolean	This field determines whether the connector will allow connections with servers using self-signed certificates. NOTE: additional care should be taken before enabling this configuration option
`ReadTagValuesForDataTypeDuringIndexing`	`false`	Boolean	Will attempt to determine the signal data type by reading the last 100 values during indexing.
`MaxReceiveMessageSizeInBytes`	`null`	Integer	The maximum message sizes receivable by the Canary client. If set to `null`, the client defaults apply.
`MaxSendMessageSizeInBytes`	`null`	Integer	The maximum size of sendable packages in bytes.

Known Issues

Only string Scalars can have a UOM of string

Canary has the ability to mix data types within a single tag. This causes problems for Seeq when strings are mixed with numeric values. If ReadRawForDataTypeDuringIndexing is set to false, the connector assumes a numeric datatype for all signals. If set to true, the connector will attempt to determine the data type from the last 100 values. However, for systems with a large mix of strings and numbers, this approach could result in the wrong data type being assigned to the signal. To address this, we suggest you clean up your Canary data source to avoid mixing both types in a single tag.

Please report any issues you find to our support portal.

Troubleshooting

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

Performance considerations

The Canary connector does not have any special performance considerations. View optimizing datasource performance for general guidance.