633 lines
36 KiB
HTML
633 lines
36 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>slarchive — SeisComP Release documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=72bcf2f2" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/seiscomp.css?v=c6da7ce6" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
|
||
<script type="text/javascript" src="../_static/seiscomp.js"></script>
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
|
||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="slinktool" href="slinktool.html" />
|
||
<link rel="prev" title="seedlink" href="seedlink.html" />
|
||
</head>
|
||
<body>
|
||
<div class="header">
|
||
<div class="container">
|
||
<div class="brand">
|
||
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
|
||
<!-- span class="title">SeisComP Release</span -->
|
||
<span class="version">6.9.0</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="nav">
|
||
<div class="container">
|
||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<ul>
|
||
<li class="right">
|
||
<a href="../genindex.html" title="General Index"
|
||
accesskey="I">
|
||
index
|
||
</a>
|
||
</li>
|
||
<li class="right">
|
||
<a href="slinktool.html" title="slinktool"
|
||
accesskey="N">
|
||
next
|
||
</a>
|
||
</li>
|
||
<li class="right">
|
||
<a href="seedlink.html" title="seedlink"
|
||
accesskey="P">
|
||
previous
|
||
</a>
|
||
</li>
|
||
<li class="nav-item nav-item-0">
|
||
<a href="../index.html">Home</a>
|
||
</li>
|
||
<li class="nav-item nav-item-1">
|
||
<a href="../modules.html" >Modules</a>
|
||
</li>
|
||
<li class="nav-item nav-item-2">
|
||
<a href="../toc/acquisition.html" accesskey="U">Acquisition</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="container">
|
||
<div class="fitted content" id="anchors-container">
|
||
<div class="body" role="main">
|
||
|
||
<section id="slarchive">
|
||
<span id="id1"></span><h1>slarchive<a class="headerlink" href="#slarchive" title="Permalink to this heading">¶</a></h1>
|
||
<p><strong>SeedLink client for data stream archiving</strong></p>
|
||
<section id="description">
|
||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
|
||
<p>slarchive connects to a SeedLink server, requests data streams and writes received
|
||
packets into directory/file structures (archives). The precise layout
|
||
of the directories and files is defined in a format string.</p>
|
||
<p>The implemented layouts are:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#slarchive-section-sds"><span class="std std-ref">SDS</span></a>: The SeisComP Data Structure, default in <cite>SeisComP</cite></p></li>
|
||
<li><p>BUD: Buffer of Uniform Data structure</p></li>
|
||
<li><p>DLOG: The old SeisComP/datalog structure for backwards compatibility</p></li>
|
||
</ul>
|
||
<p>The duration for which the data are kept in archive is controlled by the bindings
|
||
parameter <a class="reference internal" href="#confval-keep"><code class="xref std std-confval docutils literal notranslate"><span class="pre">keep</span></code></a>. slarchive itself does not clean the archive. For removing
|
||
old data execute <code class="file docutils literal notranslate"><span class="pre">$SEISCOMP_ROOT/var/lib/slarchive/purge_datafiles</span></code>. A
|
||
regular clean-up is suggested by</p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>seiscomp print crontab
|
||
</pre></div>
|
||
</div>
|
||
<p>The resulting line, e.g.</p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>20 3 <span class="ge">* *</span> * /home/sysop/seiscomp/var/lib/slarchive/purge_datafiles >/dev/null 2>&1
|
||
</pre></div>
|
||
</div>
|
||
<p>can be adjusted and added to crontab.</p>
|
||
</section>
|
||
<section id="background-execution">
|
||
<h2>Background Execution<a class="headerlink" href="#background-execution" title="Permalink to this heading">¶</a></h2>
|
||
<p>When starting slarchive in <cite>SeisComP</cite> as a daemon module in the background SDS is
|
||
considered and the packets are written without modification:</p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>$ seiscomp start slarchive
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="command-line-execution">
|
||
<h2>Command-Line Execution<a class="headerlink" href="#command-line-execution" title="Permalink to this heading">¶</a></h2>
|
||
<p>Writing to <strong>other layouts</strong> or to <strong>multiple archives</strong> and other options are
|
||
supported when executing slarchive on the command line.
|
||
E.g. to write to more than one archive simply specify multiple format definitions
|
||
(or presets).</p>
|
||
<p>For more command-line option read the help:</p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>$ slarchive -h
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="multiple-instances">
|
||
<h2>Multiple Instances<a class="headerlink" href="#multiple-instances" title="Permalink to this heading">¶</a></h2>
|
||
<p>slarchive allows generating aliases, e.g. for running in multiple instances with
|
||
different module and bindings configurations. For creating/removing aliases use the
|
||
<a class="reference internal" href="../base/management.html#sec-management-commands"><span class="std std-ref">seiscomp script</span></a>, e.g.</p>
|
||
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>$ seiscomp alias create slarchive2 slarchive
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="sds-definition">
|
||
<span id="slarchive-section-sds"></span><h2>SDS definition<a class="headerlink" href="#sds-definition" title="Permalink to this heading">¶</a></h2>
|
||
<p>SDS is the basic directory and file layout in <cite>SeisComP</cite> for waveform archives. The
|
||
archive base directory is defined by <a class="reference internal" href="#confval-archive"><code class="xref std std-confval docutils literal notranslate"><span class="pre">archive</span></code></a>. The SDS layout is defined
|
||
as:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><SDSdir>
|
||
<span class="w"> </span>+<span class="w"> </span>year
|
||
<span class="w"> </span>+<span class="w"> </span>network<span class="w"> </span>code
|
||
<span class="w"> </span>+<span class="w"> </span>station<span class="w"> </span>code
|
||
<span class="w"> </span>+<span class="w"> </span>channel<span class="w"> </span>code
|
||
<span class="w"> </span>+<span class="w"> </span>one<span class="w"> </span>file<span class="w"> </span>per<span class="w"> </span>day<span class="w"> </span>and<span class="w"> </span>location,<span class="w"> </span>e.g.<span class="w"> </span>NET.STA.LOC.CHAN.D.YEAR.DOY
|
||
</pre></div>
|
||
</div>
|
||
<p>File example: <code class="file docutils literal notranslate"><span class="pre"><SDSdir>/Year/NET/STA/CHAN.TYPE/NET.STA.LOC.CHAN.TYPE.YEAR.DAY</span></code>.</p>
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Field</p></th>
|
||
<th class="head"><p>Description</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>SDSdir</p></td>
|
||
<td><p>Arbitrary base directory</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>YEAR</p></td>
|
||
<td><p>4 digit YEAR</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>NET</p></td>
|
||
<td><p>Network code/identifier, 1-8 characters,
|
||
no spaces</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>STA</p></td>
|
||
<td><p>Station code/identifier, 1-8 characters,
|
||
no spaces</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>CHAN</p></td>
|
||
<td><p>Channel code/identifier, 1-8 characters,
|
||
no spaces</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>TYPE</p></td>
|
||
<td><p>1 character, indicating the data type,
|
||
provided types are:</p>
|
||
<div class="line-block">
|
||
<div class="line"><strong>D</strong> Waveform data</div>
|
||
<div class="line"><strong>E</strong> Detection data</div>
|
||
<div class="line"><strong>L</strong> Log data</div>
|
||
<div class="line"><strong>T</strong> Timing data</div>
|
||
<div class="line"><strong>C</strong> Calibration data</div>
|
||
<div class="line"><strong>R</strong> Response data</div>
|
||
<div class="line"><strong>O</strong> Opaque data</div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>LOC</p></td>
|
||
<td><p>Location identifier, 1-8 characters,
|
||
no spaces</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>DAY</p></td>
|
||
<td><p>3 digit day of year, padded with zeros</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<section id="module-configuration">
|
||
<span id="slarchive-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this heading">¶</a></h2>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>slarchive is a <a class="reference internal" href="../base/glossary.html#term-standalone-module"><span class="xref std std-term">standalone module</span></a> and does not inherit <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
||
</div>
|
||
<div class="line-block">
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/slarchive.cfg</span></code></div>
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/slarchive.cfg</span></code></div>
|
||
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/slarchive.cfg</span></code></div>
|
||
</div>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-address">
|
||
<span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#confval-address" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Host of the Seedlink server to connect to. If the acquisition
|
||
is running on one system nothing needs to be changed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-port">
|
||
<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#confval-port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">18000</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>The port of the Seedlink server to connect to. If the acquisition
|
||
is running on one system this port must match the configured
|
||
local Seedlink port.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-archive">
|
||
<span class="sig-name descname"><span class="pre">archive</span></span><a class="headerlink" href="#confval-archive" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">var/lib/archive</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Path to waveform archive where all data is stored. Relative paths
|
||
(as the default) are treated relative to the installation
|
||
directory ($SEISCOMP_ROOT).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-buffer">
|
||
<span class="sig-name descname"><span class="pre">buffer</span></span><a class="headerlink" href="#confval-buffer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">1000</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Number of records (512 byte units) to buffer before flushing to
|
||
disk.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-delay">
|
||
<span class="sig-name descname"><span class="pre">delay</span></span><a class="headerlink" href="#confval-delay" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>The network reconnect delay (in seconds) for the connection
|
||
to the SeedLink server. If the connection breaks for any
|
||
reason this will govern how soon a reconnection should be
|
||
attempted. The default value is 30 seconds.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-networkTimeout">
|
||
<span class="sig-name descname"><span class="pre">networkTimeout</span></span><a class="headerlink" href="#confval-networkTimeout" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">900</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>The network timeout (in seconds) for the connection to the
|
||
SeedLink server. If no data [or keep alive packets?] are received
|
||
in this time range the connection is closed and re-established
|
||
(after the reconnect delay has expired). The default value is
|
||
600 seconds. A value of 0 disables the timeout.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-idleTimeout">
|
||
<span class="sig-name descname"><span class="pre">idleTimeout</span></span><a class="headerlink" href="#confval-idleTimeout" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">300</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Timeout for closing idle data stream files in seconds. The idle
|
||
time of the data streams is only checked when some packets has
|
||
arrived. If no packets arrived no idle stream files will be
|
||
closed. There is no reason to change this parameter except for
|
||
the unusual cases where the process is running against an open
|
||
file number limit. Default is 300 seconds.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-keepalive">
|
||
<span class="sig-name descname"><span class="pre">keepalive</span></span><a class="headerlink" href="#confval-keepalive" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">0</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Unit: <em>s</em></p>
|
||
<p>Interval (in seconds) at which keepalive (heartbeat) packets
|
||
are sent to the server. Keepalive packets are only sent if
|
||
nothing is received within the interval. This requires a
|
||
Seedlink version >= 3.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-validation.certs">
|
||
<span class="sig-name descname"><span class="pre">validation.certs</span></span><a class="headerlink" href="#confval-validation.certs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">var/lib/certs</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Path to cerificate store where all certificates and CRLs are stored. Relative
|
||
paths(as the default) are treated relative to the installation
|
||
directory ($SEISCOMP_ROOT).
|
||
If the signature check is enabled slarchive loads all files at start. The store
|
||
uses the OpenSSl store format. From the offical OpenSSL documentation:
|
||
"The directory should contain one certificate or CRL per file in PEM format,
|
||
with a file name of the form hash.N for a certificate, or hash.rN for a CRL.
|
||
The .N or .rN suffix is a sequence number that starts at zero, and is incremented
|
||
consecutively for each certificate or CRL with the same hash value. Gaps in the
|
||
sequence numbers are not supported, it is assumed that there are no more objects
|
||
with the same hash beyond the first missing number in the sequence.The .N or .rN suffix
|
||
is a sequence number that starts at zero, and is incremented consecutively for
|
||
each certificate or CRL with the same hash value. Gaps in the sequence numbers
|
||
are not supported, it is assumed that there are no more objects with the same
|
||
hash beyond the first missing number in the sequence."
|
||
The hash value can be obtained as follows:</p>
|
||
<p>openssl x509 -hash -noout -in <file></p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-validation.mode">
|
||
<span class="sig-name descname"><span class="pre">validation.mode</span></span><a class="headerlink" href="#confval-validation.mode" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">ignore</span></code></p>
|
||
<p>Type: <em>string</em></p>
|
||
<p>Signatures are expected to be carried in blockette 2000
|
||
as opaque data. Modes:</p>
|
||
<p>ignore : Signatures will be ignored and no further actions
|
||
will be taken.
|
||
warning: Signatures will be checked and all received records
|
||
which do not carry a valid signature or no signature
|
||
at all will be logged with at warning level.
|
||
skip : All received records without a valid signature
|
||
will be ignored and will not be processed.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="bindings-parameters">
|
||
<h2>Bindings Parameters<a class="headerlink" href="#bindings-parameters" title="Permalink to this heading">¶</a></h2>
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-selectors">
|
||
<span class="sig-name descname"><span class="pre">selectors</span></span><a class="headerlink" href="#confval-selectors" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type: <em>list:string</em></p>
|
||
<p>List of stream selectors. If left empty all available
|
||
streams will be requested. See slarchive manpage for
|
||
more information.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std confval">
|
||
<dt class="sig sig-object std" id="confval-keep">
|
||
<span class="sig-name descname"><span class="pre">keep</span></span><a class="headerlink" href="#confval-keep" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">30</span></code></p>
|
||
<p>Type: <em>int</em></p>
|
||
<p>Unit: <em>day</em></p>
|
||
<p>Number of days the data is kept in the archive. This
|
||
requires purge_datafile to be run as cronjob.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="command-line-options">
|
||
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this heading">¶</a></h2>
|
||
<p><strong class="program">slarchive [OPTION]... [host][:][port]</strong></p>
|
||
<p>Address ([host][:][port]) is a required argument. It specifies the address
|
||
of the SeedLink server in host:port format. Either the host, port or both
|
||
can be omitted. If host is omitted then localhost is assumed,
|
||
i.e. ‘:18000’ implies ‘localhost:18000’. If the port is omitted
|
||
then 18000 is assumed, i.e. ‘localhost’ implies ‘localhost:18000’.
|
||
If only ‘:’ is specified ‘localhost:18000’ is assumed.</p>
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-V">
|
||
<span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-V" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Print program version and exit.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-h">
|
||
<span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-h" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Print program usage and exit.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-v">
|
||
<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-v" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Be more verbose. This flag can be used multiple times ("-v -v" or "-vv")
|
||
for more verbosity. One flag: report basic handshaking (link configuration) details and
|
||
briefly report each packet received. Two flags: report the details of the handshaking,
|
||
each packet received and detailed connection diagnostics.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-p">
|
||
<span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-p" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Print details of received Mini-SEED data records. This flag can be used multiple times
|
||
("-p -p" or "-pp") for more detail. One flag: a single summary line
|
||
for each data packet received. Two flags: details of the Mini-SEED data records received,
|
||
including information from fixed header and 100/1000/1001 blockettes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-nd">
|
||
<span class="sig-name descname"><span class="pre">-nd</span></span><span class="sig-prename descclassname"> <span class="pre">delay</span></span><a class="headerlink" href="#cmdoption-slarchive-nd" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The network reconnect delay (in seconds) for the connection to the SeedLink server.
|
||
If the connection breaks for any reason this will govern how soon a reconnection should
|
||
be attempted. The default value is 30 seconds.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-nt">
|
||
<span class="sig-name descname"><span class="pre">-nt</span></span><span class="sig-prename descclassname"> <span class="pre">timeout</span></span><a class="headerlink" href="#cmdoption-slarchive-nt" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The network timeout (in seconds) for the connection to the SeedLink server. If no data
|
||
[or keep alive packets?] are received in this time range the connection is closed and
|
||
re-established (after the reconnect delay has expired). The default value is 600 seconds.
|
||
A value of 0 disables the timeout.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-k">
|
||
<span class="sig-name descname"><span class="pre">-k</span></span><span class="sig-prename descclassname"> <span class="pre">keepalive</span></span><a class="headerlink" href="#cmdoption-slarchive-k" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Interval (in seconds) at which keepalive (heartbeat) packets are sent to the server.
|
||
Keepalive packets are only sent if nothing is received within the interval. Requires SeedLink
|
||
version >= 3.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-x">
|
||
<span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"> <span class="pre">statefile[:interval]</span></span><a class="headerlink" href="#cmdoption-slarchive-x" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>During client shutdown the last received sequence numbers and time stamps (start times)
|
||
for each data stream will be saved in this file. If this file exists upon startup the information
|
||
will be used to resume the data streams from the point at which they were stopped. In this way the
|
||
client can be stopped and started without data loss, assuming the data are still available on the
|
||
server. If an interval is specified the state will be saved every interval in that packets are
|
||
received. Otherwise the state will be saved only on normal program termination.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-i">
|
||
<span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"> <span class="pre">timeout</span></span><a class="headerlink" href="#cmdoption-slarchive-i" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Timeout for closing idle data stream files in seconds. The idle time of the data streams is
|
||
only checked when some packets has arrived. If no packets arrived no idle stream files will be
|
||
closed. There is no reason to change this parameter except for the unusual cases where the
|
||
process is running against an open file number limit. Default is 300 seconds.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-d">
|
||
<span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-d" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configure the connection in "dial-up" mode. The remote server will close the connection when
|
||
it has sent all of the data in its buffers for the selected data streams. This is opposed to
|
||
the normal behavior of waiting indefinitely for data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-b">
|
||
<span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-b" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configure the connection in "batch" mode.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-Fi-overlap">
|
||
<span class="sig-name descname"><span class="pre">-Fi[:overlap]</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-Fi-overlap" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Future check initially. Check the last Mini-SEED data record in an existing archive file
|
||
and do not write new data to that file if it is older than a certain overlap. The default
|
||
overlap limit is 2 seconds; the overlap can be specified by appending a colon and the desired
|
||
overlap limit in seconds to the option. If the overlap is exceeded an error message will be
|
||
logged once for each time the file is opened. This option makes sense only for archive formats
|
||
where each unique data stream is written to a unique file (e.g. SDS format). If a data stream
|
||
is closed due to timeout (see option -i) the initial future check will be preformed when the
|
||
file is re-opened.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-Fc-overlap">
|
||
<span class="sig-name descname"><span class="pre">-Fc[:overlap]</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-slarchive-Fc-overlap" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Future check continuously. Available only for archive Mini-SEED data records. Check if the
|
||
first sample of the record is older than the last sample of the previous record for a given
|
||
archive file, within a certain overlap. The default overlap limit is 2 seconds; the overlap
|
||
can be specified by appending a colon and the desired overlap limit in seconds to the option.
|
||
If the overlap is exceeded an error message will be logged once until either a non-overlapping
|
||
packet is received or a new archive file is used. This option only makes sense for archive
|
||
formats where each unique data stream is written to a unique file (e.g. SDS format).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-A">
|
||
<span class="sig-name descname"><span class="pre">-A</span></span><span class="sig-prename descclassname"> <span class="pre">format</span></span><a class="headerlink" href="#cmdoption-slarchive-A" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If specified, all received packets (Mini-SEED records) will be appended to a directory/file
|
||
structure defined by format. All directories implied in the format string will be created if
|
||
necessary. The option may be used multiple times to write received packets to multiple archives.
|
||
See the section "archiving data".</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-SDS">
|
||
<span class="sig-name descname"><span class="pre">-SDS</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-slarchive-SDS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If specified, all received packets (Mini-SEED records) will be saved into a Simple Data
|
||
Structure (SDS) dir/file structure starting at the specified directory. This directory and
|
||
all subdirectories will be created if necessary. This option is a preset of the ‘-A’ option.
|
||
The SDS dir/file structure is:</p>
|
||
<p><SDSdir>/<YEAR>/<NET>/<STA>/<CHAN.TYPE>/NET.STA.LOC.CHAN.TYPE.YEAR.DAY</p>
|
||
<p>Details are mentioned later on.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-BUD">
|
||
<span class="sig-name descname"><span class="pre">-BUD</span></span><span class="sig-prename descclassname"> <span class="pre">path</span></span><a class="headerlink" href="#cmdoption-slarchive-BUD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If specified, all received waveform data packets (Mini-SEED data records) will be saved into
|
||
a Buffer of Uniform Data (BUD) dir/file structure starting at the specified directory.
|
||
This directory and all subdirectories will be created if necessary. This option is a preset
|
||
of the ‘-A’ option. The BUD dir/file structure is:</p>
|
||
<p><BUDdir>/<NET>/<STA>/STA.NET.LOC.CHAN.YEAR.DAY</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-DLOG">
|
||
<span class="sig-name descname"><span class="pre">-DLOG</span></span><span class="sig-prename descclassname"> <span class="pre">DLOGdir</span></span><a class="headerlink" href="#cmdoption-slarchive-DLOG" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If specified, all received packets (Mini-SEED data records) will be saved into an old style
|
||
SeisComP/datalog dir/file structure starting at the specified directory. This directory and
|
||
all subdirectories will be created if necessary. This option is a preset of the ‘-A’ option.
|
||
The DLOG dir/file structure is:</p>
|
||
<p><DLOGdir>/<STA>/[LOC.]<CHAN>.<TYPE>/STA.NET.CHAN.TYPE.YEAR.DAY.HHMM</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-l">
|
||
<span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"> <span class="pre">streamfile</span></span><a class="headerlink" href="#cmdoption-slarchive-l" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The given file contains a list of streams. This option implies multi-station mode.
|
||
The format of the stream list file is given below in the section "stream list file".</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-s">
|
||
<span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"> <span class="pre">selectors</span></span><a class="headerlink" href="#cmdoption-slarchive-s" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Defining default selectors. If no multi-station data streams are configured these selectors
|
||
will be used for uni-station mode. Otherwise these selectors will be used when no selectors
|
||
are specified for a given stream with the ‘-S’ or ‘-l’ options.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-S">
|
||
<span class="sig-name descname"><span class="pre">-S</span></span><span class="sig-prename descclassname"> <span class="pre">stream[:selectors]</span></span><a class="headerlink" href="#cmdoption-slarchive-S" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The connection will be configured in multi-station mode with optional SeedLink selectors
|
||
for each station, see examples below. Stream should be provided in NET_STA format. If no
|
||
selectors are provided for a given stream, the default selectors will be used, if defined.</p>
|
||
<p>Requires SeedLink >= 2.5.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="std option">
|
||
<dt class="sig sig-object std" id="cmdoption-slarchive-tw">
|
||
<span class="sig-name descname"><span class="pre">-tw</span></span><span class="sig-prename descclassname"> <span class="pre">start:[end]</span></span><a class="headerlink" href="#cmdoption-slarchive-tw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Specifying a time window for the data streams that is applied by the server. The format
|
||
for both times is year,month,day,hour,min,sec; for example: "2002,08,05,14,00:2002,08,05,14,15,00".
|
||
The end time is optional but the colon must be present. If no end time is specified the
|
||
server will send data indefinitely. This option will override any saved state information.</p>
|
||
<p>Warning: time windowing might be disabled on the remote server.</p>
|
||
<p>Requires SeedLink >= 3.</p>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div id="anchors-bottom"></div>
|
||
</div>
|
||
|
||
<div class="sidebar" role="navigation" aria-label="main navigation">
|
||
<div id="anchors-top"></div>
|
||
<div id="anchors" class="content">
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<div>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">slarchive</a><ul>
|
||
<li><a class="reference internal" href="#description">Description</a></li>
|
||
<li><a class="reference internal" href="#background-execution">Background Execution</a></li>
|
||
<li><a class="reference internal" href="#command-line-execution">Command-Line Execution</a></li>
|
||
<li><a class="reference internal" href="#multiple-instances">Multiple Instances</a></li>
|
||
<li><a class="reference internal" href="#sds-definition">SDS definition</a></li>
|
||
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
|
||
<li><a class="reference internal" href="#bindings-parameters">Bindings Parameters</a></li>
|
||
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="seedlink.html"
|
||
title="previous chapter">seedlink</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="slinktool.html"
|
||
title="next chapter">slinktool</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/apps/slarchive.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<div class="container">
|
||
<div class="horizontal layout content">
|
||
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
||
<img class="brand" src="../_static/brands/gempa.svg"/>
|
||
</a>
|
||
<div class="stretched align-center fitted content">
|
||
<div>
|
||
Version <b>6.9.0</b> Release
|
||
</div>
|
||
<div class="copyright">
|
||
Copyright © gempa GmbH, GFZ Potsdam.
|
||
</div>
|
||
</div>
|
||
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
||
<img class="brand" src="../_static/brands/gfz.svg"/>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html> |