...
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.
...
The minNumberOfValuesCheck, minNonMissingValuesCheck, minReliableOrDoubtfulValuesCheck and minReliableValuesCheck all consist of the following elements:
- id: Identifier of the check. This is only used in log messages and exception messages.
- timeSeries: One or more time series that need to be checked. This can be either an embedded time series timeSeriesSet or a reference to a time series defined at the start of the configuration file. If this 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 the module instance runs. The start and end of the period are included. This period overrules any relativeViewPeriods specified in the timeSeriesSets of the time series.
- minNumberOfValues: The minimum required number of values in the time series to pass the check.
- logLevel: Log level for the log message that is logged if a time series does not pass the check. Can be DEBUG, INFO, WARN, ERROR or FATAL. 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 the 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 the check. It is possible to use the tag %HEADER% in the logMessage. The %HEADER% tag will be replaced with the header of the time series.
...