How the Collector Works
The collector connects to a data source, broker, or server and discovers the tags you subscribe to. It then ensures it has connectivity to the designated historian instances and logs data to the configured dataset.
The Collector is able to ensure these tag metrics arrive by using store and forward. Should the network get disconnected of the historian become unavailable, the Collector will store all values to local disk. Upon reestablishment to the historian, all values will automatically be synched and real time logging will presume. Timebase Data Collectors handle ordering, deduplication, compression, and persistence automatically.
To Begin
Launch your browser and connect to the appropriate Collector (e.g., https://localhost:4521). Select the Config tab at the top of the browser, just to the right of the Timebase Collector logo.
Modifying data from the Collector page will effect multiple config files, location is dependent on your OS.
- Windows: C:\Program Data\Flow Software\Timebase\Collector\Config
- Docker: /config
Changing the Logging Session Properties section will write to the file 'collector.config'.
Modifying the Target Historians section will write to the file 'historians.config'.
The remaining configuration, focused on the Sparkplug broker connection and subscription(s) will modify the 'settings.config' file.
Universal Configuration Properties
These settings apply to every collector type in Timebase and define how the session behaves.
Logging Session Properties
Type: Each type will require a different guide for your configuration. See Configuring Each Collector for specific instructions and guidelines for each Collector type.
Note that the Ignition by Inductive Automation module is not available from the drop down. This module runs on the Ignition platform and must be installed and configured there. Consult the Ignition Module documentation for more details.
Dataset: The dataset name within the Timebase Historian you wish to target from this logging session. Datasets are automatically created for you if they do not exist.
It is recommended you maintain a single logging session to dataset relationship.
Target Historians
You can create multiple connections to target more than one historian. Each historian targeted will receive it's own data stream providing for redundancy.
Identifier: The label used to identify this historian target within the session; does not affect network routing but helps in diagnostics.
Host: The DNS name or IP address of the target historian that receives data.
Port: The port on which the historian accepts write requests; this must match the historian’s ingest configuration.
Use TLS: Enables encrypted communication between the collector and the historian; recommended for any environment where the collector and historian are not on the same protected network.
Authentication Enabled: Indicates whether the collector should authenticate using the Timebase Pulse Identity Provider before sending data.
IdP Host: The DNS name or IP address of the Pulse Identity Provider (IdP) used to obtain authentication tokens.
IdP Port: The port the IdP exposes for token requests.
IdP Use TLS: Enables TLS for communication with the Identity Provider.
Client ID: The client identity this collector uses when requesting tokens from the IdP.
Client Secret: The credential associated with the Client ID; it allows the collector to authenticate with Pulse.
Configuring Each Collector
Choose your Collector type to walk thru step by step instructions for that collector plugin:
Ignition by Inductive Automation