.. highlight:: rst .. _scqc: #### scqc #### **Derives quality control (QC) parameters from waveforms.** Description =========== scqc determines waveform quality control (QC) parameters of data streams. The output parameters are time averaged in terms of waveform quality messages. In regular intervals report messages are sent containing the short term average representation of the specific QC parameter for a given time span. Alarm messages are generated if the short term average (e.g. 90 s) of a QC parameter differs from the long term average (e.g. 3600 s) by more than a defined threshold. To avoid an excessive load, QC messages are sent distributed over time. Storing QC parameters into the database should be avoided by configuring, e.g., :confval:`plugins.default.archive.interval` as otherwise the database grows quickly. The QC parameters can be interactively observed using :ref:`scqcv` or :ref:`scmm`. Technology ========== scqc uses plugins to compute the waveform QC parameters. The plugins can be found in @DATADIR@/plugins/qc. QC parameters ============= .. _scqc-fig-times: .. figure:: media/times.png :align: center :width: 16cm Times describing the data records, e.g., for calculating :ref:`delay` or :ref:`latency`. The following QC parameters are determined: .. _scqc-availability: availability [%] **Plugin:** qcplugin_availability **Description:** Availability of data in the configured time span. .. _scqc-delay: delay [s] **Plugin:** qcplugin_delay **Description:** Time difference between arrival time of last record at the SeisComP3 system and end time of last record (see :ref:`Figure`): .. math:: delay = t_{arr1} - t_{12}. .. _scqc-gaps: gap (count [counts], interval [s], length [s]) **Plugin:** qcplugin_spike **Description:** In case of a data gap between two consecutive records this parameter delivers the gap interval time, the mean length of the gaps and the number of the gaps (count) over the configured time interval. .. _scqc-latency: latency [s] **Plugin:** qcplugin_latency **Description:** Time difference between the end times of consecutive records (see :ref:`Figure`): .. math:: latency = t_{arr2} - t_{arr1}. For constant and low delays, latency is approximately the mean record length. .. _scqc-offset: offset [counts] **Plugin:** qcplugin_offset **Description:** Average value of all samples of a record. .. _scqc-outage: outage [time string] **Plugin:** qcplugin_outage **Description:** Delivers the start and the end time of a data outage (gap). .. _scqc-overlap: overlap (count [counts], interval [s], length [s]) **Plugin:** qcplugin_overlap **Description:** In case of overlaps between two consecutive records this parameter delivers the overlaps interval time, the mean length of the overlaps and the number of the overlaps (count) over the configured time interval. .. _scqc-rms: rms [counts] **Plugin:** qcplugin_rms **Description:** Offset corrected root mean square (RMS) value of a record. .. _scqc-spike: spike (count [counts], interval [s], amplitude [counts]) **Plugin:** qcplugin_spike **Description:** In case of the occurrence of a spike in a record this parameter delivers the time interval between adjacent spikes, the mean amplitude of the spike and the number of the spikes (count) over the configured time interval. Internally a list of spikes is stored (spike time, spike amplitude); the spike finder algorithm is still preliminary. .. _scqc-timing: timing [%] **Plugin:** qcplugin_timing **Description:** miniSEED record timing quality (0 - 100 %) as written into the miniSEED records by the digitizer. .. _scqc_configuration: Configuration ============= | :file:`etc/defaults/global.cfg` | :file:`etc/defaults/scqc.cfg` | :file:`etc/global.cfg` | :file:`etc/scqc.cfg` | :file:`~/.seiscomp3/global.cfg` | :file:`~/.seiscomp3/scqc.cfg` scqc inherits :ref:`global options`. .. confval:: CreatorId Type: *string* ID of QC message creator Default is ``smi://de.gfz-potsdam/QcTool_0.3.1``. .. confval:: useConfiguredStreams Type: *boolean* Limit QC determination to processed data streams which are defined in global bindings with detecLocid and detecStream. Default is ``true``. .. confval:: use3Components Type: *boolean* If useConfiguredStreams \=\= true, then this parameter decides whether to use only the vertical component \(default\) or all three components. The 3 components are collected from the inventory according to channel orientation. If that is not possible, then the fixed components N and E will be used. Default is ``false``. .. confval:: streamMask Type: *string* If useConfiguredStreams \=\= false, then load \(from inventory\) only those streams, matching the streamMask RegEx e.g. \"\^\(NET1\|NET2\)\\.\(STA1\|STA2\|STA3\)\\.\(LOC\)\\.\(\(BH\)\|\(LH\)\|\(HH\)\)Z\$\" RegEx e.g. \"\^\(.+\)\\.\(.+\)\\.\(.\*\)\\.\(.+\)Z\$\" streamMask \= \"\^\(.+\)\\.\(.+\)\\.\(.\*\)\\.\(BHZ\)\$\" .. confval:: dbLookBack Type: *int* Unit: *days* Database look up for past entries not older than x days \(to determine the last QC parameter calculated\). Default is ``7``. .. note:: **plugins.\*** *Control parameters for individual QC plugins.* .. note:: **plugins.default.\*** *Default configuration parameters for the plugins.* *Can be overwritten by the individual plugin configurations.* .. confval:: plugins.default.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.default.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.default.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.default.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.default.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.default.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.default.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.default.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.default.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.default.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.default.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.default.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.default.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcLatency.\*** *Configuration parameters for the plugin qcplugin_latency. Overwrites the parameters from the default section.* .. confval:: plugins.QcLatency.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``true``. .. confval:: plugins.QcLatency.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcLatency.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcLatency.report.interval Type: *int* Unit: *s* Interval for sending report messages which, e.g., can be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcLatency.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcLatency.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcLatency.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcLatency.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcLatency.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcLatency.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcLatency.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcLatency.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcLatency.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcDelay.\*** *Configuration parameters for the plugin qcplugin_delay. Overwrites the parameters from the default section.* .. confval:: plugins.QcDelay.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to processd data AND realtime data streams. Default is ``true``. .. confval:: plugins.QcDelay.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcDelay.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcDelay.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcDelay.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcDelay.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcDelay.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcDelay.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcDelay.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcDelay.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcDelay.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcDelay.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcDelay.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcGap.\*** *Configuration parameters for the plugin qcplugin_gap. Overwrites the parameters from the default section.* .. confval:: plugins.QcGap.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcGap.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcGap.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcGap.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcGap.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcGap.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcGap.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcGap.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcGap.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcGap.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcGap.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcGap.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcGap.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcOffset.\*** *Configuration parameters for the plugin qcplugin_offset. Overwrites the parameters from the default section.* .. confval:: plugins.QcOffset.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcOffset.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcOffset.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcOffset.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcOffset.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcOffset.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcOffset.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcOffset.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcOffset.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcOffset.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcOffset.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcOffset.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcOffset.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcOverlap.\*** *Configuration parameters for the plugin qcplugin_overlap. Overwrites the parameters from the default section.* .. confval:: plugins.QcOverlap.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcOverlap.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcOverlap.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcOverlap.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcOverlap.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcOverlap.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcOverlap.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcOverlap.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcOverlap.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcOverlap.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcOverlap.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcOverlap.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcOverlap.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcRms.\*** *Configuration parameters for the plugin qcplugin_rms. Overwrites the parameters from the default section.* .. confval:: plugins.QcRms.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcRms.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcRms.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcRms.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcRms.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcRms.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcRms.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcRms.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcRms.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcRms.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcRms.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcRms.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcRms.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcSpike.\*** *Configuration parameters for the plugin qcplugin_spike. Overwrites the parameters from the default section.* .. confval:: plugins.QcSpike.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcSpike.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcSpike.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcSpike.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcSpike.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcSpike.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcSpike.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcSpike.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcSpike.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcSpike.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcSpike.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcSpike.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcSpike.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcTiming.\*** *Configuration parameters for the plugin qcplugin_timing. Overwrites the parameters from the default section.* .. confval:: plugins.QcTiming.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcTiming.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcTiming.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcTiming.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcTiming.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcTiming.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcTiming.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcTiming.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcTiming.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcTiming.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcTiming.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcTiming.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcTiming.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcAvailability.\*** *Configuration parameters for the plugin qcplugin_availability. Overwrites the parameters from the default section.* .. confval:: plugins.QcAvailability.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcAvailability.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. note:: **plugins.QcAvailability.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcAvailability.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcAvailability.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcAvailability.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcAvailability.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcAvailability.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcAvailability.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcAvailability.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcAvailability.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcAvailability.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcAvailability.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. .. note:: **plugins.QcOutage.\*** *Configuration parameters for the plugin qcplugin_outage. Overwrites the parameters from the default section.* .. confval:: plugins.QcOutage.realTimeOnly Type: *boolean* Enable to use this plugin only for realtime processing. Default [disable]: plugin is able to process archived data AND realtime data streams. Default is ``false``. .. confval:: plugins.QcOutage.buffer Type: *int* Unit: *s* Qc\-Buffer Length [s] \(aka LTA\-Buffer\). Must be >\= plugins.\*.bufferLength. Default is ``4000``. .. confval:: plugins.QcOutage.notifyDB Type: *int* Unit: *s* If there is a gap of more than notifyDB [s], write an OUTAGE entry into the database. Default is ``1800``. .. note:: **plugins.QcOutage.report.\*** *Control interactions with the messaging system.* .. confval:: plugins.QcOutage.report.interval Type: *int* Unit: *s* Interval for sending report messages which e.g. will be may be displayed by scqcv. Default is ``60``. .. confval:: plugins.QcOutage.report.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``600``. .. confval:: plugins.QcOutage.report.timeout Type: *int* Unit: *s* Report messages are generated in case no data is received since timeout. Only in real\-time processing. Default is ``0``. .. note:: **plugins.QcOutage.archive.\*** *Control sending QC reports as notifier to the messaging where* *scmaster will write them to the database.* .. confval:: plugins.QcOutage.archive.interval Type: *int* Unit: *s* Interval to send the QC reports. Default [\-1]: Do not send any QC report. This will prevent writing QC reports into the database. Default is ``-1``. .. confval:: plugins.QcOutage.archive.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``3600``. .. note:: **plugins.QcOutage.alert.\*** *Control for sending alerts based on QC reports.* .. confval:: plugins.QcOutage.alert.interval Type: *int* Unit: *s* Interval for checking and sending alert thresholds. \-1 disables threshold checking. Default is ``-1``. .. confval:: plugins.QcOutage.alert.buffer Type: *int* Unit: *s* Time window for calculating QC reports. Default is ``1800``. .. confval:: plugins.QcOutage.alert.thresholds Type: *int* List of thresholds for sending QC reports. Use comma to separate values. Default is ``150``. Command-line ============ .. program:: scqc Generic ------- .. option:: -h, --help show help message. .. option:: -V, --version show version information .. option:: --config-file arg Use alternative configuration file. When this option is used the loading of all stages is disabled. Only the given configuration file is parsed and used. To use another name for the configuration create a symbolic link of the application or copy it, eg scautopick \-> scautopick2. .. option:: --plugins arg Load given plugins. .. option:: -D, --daemon Run as daemon. This means the application will fork itself and doesn't need to be started with \&. .. option:: --auto-shutdown arg Enable\/disable self\-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message \(enabled with \-\-start\-stop\-msg for the master module\). .. option:: --shutdown-master-module arg Sets the name of the master\-module used for auto\-shutdown. This is the application name of the module actually started. If symlinks are used then it is the name of the symlinked application. .. option:: --shutdown-master-username arg Sets the name of the master\-username of the messaging used for auto\-shutdown. If \"shutdown\-master\-module\" is given as well this parameter is ignored. Verbosity --------- .. option:: --verbosity arg Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug .. option:: -v, --v Increase verbosity level \(may be repeated, eg. \-vv\) .. option:: -q, --quiet Quiet mode: no logging output .. option:: --component arg Limits the logging to a certain component. This option can be given more than once. .. option:: -s, --syslog Use syslog logging back end. The output usually goes to \/var\/lib\/messages. .. option:: -l, --lockfile arg Path to lock file. .. option:: --console arg Send log output to stdout. .. option:: --debug Debug mode: \-\-verbosity\=4 \-\-console\=1 .. option:: --log-file arg Use alternative log file. Messaging --------- .. option:: -u, --user arg Overrides configuration parameter :confval:`connection.username`. .. option:: -H, --host arg Overrides configuration parameter :confval:`connection.server`. .. option:: -t, --timeout arg Overrides configuration parameter :confval:`connection.timeout`. .. option:: -g, --primary-group arg Overrides configuration parameter :confval:`connection.primaryGroup`. .. option:: -S, --subscribe-group arg A group to subscribe to. This option can be given more than once. .. option:: --encoding arg Overrides configuration parameter :confval:`connection.encoding`. .. option:: --start-stop-msg arg Sets sending of a start\- and a stop message. Database -------- .. option:: --db-driver-list List all supported database drivers. .. option:: -d, --database arg The database connection string, format: service:\/\/user:pwd\@host\/database. \"service\" is the name of the database driver which can be queried with \"\-\-db\-driver\-list\". .. option:: --config-module arg The configmodule to use. .. option:: --inventory-db arg Load the inventory from the given database or file, format: [service:\/\/]location .. option:: --db-disable Do not use the database at all Records ------- .. option:: --record-driver-list List all supported record stream drivers .. option:: -I, --record-url arg The recordstream source URL, format: [service:\/\/]location[#type]. \"service\" is the name of the recordstream driver which can be queried with \"\-\-record\-driver\-list\". If \"service\" is not given \"file:\/\/\" is used. .. option:: --record-file arg Specify a file as record source. .. option:: --record-type arg Specify a type for the records being read.