General Category

Canary Endpoints/Ports (version 24)

The following is a list of default ports that Canary uses for interoperability between remote Canary services and its clients. The endpoints that need opened are unique to each deployment and can be…

Configuring the Canary System to Send Email Alerts (version 24)

By configuring the Canary System to send email alerts, users can be notified if: a DataSet stops receiving data for x minutes disk space is running low a data file was improperly closed and taken…

How to Enable the Enhanced Audit Log (EAL) (version 24)

The Enhanced Audit Log is used to record audit messages within the Canary system whenever changes are made within the Canary Admin. To enable this feature:…

Default Install Directories (version 24)

Canary uses three directories for its software: C:\Program Files\Canary - This is where Canary's executables reside. C:\Historian Data - This is where the actual data is stored for each DataSet.…

How to Back-Up Canary Software (version 24)

Although Canary does not include a back-up feature within its software, the following 3 directories can be backed up using a 3rd party tool: C:\Program Files\Canary - This is the location where…

How To Change the Data Historian Location (version 24)

Upon the initial install of Canary software, the user has the option of choosing where the Historian Data folder will be located. This folder will contain a subfolder for each DataSet created in the…

How to Change the Canary Base Path Location (version 24)

Upon the initial install of Canary software, the user has the option of choosing where the Canary Base Path will be located. This is where Canary stores configuration files for its various services.…

Upgrading Canary Software (version 24)

Are you upgrading from a pre-24 version? Please see Breaking Changes in v24 before upgrading. In general, upgrading Canary software is as simple as installing over top of the previous version*.…

Silent Install Option (version 24)

Upon request, Canary offers a silent install option if wishing to install or update your Canary software. The deployment package contains the CanarySetup.msi for updating server applications (ie.…

How to Migrate the Canary Historian to a New Server (version 24)

The following article explains the steps that can be taken when migrating the Canary Historian to a new server. Note, each environment is unique and additional steps may be required to complete the…

Using a TLS Certificate for Canary Services (version 24)

By default, Canary generates a self-signed certificate for its services that require a secure encrypted connection. This certificate, however, is not a trusted certificate.…

Configuring Disk Space Limit For Historian (version 24)

The Historian will send an alert (if the system is configured to do, see Configuring the Canary System to Send Email Alerts) when there is 2048 MB of storage left on the disk.…

Changing Canary Server Names (version 24)

Canary uses the server name for some of its processes and how its services communicate with each other. Therein, downtime can occur whenever a server name is changed.…

Data Security (version 24)

The following article describes how data is secured In transit from Collector to Historian At rest in the Historian When accessed from the Historian Security In Transit Each Canary Collector is…

Relative Intervals and Datetimes (version 24)

All of Canary's client tools (Axiom, Excel Add-in, ODBC, API) support the functionality of relative datetime when requesting data for a given start/end time as well as the aggregate interval.…