benjamin
/
seiscomp-training
1
0
Fork 0
Code Pull Requests Packages Projects Releases Wiki Activity
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.
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '906e9ccf6b'
${ noResults }
seiscomp-training/share/doc/seiscomp/html/base/tutorials/help.html

390 lines
24 KiB
HTML
Raw Blame History Unescape Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8" />
<title>Help! I’m stuck! Now what? &#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="Create a new tutorial" href="template.html" />
<link rel="prev" title="Play back archived waveforms" href="waveformplayback.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="template.html" title="Create a new tutorial"
accesskey="N">
next
</a>
</li>
<li class="right">
<a href="waveformplayback.html" title="Play back archived waveforms"
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="../tutorials.html" accesskey="U">Tutorials</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="help-i-m-stuck-now-what">
<span id="tutorials-help"></span><h1>Help! I’m stuck! Now what?<a class="headerlink" href="#help-i-m-stuck-now-what" title="Permalink to this headline"></a></h1>
<p>You will …</p>
<ul class="simple">
<li><p>Troubleshoot and resolve problems with SeisComP</p></li>
</ul>
<p>Pre-requisites for this tutorial:</p>
<ul class="simple">
<li><p>Have your SeisComP installation and configuration available</p></li>
</ul>
<p>Afterwards/Results/Outcomes:</p>
<ul class="simple">
<li><p>Improved understanding of ways to solve issues when operating SeisComP</p></li>
</ul>
<p>Time range estimate:</p>
<ul class="simple">
<li><p>30 minutes</p></li>
</ul>
<hr class="docutils" />
<div class="section" id="outline">
<h2>Outline<a class="headerlink" href="#outline" title="Permalink to this headline"></a></h2>
<p>Inevitably you will encounter difficulties using SeisComP.
This tutorial reviews a few ways to diagnose your problems and
get help to resolve them:</p>
<ul class="simple">
<li><p>Detailed <a class="reference internal" href="#sec-tutorial-help-documentation"><span class="std std-ref">HTML documentation</span></a></p></li>
<li><p><a class="reference internal" href="#sec-tutorial-help-commandline"><span class="std std-ref">Commandline help</span></a></p></li>
<li><p>The <a class="reference internal" href="#sec-tutorial-help-forum"><span class="std std-ref">SeisComP Forum</span></a></p></li>
<li><p>Reviewing <a class="reference internal" href="#sec-tutorial-help-logging"><span class="std std-ref">logging options</span></a></p></li>
<li><p>The <a class="reference internal" href="#sec-tutorial-help-debugging"><span class="std std-ref">debugging options</span></a></p></li>
<li><p><a class="reference internal" href="#sec-tutorial-help-commercial"><span class="std std-ref">Commercial support</span></a></p></li>
</ul>
</div>
<div class="section" id="ways-to-diagnose-and-to-get-help">
<h2>Ways to diagnose and to get help<a class="headerlink" href="#ways-to-diagnose-and-to-get-help" title="Permalink to this headline"></a></h2>
<div class="section" id="html-documentation">
<span id="sec-tutorial-help-documentation"></span><h3>HTML documentation<a class="headerlink" href="#html-documentation" title="Permalink to this headline"></a></h3>
<p>Most modules have HTML documentation. When installed, it can be found in <a class="reference internal" href="../../apps/scconfig.html#scconfig"><span class="std std-ref">scconfig</span></a>
under <em>Docs</em>. The HTML documentation can also be reached from the <em>Help</em> menu of all GUIs.
It contains the description of configuration and command-line parameters along with
an overview with many detailed information.</p>
<div class="figure align-center" id="id5">
<a class="reference internal image-reference" href="../../_images/gui_help.png"><img alt="../../_images/gui_help.png" src="../../_images/gui_help.png" style="width: 16cm;" /></a>
<p class="caption"><span class="caption-text"><a class="reference internal" href="../../apps/scmv.html#scmv"><span class="std std-ref">scmv</span></a> with access to the HTML documentation.</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</div>
<p>The description of most configuration parameters is also available from
within <a class="reference internal" href="../../apps/scconfig.html#scconfig"><span class="std std-ref">scconfig</span></a>.
Look under <em>Modules</em>, and choose the relevant module.
For each parameter, the first few lines of description are shown;
hovering over these reveals the full text.</p>
<p>The HTML documentation is built regularly and available online, e.g.
<a class="reference external" href="https://docs.gempa.de">gempa’s documentation</a>.</p>
</div>
<div class="section" id="commandline-help">
<span id="sec-tutorial-help-commandline"></span><h3>Commandline help<a class="headerlink" href="#commandline-help" title="Permalink to this headline"></a></h3>
<p>In addition to the HTML documentation, many SeisComP commands have manual
pages which can be read on the command line:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ man <span class="o">[</span>module name<span class="o">]</span>
</pre></div>
</div>
<p>and help on command-line options:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ <span class="o">[</span>module name<span class="o">]</span> -h
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The command-line option <em>-h</em> can be used with almost all modules. No matter how many
other command-line parameters were given, <em>-h</em> will stop the module and print
the help on the command-line.</p>
</div>
</div>
<div class="section" id="configuration-parameters">
<span id="sec-tutorial-help-config-params"></span><h3>Configuration parameters<a class="headerlink" href="#configuration-parameters" title="Permalink to this headline"></a></h3>
<p>The <a class="reference internal" href="../../apps/scconfig.html#scconfig"><span class="std std-ref">scconfig</span></a> GUI tool can be conveniently used to adjust the <a class="reference internal" href="../glossary.html#term-module"><span class="xref std std-term">module</span></a>
and <a class="reference internal" href="../glossary.html#term-binding"><span class="xref std std-term">bindings</span></a> configuration. It also displays help on each individual
configuration parameter for every module. Read the <a class="reference internal" href="../concepts/configuration.html#concepts-configuration"><span class="std std-ref">concepts
section on configuration</span></a> for a comprehensive overview.</p>
<div class="two column layout"><div class="figure align-default" id="id6">
<img alt="scconfig: tool tips" src="../../_images/scconfig-tooltips.png" />
<p class="caption"><span class="caption-text">Tool tips provide information on parameters.</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
</div>
<div class="figure align-default" id="id7">
<img alt="scconfig: parameter evaluation" src="../../_images/scconfig-evaluation.png" />
<p class="caption"><span class="caption-text">scconfig evaluates the syntax of input values.</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</div>
</div></div>
<div class="section" id="command-line-parameters">
<span id="sec-tutorial-help-cmdline-params"></span><h3>Command-line parameters<a class="headerlink" href="#command-line-parameters" title="Permalink to this headline"></a></h3>
<p>Command-line parameters provide additional flexibility when executing modules.
To learn about them read the <a class="reference internal" href="#sec-tutorial-help-documentation"><span class="std std-ref">HTML documentation</span></a> or execute</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ <span class="o">[</span>module name<span class="o">]</span> -h
</pre></div>
</div>
</div>
<div class="section" id="the-seiscomp-forum">
<span id="sec-tutorial-help-forum"></span><h3>The SeisComP Forum<a class="headerlink" href="#the-seiscomp-forum" title="Permalink to this headline"></a></h3>
<div class="figure align-center" id="id8">
<a class="reference internal image-reference" href="../../_images/help_forum.png"><img alt="../../_images/help_forum.png" src="../../_images/help_forum.png" style="width: 16cm;" /></a>
<p class="caption"><span class="caption-text">The <span id="id1"><em>SeisComP forum</em> [<a class="reference internal" href="../references.html#id242" title="SeisComP forum. GFZ. URL: https://forum.seiscomp.de/.">23</a>]</span>.</span><a class="headerlink" href="#id8" title="Permalink to this image"></a></p>
</div>
<p>The <span id="id2"><em>SeisComP forum</em> [<a class="reference internal" href="../references.html#id242" title="SeisComP forum. GFZ. URL: https://forum.seiscomp.de/.">23</a>]</span> is the place to discuss <cite>SeisComP</cite>.
Announcements about updates, training courses and more are posted
here by the developers, and users can post questions or discuss
new developments.
Anyone can browse the forum, while registration is required to post there.</p>
<p>If you have specific technical problems, it helps to have tried
some of the ideas below.
Please include version information (the ‘-V’ option described below)
if you report a problem.</p>
</div>
<div class="section" id="logging">
<span id="sec-tutorial-help-logging"></span><h3>Logging<a class="headerlink" href="#logging" title="Permalink to this headline"></a></h3>
<p>Most SeisComP applications use a standard logging approach.
By default, they log to files in your <code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/log</span></code> directory,
such as <code class="file docutils literal notranslate"><span class="pre">scamp.log</span></code>.
Further options for logging are described in
<a class="reference internal" href="../concepts/configuration.html#concepts-configuration"><span class="std std-ref">Configuration</span></a>.</p>
<p>You can control how often these are rotated
(old log files are closed, and moved to a new file name, such as scamp.log.1, e.g. daily).
Alternatively you can use the system-wide logging facility <cite>syslog</cite>
and send logs to /var/log or another “standard” place.</p>
<p>There are four levels of severity of SeisComP log messages,
and applications can be configured to show only those which
are more severe than a given threshold.</p>
<ul class="simple">
<li><p>1 = ERROR</p></li>
<li><p>2 = WARNING</p></li>
<li><p>3 = INFO</p></li>
<li><p>4 = DEBUG.</p></li>
</ul>
<p>Default is 2.
Setting <cite>logging.level = 4</cite> results in the most messages.</p>
<p>For other modules such as <a class="reference internal" href="../../apps/seedlink.html#seedlink"><span class="std std-ref">seedlink</span></a>, the log files are written to
<code class="file docutils literal notranslate"><span class="pre">seiscomp/var/log/</span></code></p>
</div>
<div class="section" id="debugging-options">
<span id="sec-tutorial-help-debugging"></span><h3>Debugging options<a class="headerlink" href="#debugging-options" title="Permalink to this headline"></a></h3>
<p>Most SeisComP applications support two important command line options:</p>
<ul class="simple">
<li><p>Use <cite>–console</cite> to send output to the terminal instead of the usual
log location.</p></li>
<li><p><cite>-v</cite> for increased verbosity, or use <cite>–verbosity=</cite> <em>n</em> where <em>n</em>
is one of the four severity levels above.</p></li>
</ul>
<p>In addition:</p>
<ul>
<li><p><cite>–debug</cite> sets logging.level (see above) to 4 (DEBUG),
and sends logging output to the console (terminal) instead of the usual
log location.
(This is just an easier way of specifying <cite>–verbosity=4 –console=1</cite>.)
For example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ~/seiscomp/bin/seiscomp <span class="nb">exec</span> scmag --debug
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: .
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: /home/user/.seiscomp/plugins
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: /home/user/seiscomp/lib/plugins
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: /home/user/seiscomp/lib
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: /home/user/seiscomp/share/plugins
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: /home/user/seiscomp/lib
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: /home/user/seiscomp/lib
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Adding plugin path: /home/user/seiscomp/share/plugins/scmag
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Trying to open plugin at /home/user/seiscomp/share/plugins/dbmysql.so
<span class="m">11</span>:47:50 <span class="o">[</span>info<span class="o">]</span> Plugin dbmysql registered
<span class="m">11</span>:47:50 <span class="o">[</span>info<span class="o">]</span>
Plugins:
--------
<span class="o">[</span><span class="m">1</span><span class="o">]</span>
description: MySQL database driver
author: GFZ Potsdam &lt;seiscomp-devel@gfz-potsdam.de&gt;
version: <span class="m">0</span>.9.2
API: <span class="m">12</span>.1.0
<span class="m">11</span>:47:50 <span class="o">[</span>info<span class="o">]</span> Connect to messaging
<span class="m">11</span>:47:50 <span class="o">[</span>debug<span class="o">]</span> Trying to connect to scmag@localhost with primary <span class="nv">group</span> <span class="o">=</span> MAGNITUDE
<span class="m">11</span>:47:50 <span class="o">[</span>info<span class="o">]</span> Connecting to server: localhost
<span class="m">11</span>:47:50 <span class="o">[</span>info<span class="o">]</span> Connected to message server: localhost
<span class="m">11</span>:47:50 <span class="o">[</span>info<span class="o">]</span> Joining MASTER_GROUP group
<span class="m">11</span>:47:50 <span class="o">[</span>info<span class="o">]</span> Sending connect message to server: localhost
<span class="m">11</span>:47:51 <span class="o">[</span>info<span class="o">]</span> Server version is <span class="s1">&#39;Jakarta 2018.327.p15&#39;</span>
<span class="m">11</span>:47:51 <span class="o">[</span>info<span class="o">]</span> Outgoing messages are encoded to match schema version <span class="m">0</span>.11
<span class="m">11</span>:47:51 <span class="o">[</span>info<span class="o">]</span> user <span class="s2">&quot;scmag&quot;</span> connected successfully to localhost
</pre></div>
</div>
<p>The above reveals that <strong class="program">scmag</strong> was able to load, and connect to the
messaging system.
Note that the <em>verbosity</em> of each message (“info”, “debug”, etc) is also
shown.
However a moment later we see:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="m">11</span>:47:51 <span class="o">[</span>info<span class="o">]</span> Connect to database
<span class="m">11</span>:47:51 <span class="o">[</span>debug<span class="o">]</span> skipping unknown network message
<span class="m">11</span>:47:51 <span class="o">[</span>debug<span class="o">]</span> skipping unknown network message
<span class="m">11</span>:47:51 <span class="o">[</span>debug<span class="o">]</span> skipping unknown network message
<span class="m">11</span>:47:56 <span class="o">[</span>error<span class="o">]</span> Timeout <span class="k">while</span> waiting <span class="k">for</span> database provide message
<span class="m">11</span>:47:56 <span class="o">[</span>debug<span class="o">]</span> Leaving ::done
<span class="m">11</span>:47:56 <span class="o">[</span>info<span class="o">]</span> Shutting down MagTool
- database accesses <span class="k">while</span> runtime: <span class="m">0</span>
</pre></div>
</div>
<p>This suggests that <a class="reference internal" href="../../apps/scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a> was not running to provide a
connection to the database.
To resolve this, you could next check that <a class="reference internal" href="../../apps/scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a> is
running as expected.</p>
</li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Instead of <cite>–debug</cite> in the example above, you could run</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ~/seiscomp/bin/seiscomp <span class="nb">exec</span> scmag -vvvv
</pre></div>
</div>
<p>The output is the same, but it is sent to your normal logging file,
typically <cite>~/.seiscomp/log/scmag.log</cite>.</p>
</div>
<p>In <a class="reference internal" href="../../apps/scconfig.html#scconfig"><span class="std std-ref">scconfig</span></a>, logging can be set globally.
Go to the Modules tab, then System &gt; global (see “logging”)
or per module.</p>
<p>e.g. set “logging.level = 3” in $SEISCOMP_ROOT/etc/scamp.log
to set level to <em>INFO</em> only for <a class="reference internal" href="../../apps/scamp.html#scamp"><span class="std std-ref">scamp</span></a>.</p>
<p>You should also be aware of the version of SeisComP that you are running.
The ‘-V’ or ‘–version’ option provides this for many SeisComP modules.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ~/seiscomp3/bin/seiscomp <span class="nb">exec</span> scmag -V
scmag: Jakarta <span class="m">2018</span>.327.p15
API version: <span class="m">12</span>.1.0
GIT HEAD:
Compiler: c++ <span class="o">(</span>Ubuntu <span class="m">7</span>.3.0-16ubuntu3<span class="o">)</span> <span class="m">7</span>.3.0
Build system: Linux <span class="m">4</span>.15.0-20-generic
OS: Ubuntu <span class="m">18</span>.04 LTS / Linux
</pre></div>
</div>
</div>
<div class="section" id="commercial-support">
<span id="sec-tutorial-help-commercial"></span><h3>Commercial support<a class="headerlink" href="#commercial-support" title="Permalink to this headline"></a></h3>
<p>Professional commercial support to SeisComP users is available from
<span id="id3"><em>gempa GmbH</em> [<a class="reference internal" href="../references.html#id113" title="gempa GmbH. The SeisComP development and maintenance company. URL: https://www.gempa.de/.">26</a>]</span>.</p>
</div>
</div>
<div class="section" id="next-time-you-have-a-problem">
<h2>Next time you have a problem<a class="headerlink" href="#next-time-you-have-a-problem" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Try some of the above techniques.</p></li>
<li><p>If you find a solution, don’t forget to share it at the <span id="id4"><em>SeisComP forum</em> [<a class="reference internal" href="../references.html#id242" title="SeisComP forum. GFZ. URL: https://forum.seiscomp.de/.">23</a>]</span>.</p></li>
</ul>
</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="#">Help! I’m stuck! Now what?</a><ul>
<li><a class="reference internal" href="#outline">Outline</a></li>
<li><a class="reference internal" href="#ways-to-diagnose-and-to-get-help">Ways to diagnose and to get help</a><ul>
<li><a class="reference internal" href="#html-documentation">HTML documentation</a></li>
<li><a class="reference internal" href="#commandline-help">Commandline help</a></li>
<li><a class="reference internal" href="#configuration-parameters">Configuration parameters</a></li>
<li><a class="reference internal" href="#command-line-parameters">Command-line parameters</a></li>
<li><a class="reference internal" href="#the-seiscomp-forum">The SeisComP Forum</a></li>
<li><a class="reference internal" href="#logging">Logging</a></li>
<li><a class="reference internal" href="#debugging-options">Debugging options</a></li>
<li><a class="reference internal" href="#commercial-support">Commercial support</a></li>
</ul>
</li>
<li><a class="reference internal" href="#next-time-you-have-a-problem">Next time you have a problem</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="waveformplayback.html"
title="previous chapter">Play back archived waveforms</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="template.html"
title="next chapter">Create a new tutorial</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/base/tutorials/help.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>
View Git Blame Copy Permalink