Files
seiscomp-training/etc/descriptions/slink2caps.xml

180 lines
6.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<seiscomp>
<module name="slink2caps" category="Acquisition">
<description>Data retrieval to CAPS using SeedLink plugins.</description>
<configuration>
<parameter name="buffer" type="path" default="@ROOTDIR@/var/lib/slink2caps/buffer.mseed">
<description>
Path to buffer file where transient packets are stored on disk during shutdown.
Transient means packets that have been received from input plugins,
e.g., chain_plugin but have not been acknowledged by CAPS. Without local storage
on disk those packets would be lost. During start the plugin
reads the buffer file and tries to send the packets again. Please keep in mind
to remove the buffer file before plugin start in case of the data
acquisition should be reset.
</description>
</parameter>
<group name="seedlink">
<description>
Data input control
</description>
<parameter name="config" type="path" default="@ROOTDIR@/var/lib/seedlink/seedlink.ini">
<description>
Path to Seedlink configuration file. Use the respective name
if seedlink runs as an alias.
</description>
</parameter>
<parameter name="name" type="string" default="seedlink">
<description>
Name of Seedlink configuration section. Use the respective name
if seedlink runs as an alias.
</description>
</parameter>
</group>
<group name="output">
<description>
Data output control
</description>
<parameter name="stdout" type="boolean" default="false">
<description>
Write miniSEED records to stdout instead of pushing them
to CAPS.
</description>
</parameter>
<parameter name="address" type="string" default="localhost:18003">
<description>
Data output URL [[caps|capss]://][user:pass@]host[:port]. This parameter
superseds the host and port parameter of previous versions and takes precedence.
</description>
</parameter>
<parameter name="host" type="string" default="localhost">
<description>
Data output host. Deprecated: Use output.address instead.
</description>
</parameter>
<parameter name="port" type="int" default="18003">
<description>
Data output port. Deprecated: Use output.address instead.
</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>
<parameter name="maxFutureEndTime" type="int" default="120" unit="s">
<description>
Maximum allowed relative end time for packets. If the packet
end time is greater than the current time plus this value,
the packet will be discarded. By default this value is set
to 120 seconds.
</description>
</parameter>
<parameter name="bufferSize" type="uint" default="131072" unit="bytes">
<description>
Size (bytes) of the packet buffer
</description>
</parameter>
<parameter name="backFillingBufferSize" type="int" default="0" unit="s">
<description>
Length of backfilling buffer. 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.
</description>
</parameter>
</group>
<group name="journal">
<parameter name="file" type="string" default="@ROOTDIR@/var/run/rs2caps/journal">
<description>
File to store stream states
</description>
</parameter>
<parameter name="flush" type="uint" default="10" unit="s">
<description>
Flush stream states to disk every n seconds
</description>
</parameter>
<parameter name="waitForAck" type="uint" default="60" unit="s">
<description>
Wait when a sync has been forced, up to n seconds
</description>
</parameter>
<parameter name="waitForLastAck" type="uint" default="5" unit="s">
<description>
Wait on shutdown to receive acknownledgement messages, up to n seconds
</description>
</parameter>
</group>
<group name="statusLog">
<parameter name="enable" type="boolean" default="false">
<description>
Log information status information e.g.
max bytes buffered
</description>
</parameter>
<parameter name="flush" type="uint" default="10">
<description>
Flush status every n seconds to disk
</description>
</parameter>
</group>
</configuration>
<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>
<option flag="f" long-flag="seedlink-config" argument="arg" default="@ROOTDIR@/var/lib/seedlink/seedlink.ini">
<description>
Path to Seedlink configuration file. Default: @ROOTDIR@/var/lib/seedlink/seedlink.ini
</description>
</option>
<option flag="n" long-flag="section-name" argument="arg" default="seedlink">
<description>
Name of Seedlink configuration section. Default: seedlink.
</description>
</option>
</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="Output">
<option flag="H" long-flag="host" argument="arg" default="localhost">
<description>Data output host. Default: localhost.</description>
</option>
<option flag="p" long-flag="port" argument="arg" default="18003">
<description>Data output port. Default: 18003.</description>
</option>
<option flag="c" long-flag="stdout">
<description>Write records to stdout.</description>
</option>
<option long-flag="max-future-endtime" argument="arg">
<description>
Maximum allowed relative end time for packets. If the packet
end time is greater than the current time plus this value,
the packet will be discarded. By default this value is set
to 120 seconds.
</description>
</option>
</group>
</command-line>
</module>
</seiscomp>