299 lines
10 KiB
XML
299 lines
10 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<seiscomp>
|
|
<module name="caps2caps" category="Acquisition">
|
|
<description>caps2caps synchronizes CAPS servers in real-time</description>
|
|
<command-line>
|
|
<group name="Generic">
|
|
<optionReference>generic#help</optionReference>
|
|
<optionReference>generic#version</optionReference>
|
|
<optionReference>generic#config-file</optionReference>
|
|
<optionReference>generic#plugins</optionReference>
|
|
<optionReference>generic#daemon</optionReference>
|
|
</group>
|
|
|
|
<group name="Verbosity">
|
|
<optionReference>verbosity#verbosity</optionReference>
|
|
<optionReference>verbosity#v</optionReference>
|
|
<optionReference>verbosity#quiet</optionReference>
|
|
<optionReference>verbosity#print-component</optionReference>
|
|
<optionReference>verbosity#print-context</optionReference>
|
|
<optionReference>verbosity#component</optionReference>
|
|
<optionReference>verbosity#syslog</optionReference>
|
|
<optionReference>verbosity#lockfile</optionReference>
|
|
<optionReference>verbosity#console</optionReference>
|
|
<optionReference>verbosity#debug</optionReference>
|
|
<optionReference>verbosity#trace</optionReference>
|
|
<optionReference>verbosity#log-file</optionReference>
|
|
</group>
|
|
|
|
<group name="Input">
|
|
<option flag="I" long-flag="input" argument="arg" param-ref="input.address">
|
|
<description>
|
|
URL of data input host. Format:
|
|
[[caps|capss]://][user:password@]host[:port] .
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="max-real-time-gap" unit="s">
|
|
<description>
|
|
Maximum length of data gap after reconnecting. If exceeded,
|
|
a real-time stream and backfilling stream will be created in
|
|
parallel. Setting this value will give highest priority to
|
|
real-time streams, e.g., for rapid response systems.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
|
|
<group name="Streams">
|
|
<option flag="i" long-flag="inventory" argument="arg">
|
|
<description>
|
|
Inventory XML defining the streams to add.
|
|
</description>
|
|
</option>
|
|
<option flag="A" long-flag="add-stream" argument="arg">
|
|
<description>
|
|
List of streamIDs [NET.STA.LOC.CHA] to add. Wildcards are
|
|
supported. Use comma-separation without blanks for multiple
|
|
IDs.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="begin" argument="arg">
|
|
<description>
|
|
Start time of data request. Applied only on streams not
|
|
found in the journal. Format: 'YYYY-MM-DD hh:mm:ss.sss'.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="end" argument="arg">
|
|
<description>
|
|
End time of data request. Format: 'YYYY-MM-DD hh:mm:ss.sss'.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="max-days" argument="arg" unit="day">
|
|
<description>
|
|
Maximum number of days to acquire regardless if the time
|
|
window is configured or read from journal. A value of 0 or
|
|
less disables the check.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="days" argument="arg" unit="day">
|
|
<description>
|
|
Begin of data request time window given as days before current time.
|
|
Applied only on streams not found in the journal.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="days-before" argument="arg" unit="day">
|
|
<description>
|
|
End of data request time window given as number of days
|
|
before current time.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
|
|
<group name="Mode">
|
|
<option flag="" long-flag="archive" argument="">
|
|
<description>
|
|
Disable real-time mode. Only archived data is fetched and
|
|
missing records are ignored.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="out-of-order" argument="">
|
|
<description>
|
|
Use to enable out-of-order mode. Allows transfering data
|
|
which is not in timely order.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
|
|
<group name="Output">
|
|
<option flag="O" long-flag="output" argument="arg" param-ref="output.address">
|
|
<description>
|
|
URL of data output host. Format:
|
|
[[caps|capss]://][user:password@]host[:port] .
|
|
</description>
|
|
</option>
|
|
<option flag="b" long-flag="buffer-size" argument="arg">
|
|
<description>
|
|
Size (bytes) of the journal buffer. If exceeded, a sync of
|
|
the journal is forced.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="mseed" argument="">
|
|
<description>
|
|
Enables Steim2 encoding for received RAW packets.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
|
|
<group name="Journal">
|
|
<option flag="j" long-flag="journal" argument="arg">
|
|
<description>
|
|
Journal file to store stream states. Use an empty string to
|
|
ignore the journal file which will transfer the data
|
|
independent of previous transfers.
|
|
</description>
|
|
</option>
|
|
<option flag="" long-flag="flush" argument="arg" unit="s">
|
|
<description>
|
|
Flush stream states to disk every given seconds.
|
|
</description>
|
|
</option>
|
|
<option long-flag="waitForAck" argument="arg" unit="s">
|
|
<description>
|
|
Wait when a sync has been forced, up to the given seconds.
|
|
</description>
|
|
</option>
|
|
<option flag="w" long-flag="waitForLastAck" argument="arg" unit="s">
|
|
<description>
|
|
Wait on shutdown to receive acknowledgment messages, up
|
|
to the given seconds.
|
|
</description>
|
|
</option>
|
|
</group>
|
|
</command-line>
|
|
<configuration>
|
|
<parameter name="streams" type="string">
|
|
<description>
|
|
Comma separated list of streams. Stream format: NET.STA.LOC.CHA.
|
|
Streams may contain wildcards
|
|
</description>
|
|
</parameter>
|
|
<parameter name="begin" type="string">
|
|
<description>
|
|
Start time of data time window, default is 'GMT'. Date time format:
|
|
[YYYY-MM-DD HH:MM:SS].
|
|
</description>
|
|
</parameter>
|
|
<parameter name="end" type="string">
|
|
<description>
|
|
End time of data time window. Date time format:
|
|
[YYYY-MM-DD HH:MM:SS].
|
|
</description>
|
|
</parameter>
|
|
<parameter name="maxDays" type="int" default="-1" unit="day">
|
|
<description>
|
|
Maximum number of days to acquire regardless if the time window
|
|
is configured or read from journal. A value of 0 or less disables
|
|
the check.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="days" type="int" default="-1" unit="day">
|
|
<description>
|
|
Use to set the start time of data time window n days before the current time.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="daysBefore" type="int" default="-1" unit="day">
|
|
<description>
|
|
Use to set the end time of data time window n days before the current time.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="timeWindowUpdateInterval" type="int" default="-1" unit="s">
|
|
<description>
|
|
Sets the interval in seconds at which the relative request
|
|
time window defined by option days and/or daysBefore is
|
|
updated.
|
|
Use a value less or equal zero to disable the update.
|
|
This feature is supported in archive mode only.
|
|
A typical use case is when data has to be transmitted
|
|
continuously with a time delay.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="maxRealTimeGap" type="int" default="-1" unit="s">
|
|
<description>
|
|
Sets the maximum real-time data gap in seconds. This means,
|
|
if the start time of the requested time window of a channel
|
|
is before this value with respect to the current system time
|
|
then the request is split into a real-time request starting
|
|
at system time - marginRealTimeGap and a backfill request
|
|
from requested start time to time - marginRealTimeGap.
|
|
That prioritizes real-time data and backfills old data in
|
|
parallel.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="marginRealTimeGap" type="int" default="60" unit="s">
|
|
<description>
|
|
The time margin used to request real-time data in combination
|
|
with maxRealTimeGap with respect to system time.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="realtime" type="boolean" default="true">
|
|
<description>
|
|
Enable real-time mode. Archived data is not fetched.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="outOfOrder" type="boolean" default="false">
|
|
<description>
|
|
Enable out of order mode. Allows transfering data
|
|
which is not in timely order.
|
|
</description>
|
|
</parameter>
|
|
<group name="input">
|
|
<description>
|
|
Configuration of data input host.
|
|
</description>
|
|
<parameter name="address" type="string">
|
|
<description>
|
|
URL. Format: [[caps|capss]://][user:pass@]host[:port] .
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name="output">
|
|
<description>
|
|
Configuration of data output host.
|
|
</description>
|
|
<parameter name="address" type="string" default="localhost:18003">
|
|
<description>
|
|
URL. Format: [[caps|capss]://][user:pass@]host[:port] .
|
|
</description>
|
|
</parameter>
|
|
<parameter name="bufferSize" type="uint" default="1048576" unit="byte">
|
|
<description>
|
|
Size of the packet buffer.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="backfillingBufferSize" type="uint" default="0" unit="s">
|
|
<description>
|
|
Length of backfilling buffer which is a tool to mitigate
|
|
out-of-order data. Whenever a gap is detected, records
|
|
will be held in a buffer and not sent out. Records are
|
|
flushed from front to back if the buffer size is
|
|
exceeded. A value of 0 disables this feature.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="mseed" type="boolean" default="false">
|
|
<description>
|
|
Enable Steim2 encoding for received RAW packets.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="timeout" type="int" default="60" unit="s">
|
|
<description>
|
|
Timeout when sending a packet. If the timeout expires,
|
|
the connection will be closed and re-established.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
<group name ="journal">
|
|
<parameter name="file" type="string" default="@ROOTDIR@/var/run/caps2caps/journal">
|
|
<description>
|
|
File to store stream states.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="flush" type="uint" default="10" unit="s">
|
|
<description>
|
|
Flush stream states to disk in the given interval.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="waitForAck" type="uint" default="60" unit="s">
|
|
<description>
|
|
Wait when a sync has been forced, up to given seconds.
|
|
</description>
|
|
</parameter>
|
|
<parameter name="waitForLastAck" type="uint" default="5" unit="s">
|
|
<description>
|
|
Wait on shutdown to receive acknownledgement messages, up to the
|
|
given seconds.
|
|
</description>
|
|
</parameter>
|
|
</group>
|
|
</configuration>
|
|
</module>
|
|
</seiscomp>
|