scimex

SeisComP event exchange between two systems.

Description

scimex manages the SeisComP object exchange between two or more different SeisComP systems in real time. scimex may import or export the data to one or several systems. In contrary to scimport the exchange of the SeisComP objects is event based. This means no messages will be exchanged until the exporting system has produced an event.

By default all objects (picks, amplitudes, origins, arrivals, station magnitudes, magnitudes, magnitude references) are transferred to the other system. The user can define filters at both the sender and the receiver, to limit the events for which objects are transferred. Possible filter parameters are the event location, magnitude, arrival count and agency. scimex supports two modi: import and export. In export mode scimex collects all objects relevant for an event (e.g. picks, amplitudes, origins, magnitudes) from scmaster’s message groups at the source and checks if the filter criteria match. Once the criteria are fulfilled, the whole package of objects is send to the scmaster IMPORT group of the receiving system.

At the receiving SeisComP system an instance of scimex runs in import mode. It fetches the whole event information from its own IMPORT group, checks the local filter criteria of the system and sends the collected objects to the different message groups, e.g. Pick, Amplitude, Magnitude, Location. In export mode several recipients can be defined and for each recipient individual filters can be set. To run several instances of scimex on one system, aliases have to be defined, e.g. for import:

seiscomp alias create scimex_import scimex

and for export:

seiscomp alias create scimex_export scimex

Then the configuration can be split into scimex_import.cfg and scimex_export.cfg.

Examples

For a push-type configuration, in which the exporting server must be able to connect to the messaging server on the receiving host. On the receiving host:

scimex_import.cfg

connection.username = scimexIm
connection.server = localhost

mode = IMPORT

cleanupinterval = 86400

importHosts = import1

criteria.world.longitude = -180:180
criteria.world.latitude = -90:90
criteria.world.magnitude = 1:9
criteria.world.agencyID = ""
criteria.world.arrivalcount = 15

hosts.import1.address = localhost
# The criterion "world" has been defined above
hosts.import1.criteria = world
# optional and true per default
hosts.import1.filter = false
# optional and true per default
hosts.import1.useDefinedRoutingTable = true
hosts.import1.routingtable = Pick:IMPORT,StationAmplitude:IMPORT,
                               Origin:LOCATION,Arrival:LOCATION,
                               StationMagnitude:MAGNITUDE,
                               Magnitude:MAGNITUDE,
                               StationMagnitudeContribution:MAGNITUDE,
                               OriginReference:EVENT,Event:EVENT

In this example, Pick and StationAmplitude objects are sent to the receiving system’s IMPORT group to avoid interfering with the receiving system’s picking.

On the sending system, only those events with a high enough magnitude and enough arrivals, and with the AgencyID “GFZ” are exported: scimex_export.cfg

connection.username="scimexEx"
connection.server = localhost

mode = EXPORT

cleanupinterval = 7200
exportHosts = exp1, exp2

# Match everything with magnitude above or equal 5
# and with more than 25 phases which comes from
# agency GFZ.
criteria.globalM5.latitude     = -90:90
criteria.globalM5.longitude    = -180:180
criteria.globalM5.magnitude    = 5:10
criteria.globalM5.arrivalcount = 25
criteria.globalM5.agencyID     = GFZ

# Export to a system which still runs a very old version. The
# messages need to be converted.
hosts.exp1.address = 192.168.0.3
hosts.exp1.criteria = globalM5
hosts.exp1.conversion = imexscdm0.51

hosts.exp2.address = 192.168.0.4
hosts.exp2.criteria = globalM5

Configuration

etc/defaults/global.cfg
etc/defaults/scimex.cfg
etc/global.cfg
etc/scimex.cfg
~/.seiscomp/global.cfg
~/.seiscomp/scimex.cfg

scimex inherits global options.

mode

Type: string

Mode of operation. Options are IMPORT or EXPORT.

cleanupinterval

Type: double

Unit: s

Cache lifetime for objects.

subscriptions

Type: list:string

Only used in export mode. A list of message groups to subscribe.

conversion

Type: string

Used only in import mode. It defines the source format of the messages that need to be converted. Currently the import of SeisComP datamodel version 0.51 (imexscdm0.51) is supported which was used in release Barcelona (2008).

exportHosts

Type: list:string

A list of hosts profiles to be considered for exporting. These are used in hosts.$name directives (see below) to define addresses, filter criteria, etc. applicable to each recipient.

importHosts

Type: list:string

A list of hosts profiles to be considered for importing. These are used with hosts.$name directives similarly to exportHosts.

Note

criteria.$name.* A definition of an event filter. $name is a placeholder for the name to be used.

criteria.\$name.latitude

Type: tuple:double

Pair of doubles that defines the latitude range, e.g. -90:90.

criteria.\$name.longitude

Type: tuple:double

Pair of doubles that defines the longitude range, e.g. -180:180.

criteria.\$name.magnitude

Type: tuple:double

Pair of doubles that defines the magnitude range, e.g. 3:10.

criteria.\$name.arrivalcount

Type: int

Number of minimum arrivals.

criteria.\$name.agencyID

Type: list:string

White list of AgencyIDs (the agency identifier which appears in the objects sent over the export-import link).

Note

hosts.$name.* A sink definition used for either import or export. $name is a placeholder for the name to be used.

hosts.\$name.address

Type: string

Address of a sink, as a host name with an optional port number e.g. ‘address = 192.168.1.1’ or ‘address = somewhere.com:4803’

hosts.\$name.criteria

Type: string

Defining filter criteria name for sink, e.g. criteria = world-xxl. The criteria must be defined in the criteria.* configuration lines.

hosts.\$name.filter

Type: boolean

Enables/disables filtering based on defined criteria. If set to false, all events will pass, even if one or more criteria are defined. Default is true.

hosts.\$name.conversion

Type: string

Optional target format for export.

hosts.\$name.useDefinedRoutingTable

Type: boolean

Enables/disables defined routing tables. Default is false.

hosts.\$name.routingTable

Type: list:string

Defining routing tables in the meaning of mapping objects to message groups. E.g. Pick:NULL, StationAmplitude:NULL, Origin:LOCATION, StationMagnitude: MAGNITUDE, NetworkMagnitude:MAGNITUDE, MagnitudeReference:MAGNITUDE, OriginReference:EVENT, Event:EVENT. Specifying NULL for the message group causes messages to be thrown away/dropped/discarded.

Command-line

Generic

-h, --help

show help message.

-V, --version

show version information

--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.

--plugins arg

Load given plugins.

-D, --daemon

Run as daemon. This means the application will fork itself and doesn’t need to be started with &.

--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).

--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.

--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

--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

--component arg

Limits the logging to a certain component. This option can be given more than once.

-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

--log-file arg

Use alternative log file.

Messaging

-u, --user arg

Overrides configuration parameter connection.username.

-H, --host arg

Overrides configuration parameter connection.server.

-t, --timeout arg

Overrides configuration parameter connection.timeout.

-g, --primary-group arg

Overrides configuration parameter connection.primaryGroup.

-S, --subscribe-group arg

A group to subscribe to. This option can be given more than once.

--content-type arg

Overrides configuration parameter connection.contentType.

--start-stop-msg arg

Sets sending of a start- and a stop message.

SCIMEX

--print-default-routingtable

Print the default object routing table.