rs2caps¶
Recordstream data acquisition plugin
Description¶
rs2caps uses the recordstream to feed data into caps.
Examples¶
Read the examples section to learn how to use rs2caps to input data into the CAPS server.
Configuration¶
etc/defaults/global.cfg
etc/defaults/rs2caps.cfg
etc/global.cfg
etc/rs2caps.cfg
~/.seiscomp/global.cfg
~/.seiscomp/rs2caps.cfg
rs2caps inherits global options.
Note
Modules/plugins may require a license file. The default path to license
files is @DATADIR@/licenses/
which can be overridden by global
configuration of the parameter gempa.licensePath
. Example:
gempa.licensePath = @CONFIGDIR@/licenses
-
output.address
¶ Type: string
Data output URL [[caps|capss]://][user:pass@]host[:port]. This parameter superseds the host and port parameter of previous versions and takes precedence. Default is
localhost:18003
.
-
output.host
¶ Type: string
Data output host. Deprecated: Use output.address instead. Default is
localhost
.
-
output.port
¶ Type: int
Data output port. Deprecated: Use output.address instead. Default is
18003
.
-
output.timeout
¶ Type: int
Unit: s
Timeout when sending a packet. If the timeout expires the connection will be closed and re-established. Default is
60
.
-
output.bufferSize
¶ Type: uint
Unit: bytes
Size (bytes) of the packet buffer Default is
1048576
.
-
output.backFillingBufferSize
¶ Type: int
Unit: s
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. Default is
0
.
-
output.mseed.enable
¶ Type: boolean
Enable on-the-fly MiniSeed encoding. If the encoder does not support the input type of a packet it will be forwarded. Re encoding of MiniSEED packets is not supported. Default is
false
.
-
output.mseed.encoding
¶ Type: string
MiniSEED encoding to use. (Uncompressed, Steim1 or Steim2) Default is
Steim2
.
-
streams.begin
¶ Type: string
Start time of data time window, default ‘GMT’
-
streams.end
¶ Type: string
End time of data time window
-
journal.file
¶ Type: string
File to store stream states Default is
@ROOTDIR@/var/run/rs2caps/journal
.
-
journal.flush
¶ Type: uint
Unit: s
Flush stream states to disk every n seconds Default is
10
.
-
journal.waitForAck
¶ Type: uint
Unit: s
Wait when a sync has been forced, up to n seconds Default is
60
.
-
journal.waitForLastAck
¶ Type: uint
Unit: s
Wait on shutdown to receive acknownledgement messages, up to n seconds Default is
5
.
-
journal.syncWithBindings
¶ Type: boolean
Whether to synchronize the journal file with bindings. If enabled then each time update-config is called, the bound stations will be synchronized with the current journal file. Unbound stations will be removed from the journal. Synchronizing with bindings will disable reading the inventory. Default is
false
.
-
statusLog.enable
¶ Type: boolean
Log information status information e.g. max bytes buffered Default is
false
.
-
statusLog.flush
¶ Type: uint
Flush status every n seconds to disk Default is
10
.
Bindings¶
-
selectors
¶ Type: list:string
List of stream selectors in format LOC.CHA. If left empty all available streams will be requested.
Command Line¶
Generic¶
-
-h
,
--help
¶
show help message.
-
-V
,
--version
¶
show version information
-
-D
,
--daemon
¶
Run as daemon. This means the application will fork itself and doesn’t need to be started with &.
Verbosity¶
-
--verbosity
arg
¶ Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug
-
-v
,
--v
¶
Increase verbosity level (may be repeated, eg. -vv)
-
-q
,
--quiet
¶
Quiet mode: no logging output
-
-s
,
--syslog
¶
Use syslog logging back end. The output usually goes to /var/lib/messages.
-
-l
,
--lockfile
arg
¶ Path to lock file.
-
--console
arg
¶ Send log output to stdout.
-
--debug
¶
Debug mode: –verbosity=4 –console=1
-
--trace
¶
Trace mode: –verbosity=4 –console=1 –print-component=1 –print-context=1
-
--log-file
arg
¶ Use alternative log file.
Records¶
-
--record-driver-list
¶
List all supported record stream drivers
-
-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.
-
--record-file
arg
¶ Specify a file as record source.
-
--record-type
arg
¶ Specify a type for the records being read.
Output¶
-
-a
,
--addr
arg
¶ Data output host in format host:port.
-
-b
,
--buffer-size
arg
¶ Size (bytes) of the journal buffer, if exceeded a sync of the journal is forced.
-
--backfilling
arg
¶ Buffer size in seconds for backfilling gaps.
Journal¶
-
-j
,
--journal
arg
¶ File to store stream states. Use an empty string to log to standard out.
-
-f
,
--flush
arg
¶ Flush stream states to disk every n seconds
-
--waitForAck
arg
¶ Wait when a sync has been forced, up to n seconds
-
-w
,
--waitForLastAck
arg
¶ Wait on shutdown to receive acknownledgement messages, up to n seconds