Advanced settings
Collector settings
Logging
LogLevel
Default value: info
Description: The logging level for the logger.
Specifies the log level, only messages with the configured log level will be visible in the system logs and sent to the historian.
Log levels
- trace
- debug
- info
Higher log levels will always be sent to the historian.
Logging (windows only)
LogSize
Default value: 100
Description: The maximum size that a single log file can grow to before it is rotated.
LogFileMax
Default value: 10
Description: The number of logfiles that will be kept.
LogFileDays
Default value: 10
Description: The maximum age an archived logfile may have before it is deleted.
Windows
PriorityClass
Default value: ABOVE_NORMAL_PRIORITY_CLASS
Description: The priority class for the process. Valid values are NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, HIGH_PRIORITY_CLASS, REALTIME_PRIORITY_CLASS.
More info about the PRIORITY_CLASS.
Buffer
The buffer keeps a set amount of points in memory and when this fills up starts writing to a file.
It will periodically process the buffer, from file and then memory, by sending the points to the historian.
BufferProcessInterval
Default value: 250
Description: The interval in milliseconds that the buffer processes the buffer.
BufferMaxBatchSize
Default value: 5000
Description: The maximum size of a batch in the buffer.
BufferMaxBatches
Default value: 20
Description: The maximum amount of batches the buffer will keep in memory.
BufferDiskBatches
Default value: 100
Description: The maximum amount of batches that will be written to a buffer file.
BufferMinFreeDiskSpace
Default value: 2GB
Description: The buffer wont write to more files if the minimum free disk space is reached.
A negative value means no limit to remaining disk space on the system.
BufferMaxDiskSpace
Default value: 0MB
Description: The maximum disk space that the buffer files may take up. Default no limit.
A negative value means no limit to disk space used.
Communication
CompressionLevel
Default value: -1
Description: The compression level GRPC uses, for default compression. 1-9: 1 = fastest, 9 = most compressed, -1 = default.
GRPCMaxMessageSize
Default value: 64MB
Description: The maximum message size for GRPC messages.
Ticker
The ticker is used by collectors that poll measurements, like the OPC-UA collector.
This ticker determines how fast the measurements can polled and how accurate it needs to be.
Polled measurements can’t be polled at a lower interval than the ticker.
TickerInterval
Default value: 1000
Description: The interval for the base ticker in milliseconds.
TickerResolution
Default value: 25
Description: The resolution for the base ticker in milliseconds. Maximum 1/10th of the the interval.
TickerMaxDrift
Default value: 125
Description: The maximum drift a tick may have in milliseconds. Must be lower than the interval.
Other
AlternativeTimezone
Default value: /
Description: The timezone to reinterpret all timestamps in, the name is taken to be a location name corresponding to a file in the IANA Time Zone database.
HAPollingInterval
Default value: 1000
Description: The interval in milliseconds at which the backup collector polls the main collector’s health.
StatusGood
Description: A comma separated list of status strings that will be interpreted as a Good status. Escaping is possible with a backslash.
Environment variables
This section describes all environment variables that can be configured.
SERVER_NAME_OVERRIDE
Default value: historian.factry.local
Description: Only need to change this if using a different certificate.