.. highlight:: rst

.. _slmon:

#####
slmon
#####

**SeedLink monitor creating web pages**


Description
===========

*slmon* collects waveform QC parameters from a configured :ref:`seedlink` Server
and creates static HTML websites for their visualization. :ref:`Station summeries<fig-slmon>` and
:ref:`per-station channels views<fig-slmon-stat>` are available.

Setup
=====

1. Adjust the module configuration parameters of *slmon* to set the seedlink Server,
   the output directory for the created webpages and other parameters.
#. Create and adjust binding profiles and station bindings for *slmon* to activate
   the monitoring of the desired networks and stations.
#. Update the configuration of *slmon*
#. Start *slmon*. This step reads the QC parameters and creates the static webpage.
   The webpage is not automatically updated.

   ..  code-block:: sh

       seiscomp update-config
       seiscomp start slmon

#. Restart *slmon* in order to upate the webpage. The restart can be
   performed by a the regular system check scheduled by a crontab entry.

   The example below shows a crontab entry to update the the webpage
   generated by *slmon* every 3 minutes:

   ..  code-block:: sh

       */3 * * * * /home/sysop/seiscomp3/bin/seiscomp check slmon >/dev/null 2>&1

A comprehensive example for monitoring many stations of a large number of networks
is provided by `GEOFON <http://geofon.gfz-potsdam.de/waveform/status/>`_ at
`GFZ Potsdam <http://www.gfz-potsdam.de>`_, Germany. A simple example of a website
create by *slmon* is given in the :ref:`figures below<fig-slmon>`.

.. _fig-slmon:

.. figure:: media/slmon.png
   :align: center
   :width: 16cm

   Example of a website with the station summary created by *slmon*.

.. _fig-slmon-stat:

.. figure:: media/slmon-stat.png
   :align: center
   :width: 16cm

   Example of a website with a per-station channel view created by *slmon*.



Configuration
=============


.. note::

   slmon is a standalone module and does not inherit :ref:`global options <global-configuration>`.


| :file:`etc/defaults/slmon.cfg`
| :file:`etc/slmon.cfg`
| :file:`~/.seiscomp3/slmon.cfg`



.. confval:: title

   Type: *string*

   Title of the web page used as heading.
   Default is ``"SeedLink Monitor"``.

.. confval:: refresh

   Type: *double*

   Unit: *s*

   Refresh interval of the generated web page. The interval should
   be similar to the interval for starting slmon. If empty, the web page
   must be refreshed manually.
   Default is ``180``.

.. confval:: address

   Type: *string*

   Host of the Seedlink server to connect to. If the acquisition
   is running on one system nothing needs to be changed.
   Default is ``127.0.0.1``.

.. confval:: port

   Type: *int*

   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.
   Default is ``18000``.

.. confval:: email

   Type: *string*

   e\-mail address added to web pages.


.. confval:: wwwdir

   Type: *string*

   Output directory of the web pages.
   Default is ``@ROOTDIR@/var/run/@NAME@``.

.. confval:: icon

   Type: *string*

   Favicon URL of the web pages. Not mandatory.
   Default is ``http://www.gfz-potsdam.de/favicon.ico``.

.. confval:: linkname

   Type: *string*

   Name of Link shown in footer of web pages.
   Default is ``GEOFON``.

.. confval:: linkurl

   Type: *string*

   URL referred to by linkname in footer of web pages.
   Default is ``http://www.gfz-potsdam.de/geofon/``.

.. confval:: liveurl

   Type: *string*

   URL to live seismograms. %s will be replaced by station name.
   Not mandatory.
   Default is ``http://geofon.gfz-potsdam.de/waveform/liveseis.php?station=%s``.


Bindings
========


Configuration
-------------


.. confval:: group

   Type: *string*

   Defines the group of the station that is monitored.
   Default is ``local``.