Advanced
Environment variables
This section describes all environment variables that can be configured.
Logging
LOG_LEVEL
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
- warning
- error
- fatal
- panic
Logging (windows only)
LOG_SIZE
Default value: 100
Description: The maximum size that a single log file can grow to before it is rotated.
LOG_FILE_MAX
Default value: 10
Description: The number of logfiles that will be kept.
LOG_FILE_DAYS
Default value: 10
Description: The maximum age an archived logfile may have before it is deleted.
Windows
PRIORITY_CLASS
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.
BUFFER_PROCESS_INTERVAL
Default value: 250
Description: The interval in milliseconds that the buffer processes the buffer.
BUFFER_MAX_BATCH_SIZE
Default value: 5000
Description: The maximum size of a batch in the buffer.
BUFFER_MAX_BATCHES
Default value: 100
Description: The maximum amount of batches the buffer will keep in memory.
BUFFER_DISK_BATCHES
Default value: 20
Description: The maximum amount of batches that will be written to a buffer file.
BUFFER_MIN_FREE_DISK_SPACE
Default value: 2048
Description: The buffer wont write to more files if the minimum free disk space(in MB) is reached.
A negative value means no limit to remaining disk space on the system.
BUFFER_MAX_DISK_SPACE
Default value: -1
Description: The maximum disk space(in MB) that the buffer files may take up.
A negative value means no limit to disk space used.
Communication
SERVER_NAME_OVERRIDE
Default value: historian.factry.local
Description: Only need to change this if using a different certificate.
COMPRESSION_LEVEL
Default value: -1
Description: The compression level GRPC uses, for default compression. 1-9: 1 = fastest, 9 = most compressed, -1 = default.
GRPC_MAX_MESSAGE_SIZE
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.
TICKER_INTERVAL
Default value: 1000
Description: The interval for the base ticker in milliseconds.
TICKER_RESOLUTION
Default value: 25
Description: The resolution for the base ticker in milliseconds. Maximum 1/10th of the the interval.
TICKER_MAX_DRIFT
Default value: 125
Description: The maximum drift a tick may have in milliseconds. Must be lower than the interval.
Other
ALTERNATIVE_TIMEZONE
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.
HA_POLLING_INTERVAL
Default value: 1000
Description: The interval in milliseconds at which the backup collector polls the main collector’s health.