Base collector

the base collector is factry's collector framework it contains all common functionality for collectors the commands for installation and upgrades the configuration retrieval logic from factry historian store and forward mechanisms filtering and compression techniques as such, this page serves as a reference for settings that are shared across all collector types it is not available for download the default values will be sufficient in most cases logging loglevel description specifies the log level, only messages with the configured log level will be visible in the system logs and sent to the historian default info log levels trace debug info higher log levels will always be sent to the historian logging (windows only) logsize description the maximum size that a single log file can grow to before it is rotated default 100 logfilemax description the number of logfiles that will be kept default 10 logfiledays description the maximum age an archived logfile may have before it is deleted default 10 windows priorityclass description the priority class for the process valid values are normal priority class, above normal priority class, high priority class, realtime priority class default above normal priority class more info https //docs microsoft com/en us/windows/win32/procthread/scheduling priorities 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 description the interval in milliseconds that the buffer processes the buffer default 250 buffermaxbatchsize description the maximum size of a batch in the buffer default 5000 buffermaxbatches description the maximum amount of batches the buffer will keep in memory default 20 bufferdiskbatches description the maximum amount of batches that will be written to a buffer file default 100 bufferminfreediskspace description the buffer wont write to more files if the minimum free disk space is reached default 2gb the limit cannot be switched off the value is a byte size such as 2gb or 500mb ; a negative value is rejected and the default of 2gb is used instead buffermaxdiskspace description the maximum disk space that the buffer files may take up default no limit default 0mb 0, the default, means no limit a negative value cannot be entered communication compressionlevel description the compression level grpc uses, for default compression 0 disables compression, 1 is fastest and the default, 9 is most compressed minimum 0 maximum 9 default 1 grpcmaxmessagesize description the maximum message size for grpc messages default 64mb grpccalltimeout description the deadline for a single grpc operation towards the historian one unary call, or one send, receive or close on a stream accepts a duration string raise it if registering a full buffermaxbatchsize batch of measurements times out default 2m 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 description the interval for the base ticker in milliseconds default 1000 tickerresolution description the resolution for the base ticker in milliseconds maximum 1/10th of the the interval default 25 tickermaxdrift description the maximum drift a tick may have in milliseconds must be lower than the interval default 125 other alternativetimezone description the timezone to reinterpret all timestamps in, including those on statistics and logs the name is taken to be a location name corresponding to a file in the iana time zone database default / sourcetimezone description strips the timezone off incoming point timestamps and reinterprets them in the configured timezone unlike alternativetimezone this applies to data points only, not to statistics and logs default empty hapollinginterval description the interval in milliseconds at which the backup collector polls the main collector’s health default 1000 allowedfutureduration description defines the maximum duration into the future from the current time (collector’s perspective) that a source timestamp is considered valid default / allowedpast description defines the earliest allowable point in time for source timestamps this can be specified either as a fixed timestamp (e g , 2023 07 01t00 00 00z ) or as a duration in the past relative to the current time (e g , 1w for 1 week ago) default / badtimestampaction description specifies the action to take when a timestamp is found to be outside the allowed ranges discard the point is discarded sendwithcurrent the point is sent with the current timestamp and badtimestampoutofrange instead default discard statusgood description a comma separated list of status strings that will be interpreted as a good status escaping is possible with a backslash terminationgraceperiod description duration that determines how long a collector will attempt to shut down cleanly before being forcefully shut down this is meant as a last resort measure to ensure collectors never hang indefinitely during shutdown default 5m compression swinging door and noise filtering swinging door compression reduces the number of points sent by only emitting points when the signal deviates from a trend line by a certain tolerance noise (deadband) filtering drops small changes in numeric signals to reduce noise and data volume these settings apply at the collector level unless overridden at the measurement level by setting either the swingingdooroverride or the noisefilteroverride value to true swingingdoorenabled description enable swinging door compression at collector level default false swingingdoortolerance description absolute tolerance emits a point when deviation from the current interpolated line is greater than or equal to this value 0 means not set ignored when swingingdoortolerancepercent is non zero and minvalue and maxvalue are set in engineering specs default 0 0 swingingdoortolerancepercent description percent tolerance of engineering specs span (maxvalue minvalue) takes precedence over `swingingdoortolerance` '0%' means not set example '5%' default value 0% swingingdoormaxtimebetweenemits description maximum time gap between emitted points this ensures occasionally samples are sent even when the signal is stable '0s' disables the limit examples '1h30m', '10s', '0s' default value 0s noisefilterenabled description enable the noise (deadband) filter at collector level default value false noisefiltertolerance description minimum absolute difference between consecutive points; smaller changes are dropped for numeric signals this is the absolute difference for booleans, strings and other datatypes any value above 0 drops a point whose value equals the last accepted value 0 means not set ignored when noisefiltertolerancepercent is non zero and minvalue and maxvalue are set in engineering specs default value 0 0 noisefiltertolerancepercent description minimum difference as a percent of engineering specs span (maxvalue minvalue) takes precedence over noisefiltertolerance numeric signals only '0%' means not set example '2 5%' default value 0% noisefiltermaxtimebetweenemits description maximum time gap between emitted points this ensures occasionally samples are sent even when the signal is stable examples '1h30m', '10s', '0s' default value 0s noisefiltermintimebetweenpoints description minimum time gap between emitted points '0s' disables the limit when both this and noisefiltermaxtimebetweenemits are set, this value has to be strictly smaller, otherwise the collector fails to apply its settings examples '1m30s', '10s', '0 5s', '0s' default value 0s 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 allow insecure default value false description allows a plaintext grpc connection to the historian server, without tls ignored when a self signed certificate is used