...
In a timeseries availability checker configuration file one or more checks can be configured. The configured checks will be performed one by one. Each check will check the configured time series one by one on the configured properties. If a time series does not pass the check, then the configured log message is logged. See below for more details about each part of the configuration.
...
Time Series Definitions
...
The configuration contains definitions of one or more time series that can be used as input for checks. Each timeSeries contains a timeSeriesId and a timeSeriesSet. The timeSeriesId can be used to reference this time series in a check. Alternatively time series definitions can be embedded in the checks.
...
Checks
...
The configuration contains one or more checks. Four different types of checks are available:
- minNumberOfValuesCheck: Checks whether there are enough values within a configured period. If not, then a log message with the configured event code and level is logged. The log event code can be used to trigger a certain action in the master controller, e.g. sending warning emails.
- minNonMissingValuesCheck: Checks whether there are enough non-missing values within a configured period. If not, then a log message with the configured event code and level is logged. The log event code can be used to trigger a certain action in the master controller, e.g. sending warning emails. A non-missing value is a value that is reliable, doubtful or unreliable.
- minReliableOrDoubtfulValuesCheck: Checks whether there are enough values that are reliable or doubtful within a configured period. If not, then a log message with the configured event code and level is logged. The log event code can be used to trigger a certain action in the master controller, e.g. sending warning emails.
- minReliableValuesCheck: Checks whether there are enough reliable values within a configured period. If not, then a log message with the configured event code and level is logged. The log event code can be used to trigger a certain action in the master controller, e.g. sending warning emails.
...
Contents of Checks
...
The minNumberOfValuesCheck, minNonMissingValuesCheck, minReliableOrDoubtfulValuesCheck and minReliableValuesCheck all consist of the following elements.
- timeSeries: One or more items that describe the data that need to be checked. If the specified data contains multiple time series (e.g. for multiple locations), then each time series is checked individually.
- checkRelativePeriod: The check will only consider data in this time period. This time period is relative to the timeZero of the taskrun in which this module instance runs. The start and end of the period are included.
- minNumberOfValues: The minimum required number of values.
- logLevel: Log level for the log message that is logged if a time series does not pass this check. If level is error or fatal, then the module will stop running after logging the first log message.
- logEventCode: Event code for the log message that is logged if a time series does not pass this check. This event code has to contain a dot, e.g. "TimeSeries.Check", because the log message is only visible to the master controller if the event code contains a dot.
- logMessage: Log message that is logged if a time series does not pass this check. It is possible to use the tag %HEADER%. The %HEADER% tag will be replaced with the header of the time series.
Configuration Example
A configuration example with four different checks configured is given below:
...