You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

306 lines
14 KiB
HTML

<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8" />
<title>slmon &#8212; 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/graphviz.css" />
<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 src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Addon Modules" href="../base/addons.html" />
<link rel="prev" title="sh2proc" href="sh2proc.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">5.3.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="../base/addons.html" title="Addon Modules"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="sh2proc.html" title="sh2proc"
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/utilities.html" accesskey="U">Utilities</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<div class="fitted content" id="anchors-container">
<div class="body" role="main">
<div class="section" id="slmon">
<span id="id1"></span><h1>slmon<a class="headerlink" href="#slmon" title="Permalink to this headline"></a></h1>
<p><strong>SeedLink monitor creating web pages</strong></p>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p><em>slmon</em> collects waveform QC parameters from a configured <a class="reference internal" href="seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a> Server
and creates static HTML websites for their visualization. <a class="reference internal" href="#fig-slmon"><span class="std std-ref">Station summeries</span></a> and
<a class="reference internal" href="#fig-slmon-stat"><span class="std std-ref">per-station channels views</span></a> are available.</p>
</div>
<div class="section" id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline"></a></h2>
<ol class="arabic">
<li><p>Adjust the module configuration parameters of <em>slmon</em> to set the seedlink Server,
the output directory for the created webpages and other parameters.</p></li>
<li><p>Create and adjust binding profiles and station bindings for <em>slmon</em> to activate
the monitoring of the desired networks and stations.</p></li>
<li><p>Update the configuration of <em>slmon</em></p></li>
<li><p>Start <em>slmon</em>. This step reads the QC parameters and creates the static webpage.
The webpage is not automatically updated.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp update-config
seiscomp start slmon
</pre></div>
</div>
</li>
<li><p>Restart <em>slmon</em> in order to upate the webpage. The restart can be
performed by a the regular system check scheduled by a crontab entry.</p>
<p>The example below shows a crontab entry to update the webpage
generated by <em>slmon</em> every 3 minutes:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>*/3 * * * * /home/sysop/seiscomp/bin/seiscomp check slmon &gt;/dev/null <span class="m">2</span>&gt;<span class="p">&amp;</span><span class="m">1</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The crontab entry can be generated and added automatically
using the seiscomp script:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>seiscomp print crontab <span class="p">|</span> crontab -
</pre></div>
</div>
</div>
</li>
</ol>
<p>A comprehensive example for monitoring many stations of a large number of networks
is provided by <a class="reference external" href="http://geofon.gfz-potsdam.de/waveform/status/">GEOFON</a> at
<a class="reference external" href="http://www.gfz-potsdam.de">GFZ Potsdam</a>, Germany. A simple example of a website
create by <em>slmon</em> is given in the <a class="reference internal" href="#fig-slmon"><span class="std std-ref">figures below</span></a>.</p>
<div class="figure align-center" id="id2">
<span id="fig-slmon"></span><a class="reference internal image-reference" href="../_images/slmon.png"><img alt="../_images/slmon.png" src="../_images/slmon.png" style="width: 16cm;" /></a>
<p class="caption"><span class="caption-text">Example of a website with the station summary created by <em>slmon</em>.</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</div>
<div class="figure align-center" id="id3">
<span id="fig-slmon-stat"></span><a class="reference internal image-reference" href="../_images/slmon-stat.png"><img alt="../_images/slmon-stat.png" src="../_images/slmon-stat.png" style="width: 16cm;" /></a>
<p class="caption"><span class="caption-text">Example of a website with a per-station channel view created by <em>slmon</em>.</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</div>
</div>
<div class="section" id="module-configuration">
<span id="slmon-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>slmon 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/slmon.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/slmon.cfg</span></code></div>
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/slmon.cfg</span></code></div>
</div>
<dl class="confval">
<dt id="confval-title">
<code class="sig-name descname">title</code><a class="headerlink" href="#confval-title" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&quot;SeedLink</span> <span class="pre">Monitor&quot;</span></code></p>
<p>Type: <em>string</em></p>
<p>Title of the web page used as heading.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-refresh">
<code class="sig-name descname">refresh</code><a class="headerlink" href="#confval-refresh" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">180</span></code></p>
<p>Type: <em>double</em></p>
<p>Unit: <em>s</em></p>
<p>Refresh interval of the generated web page used by the browser.
The interval should be similar to the interval for starting slmon.
If empty, the web page must be manually refreshed from within
the browser.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-address">
<code class="sig-name descname">address</code><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="confval">
<dt id="confval-port">
<code class="sig-name descname">port</code><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="confval">
<dt id="confval-email">
<code class="sig-name descname">email</code><a class="headerlink" href="#confval-email" title="Permalink to this definition"></a></dt>
<dd><p>Type: <em>string</em></p>
<p>e-mail address added to web pages.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-wwwdir">
<code class="sig-name descname">wwwdir</code><a class="headerlink" href="#confval-wwwdir" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">&#64;ROOTDIR&#64;/var/run/&#64;NAME&#64;</span></code></p>
<p>Type: <em>string</em></p>
<p>Output directory of the web pages.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-icon">
<code class="sig-name descname">icon</code><a class="headerlink" href="#confval-icon" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">http://www.gfz-potsdam.de/favicon.ico</span></code></p>
<p>Type: <em>string</em></p>
<p>Favicon URL of the web pages. Not mandatory.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-linkname">
<code class="sig-name descname">linkname</code><a class="headerlink" href="#confval-linkname" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">GEOFON</span></code></p>
<p>Type: <em>string</em></p>
<p>Name of Link shown in footer of web pages.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-linkurl">
<code class="sig-name descname">linkurl</code><a class="headerlink" href="#confval-linkurl" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">http://www.gfz-potsdam.de/geofon/</span></code></p>
<p>Type: <em>string</em></p>
<p>URL referred to by linkname in footer of web pages.</p>
</dd></dl>
<dl class="confval">
<dt id="confval-liveurl">
<code class="sig-name descname">liveurl</code><a class="headerlink" href="#confval-liveurl" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">http://geofon.gfz-potsdam.de/waveform/liveseis.php?station=%s</span></code></p>
<p>Type: <em>string</em></p>
<p>URL to live seismograms. %s will be replaced by station name.
Not mandatory.</p>
</dd></dl>
</div>
<div class="section" id="bindings-parameters">
<h2>Bindings Parameters<a class="headerlink" href="#bindings-parameters" title="Permalink to this headline"></a></h2>
<dl class="confval">
<dt id="confval-group">
<code class="sig-name descname">group</code><a class="headerlink" href="#confval-group" title="Permalink to this definition"></a></dt>
<dd><p>Default: <code class="docutils literal notranslate"><span class="pre">local</span></code></p>
<p>Type: <em>string</em></p>
<p>Defines the group of the station that is monitored.</p>
</dd></dl>
</div>
</div>
<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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">slmon</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#setup">Setup</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>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="sh2proc.html"
title="previous chapter">sh2proc</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../base/addons.html"
title="next chapter">Addon Modules</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/apps/slmon.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>5.3.0</b> Release
</div>
<div class="copyright">
Copyright &copy; 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>