From ba2990d3faf19c25c5df0f335c2f5fe57881d6b3 Mon Sep 17 00:00:00 2001
From: "Matthias P. Braendli" <matthias.braendli@mpb.li>
Date: Fri, 21 Nov 2025 21:58:08 +0100
Subject: Remove mention of xymon

---
 systemenvironments.tex | 124 -------------------------------------------------
 1 file changed, 124 deletions(-)

(limited to 'systemenvironments.tex')

diff --git a/systemenvironments.tex b/systemenvironments.tex
index f51c549..320d41e 100644
--- a/systemenvironments.tex
+++ b/systemenvironments.tex
@@ -186,130 +186,6 @@ server, and the ZeroMQ remote control enabled on the ports give in the example
 configurations.
 
 
-\subsection{Monitoring using Xymon}
-The xymon monitoring tool\footnote{\url{http://xymon.sourceforge.net/}} is used
-to monitor the health of many types of systems. It can present the results in
-text, tables and/or graphs. It supports the basic health checks directly out of
-the box, and can be extended with scripts to perform non-standard health checks.
-The default mode of operation is that clients retrieve data and send it to the
-xymon server, which interprets the results, displays them and generates alerts
-if thresholds are exceeded. An alert can be send in an e-mail, an SMS or a
-tweet.
-
-The Perl script \verb+retodrs.pl+\footnote{The script name stands for
-''Retrieve Opendigitalradio Status``}, retrieves the status and
-statistics of an Opendigitalradio service and it reports the results to xymon.
-The information is retrieved from the management server within ODR-DabMux. The
-information presented includes a table with the status of each sub-channel and
-the underrun and overrun rates on the sub-channels. If needed an alert can be
-generated depending on the subchannel status or a rate exceeding a threshold.
-
-The script needs to be installed on the same server running ODR-DabMux, as the
-management service within it is only accessible from the same computer. This
-implies that the xymon client software also needs to be installed on the same
-machine. The client is configured to run the script.
-The configuration and the scripts can typically be found in subdirectory
-\verb+/usr/lib/xymon/client+, although that may depend on your distribution.
-
-Once the client is set up, it needs to connect to a xymon server, which may or
-may not be on the same machine.
-The server is configured to limit the altering to specific sub-channels, to
-store the statistical data and to generate graphs.
-The configuration and the scripts on a xymon server are usually stored in the
-subdirectory \verb+/usr/lib/xymon/server+.
-
-
-\subsubsection{Installation of the Xymon Client}
-
-The perl script has additional requirements:
-\texttt{App::cpanminus}, \texttt{ZMQ::LibZMQ3}, and \texttt{JSON::PP}. They can
-be installed through your distribution packages or using CPAN.
-
-Once the script has been copied to \verb+/usr/lib/xymon/client/ext+, the
-configuration of the launcher within the xymon client needs to be extended.
-Create a new file named \verb+odrmux.cfg+ in
-\verb+/usr/lib/xymon/client/etc/clientlaunch.d+ containing the following lines:
-
-\begin{lstlisting}
-#
-# Test odrmux checks the state and the statistics
-# of the ODR-DabMux service.
-#
-[odrmux]
-	ENVFILE $XYMONCLIENTHOME/etc/xymonclient.cfg
-	CMD $XYMONCLIENTHOME/ext/retodrs.pl
-	LOGFILE $XYMONCLIENTLOGS/retodrs.plog
-	INTERVAL 5m
-\end{lstlisting}
-
-After a restart of the xymon client, the script \verb+retodrs.pl+ will
-be invoked once every 5 minutes.
-
-
-\subsubsection{Server Configuration}
-
-By default all subchannels will be monitored, and will raise alerts if the
-status or the statistics are in outside of a valid operational range. The
-alerting can be limited to a subset of the sub-channels by adding a tag to the
-hosts-entry in the configuration file \verb+/usr/lib/xymon/server/etc/hosts.cfg+.
-The additional tag is:
-
-\begin{lstlisting}
-	ODR:select(<SubChannelName0>;<SubChannelName1>;...)
-\end{lstlisting}
-
-The sub-channels not named will still be shown, but no alerts will be generated
-for those sub-channels. This is visible as the green/yellow/red icons are
-missing for those sub-channels.
-
-Six statistic values are gathered by the script, namely
-\texttt{BufferMin}, \texttt{BufferMax}, \texttt{PeakLeft}, \texttt{PeakRight},
-\texttt{UnderRun} and \texttt{OverRun}. It is found that only the latter two
-seem to contain sensible values all the time, so those values are the only
-ones shown in a graph. Note that those values retrieved by the script are
-ever-increasing counters, showing the total number of over-runs or under-runs.
-In the graph, the average number of over-runs or under-runs per second, averaged
-over a period of 5 minutes, is shown.
-
-The first step is to have the collected statistics to be moved into a database,
-a so-called \textit{Round Robin Database}. This is accomplished by adding a file
-named \verb+odr.cfg+ in \verb+/usr/lib/xymon/server/etc/xymonserver.d+
-containing the following lines:
-
-\begin{lstlisting}
-TEST2RRD+=",odr_mux=devmon"
-GRAPHS+=",odr_mux::1"
-\end{lstlisting}
-
-The next step is to define the layout of the graph.
-Create a file named \verb+graphs.odr.cfg+ in
-\verb+/usr/lib/xymon/server/etc/graphs.d+ containing the following lines:
-
-\begin{lstlisting}
-#
-# Graphs to show the statistics collected from an
-# Opendigitalradio DabMux server.
-#
-[odr_mux]
-	FNPATTERN ^odr_mux\.(.+)\.rrd$
-	TITLE , Frame loss rate
-	YAXIS Rate [/s]
-	-l 0
-	DEF:ur@RRDIDX@=@RRDFN@:Underrun:AVERAGE
-	DEF:or@RRDIDX@=@RRDFN@:Overrun:AVERAGE
-	LINE1:ur@RRDIDX@#FF0000:@RRDPARAM@ underrun
-	GPRINT:ur@RRDIDX@:MIN:Min \: %5.1lf %s
-	GPRINT:ur@RRDIDX@:MAX:Max \: %5.1lf %s
-	GPRINT:ur@RRDIDX@:AVERAGE:Avg \: %5.1lf %s
-	GPRINT:ur@RRDIDX@:LAST:Cur \: %5.1lf %s\n
-	LINE1:or@RRDIDX@#00FF00:@RRDPARAM@ overrun
-	GPRINT:or@RRDIDX@:MIN: Min \: %5.1lf %s
-	GPRINT:or@RRDIDX@:MAX:Max \: %5.1lf %s
-	GPRINT:or@RRDIDX@:AVERAGE:Avg \: %5.1lf %s
-	GPRINT:or@RRDIDX@:LAST:Cur \: %5.1lf %s\n
-\end{lstlisting}
-
-
 \subsection{Real-time Scheduling}
 As a general principle, it is prudent not to run tools (that do not need superuser
 privileges) as the \texttt{root} user. The same principle also applies to the
-- 
cgit v1.2.3

