aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org>2020-09-19 21:24:38 +0300
committerSergey Poznyakoff <gray@gnu.org>2020-09-19 21:24:38 +0300
commit6c0b1a6431540c074920252a3b2a964fe9bdf99b (patch)
tree5c238a011e96674430120259b969cddd1eab09d3
parenta9974c3f5be1077909849151c14d01f5eed86576 (diff)
downloadping903-6c0b1a6431540c074920252a3b2a964fe9bdf99b.tar.gz
ping903-6c0b1a6431540c074920252a3b2a964fe9bdf99b.tar.bz2
Proof-read the docs.
-rw-r--r--README32
-rw-r--r--doc/ping903.819
-rw-r--r--doc/ping903.conf.526
-rw-r--r--doc/ping903.cred.58
-rw-r--r--doc/ping903q.115
-rwxr-xr-xexamples/dbload2
-rw-r--r--rc/README6
7 files changed, 54 insertions, 54 deletions
diff --git a/README b/README
index 94ec8d9..7de1140 100644
--- a/README
+++ b/README
@@ -48,7 +48,7 @@ discussion of available options to configure and their effect.
48After installing the package, copy the file src/ping903.conf to 48After installing the package, copy the file src/ping903.conf to
49/etc/ping903.conf and edit it to your liking. This file contains 49/etc/ping903.conf and edit it to your liking. This file contains
50configuration settings that control the behavior of the server daemon 50configuration settings that control the behavior of the server daemon
51and, to a certain extent, that of a query tool. The file contains 51and, to a certain extent, that of the query tool. The file contains
52short annotations before each statement to help you navigate through 52short annotations before each statement to help you navigate through
53it. You will find a detailed discussion of the configuration file in 53it. You will find a detailed discussion of the configuration file in
54the manpage ping903.conf(5). What follows is a short outline, intended 54the manpage ping903.conf(5). What follows is a short outline, intended
@@ -86,9 +86,9 @@ of them in a separate ip-list statement.
86IP addresses listed in ip-list files form the "immutable" IP list, 86IP addresses listed in ip-list files form the "immutable" IP list,
87called so because it cannot be altered while the program is running. 87called so because it cannot be altered while the program is running.
88The REST API allows the user to add any number of IP addresses at 88The REST API allows the user to add any number of IP addresses at
89runtime as well as remove any of IP addresses added this way. These 89runtime as well as to remove any of IP addresses added this way.
90addresses form the "mutable" IP list. Mutable IP list is preserved 90These addresses form the "mutable" IP list. Mutable IP list is
91across program restarts. 91preserved across program restarts.
92 92
93This means that actually the immutable IP list is optional. You may 93This means that actually the immutable IP list is optional. You may
94choose to keep monitored addresses in an external storage (an SQL 94choose to keep monitored addresses in an external storage (an SQL
@@ -102,8 +102,8 @@ from <http://git.gnu.org.ua/cgit/ping903/mangemanche.git>.
102Normally, the ip-list file should contain IP addresses of the hosts to 102Normally, the ip-list file should contain IP addresses of the hosts to
103monitor. It is OK, however, to use symbolic DNS names, too. If a 103monitor. It is OK, however, to use symbolic DNS names, too. If a
104hostname resolves to a single A record, such usage is equivalent to 104hostname resolves to a single A record, such usage is equivalent to
105placing that IP in the ip-list. However, if the hostnames resolves to 105placing that IP in the ip-list. However, if it resolves to multiple IPs,
106multiple IPs, only first one will be used. 106only the first one will be used.
107 107
108By default, the server will wake up each minute and send 10 echo 108By default, the server will wake up each minute and send 10 echo
109requests within 1 second intervals to each registered IP. If the 109requests within 1 second intervals to each registered IP. If the
@@ -148,9 +148,9 @@ operational, run
148 148
149This should return the running configuration. 149This should return the running configuration.
150 150
151Within the next 'probe-interval' seconds the server will collect 151Within the first 'probe-interval' seconds after startup, the daemon will
152enough statistics to answer your queries. You can request information 152collect enough statistics to answer your queries. You can request
153about any particular IP from your ip-list by running 153information about any particular IP from your ip-list by running
154 154
155 ping903q IP 155 ping903q IP
156 156
@@ -181,11 +181,11 @@ Note, that depending on your settings the output can be huge.
181 181
182Please refer to ping903q(1), for a detailed discussion of the tool. 182Please refer to ping903q(1), for a detailed discussion of the tool.
183 183
184* System start-up sequence 184* Startup scripts
185 185
186To configure ping903 to start automatically at the system start-up, 186The package includes startup scripts for several major GNU/Linux
187see the "rc" subdirectory. It contains start up scripts for various 187distributions. Please refer to rc/README for instructions on
188flavors of GNU/Linux distributions. 188adding ping903 to the operating system startup and shutdown sequences.
189 189
190* Nagios external check 190* Nagios external check
191 191
@@ -209,12 +209,6 @@ makes use of it:
209 retry_interval 1 209 retry_interval 1
210 } 210 }
211 211
212* Startup scripts
213
214The package includes startup scripts for several major GNU/Linux
215distributions. Please refer to rc/README for instructions on
216adding ping903 to the operating system startup and shutdown sequences.
217
218* Installation from a git clone 212* Installation from a git clone
219 213
220If you are building from a clone of the Git repository, you will need 214If you are building from a clone of the Git repository, you will need
diff --git a/doc/ping903.8 b/doc/ping903.8
index 35cbb4a..f8967af 100644
--- a/doc/ping903.8
+++ b/doc/ping903.8
@@ -13,7 +13,7 @@
13.\" 13.\"
14.\" You should have received a copy of the GNU General Public License 14.\" You should have received a copy of the GNU General Public License
15.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>. 15.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>.
16.TH PING903 8 "March 11, 2020" "PING903" "System Administration" 16.TH PING903 8 "September 19, 2020" "PING903" "System Administration"
17.SH NAME 17.SH NAME
18ping903 \- high-performance ICMP monitoring daemon 18ping903 \- high-performance ICMP monitoring daemon
19.SH SYNOPSIS 19.SH SYNOPSIS
@@ -52,12 +52,13 @@ IP list is supplied in the configuration file and cannot be altered at
52run-time. The 52run-time. The
53.I mutable 53.I mutable
54IP list, in contrast, is maintained via the REST API and thus can be 54IP list, in contrast, is maintained via the REST API and thus can be
55changed while the server runs. The content of mutable IP list is 55changed when the server runs. The content of the mutable IP list is
56preserved during server restarts. 56preserved during server restarts.
57.PP 57.PP
58Probes for each IP from the list are initiated periodically, each 58Each
59.B probe\-interval 59.B probe\-interval
60seconds. Each probe consists of 60seconds, the daemon wakes up and probes each IP from the list. Each
61probe consists of
61.B ping\-count 62.B ping\-count
62ICMP ECHO requests sent with intervals of 63ICMP ECHO requests sent with intervals of
63.B ping\-interval 64.B ping\-interval
@@ -76,10 +77,10 @@ failure \fItolerance\fR number) are lost, the status of the IP is
76changed to "inactive". 77changed to "inactive".
77.PP 78.PP
78An \fBHTTP\fR listener thread is responsible for returning the collected 79An \fBHTTP\fR listener thread is responsible for returning the collected
79statistics and serving other requests. By default the program listens 80statistics and serving other requests. By default it listens for
80for queries on localhost, port 8080. If compiled with the support for 81queries on localhost, port 8080. If compiled with the support for
81\fBlibwrap\fR, the access to the HTTP interface can be controlled 82\fBlibwrap\fR, the access to the HTTP interface is controlled using
82using files 83the files
83.B /etc/hosts.allow 84.B /etc/hosts.allow
84and 85and
85.BR /etc/hosts.deny . 86.BR /etc/hosts.deny .
@@ -146,7 +147,7 @@ requests sent and replies received. Two options (\fB\-vv\fR), enable
146additional diagnostics of invalid echo replies. Three options enable 147additional diagnostics of invalid echo replies. Three options enable
147logging of each received echo reply, and four options enable verbose 148logging of each received echo reply, and four options enable verbose
148logging of each echo request sent. Notice that three or more 149logging of each echo request sent. Notice that three or more
149\fB\-v\fR options can produce huge amount of logs. 150\fB\-v\fR options can produce a huge amount of output.
150.SH BUGS 151.SH BUGS
151Only IPv4 is currently supported. 152Only IPv4 is currently supported.
152.SH SEE ALSO 153.SH SEE ALSO
diff --git a/doc/ping903.conf.5 b/doc/ping903.conf.5
index cf3432e..a5e9cc4 100644
--- a/doc/ping903.conf.5
+++ b/doc/ping903.conf.5
@@ -13,7 +13,7 @@
13.\" 13.\"
14.\" You should have received a copy of the GNU General Public License 14.\" You should have received a copy of the GNU General Public License
15.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>. 15.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>.
16.TH PING903.CONF 5 "March 10, 2020" "PING903.CONF" "File Formats Manual" 16.TH PING903.CONF 5 "September 19, 2020" "PING903.CONF" "File Formats Manual"
17.SH NAME 17.SH NAME
18ping903.conf \- configuration file for high-performance ICMP monitoring daemon 18ping903.conf \- configuration file for high-performance ICMP monitoring daemon
19.SH DESCRIPTION 19.SH DESCRIPTION
@@ -67,7 +67,7 @@ through
67\fBip\-list \fIFILE\fR 67\fBip\-list \fIFILE\fR
68Name of the file supplying a list of IP addresses (or hostnames) to 68Name of the file supplying a list of IP addresses (or hostnames) to
69monitor. Each IP must be listed on a separate line. Empty lines, 69monitor. Each IP must be listed on a separate line. Empty lines,
70leading and trailing whitespace is ignored. Comments are introduced 70leading and trailing whitespace are ignored. Comments are introduced
71by a hash sign as the first non-whitespace character on the line. 71by a hash sign as the first non-whitespace character on the line.
72.TP 72.TP
73\fBip\-list <<\fIWORD\fR 73\fBip\-list <<\fIWORD\fR
@@ -82,7 +82,7 @@ Empty lines and comments are allowed within \fIhere-document\fR.
82Multiple \fBip\-list\fR statements of any form accumulate. 82Multiple \fBip\-list\fR statements of any form accumulate.
83.TP 83.TP
84\fBprobe\-interval \fIN\fR 84\fBprobe\-interval \fIN\fR
85Sets interval between subsequent probes, in seconds. Default is 60 85Sets interval (in seconds) between subsequent probes. Default is 60
86(one minute). 86(one minute).
87.TP 87.TP
88\fBping\-count \fIN\fR 88\fBping\-count \fIN\fR
@@ -112,7 +112,7 @@ symbolic service name from
112Either \fIIPADDR\fR or \fIPORT\fR (but not both) can be omitted. Missing 112Either \fIIPADDR\fR or \fIPORT\fR (but not both) can be omitted. Missing
113\fIIPADDR\fR is equivalent to 127.0.0.1 (note, that in this case the 113\fIIPADDR\fR is equivalent to 127.0.0.1 (note, that in this case the
114colon before \fIPORT\fR must be present). Missing \fIPORT\fR means 114colon before \fIPORT\fR must be present). Missing \fIPORT\fR means
115use the default port number (8080). 115the default port number (8080).
116 116
117To summarize, possible arguments are: 117To summarize, possible arguments are:
118\fIIPADDR\fB:\fIPORT\fR, \fIIPADDR\fR, or \fB:\fIPORT\fR. 118\fIIPADDR\fB:\fIPORT\fR, \fIIPADDR\fR, or \fB:\fIPORT\fR.
@@ -121,13 +121,13 @@ Default is \fB0.0.0.0:8080\fR.
121.TP 121.TP
122\fBhttp\-backlog\-size \fIN\fR 122\fBhttp\-backlog\-size \fIN\fR
123Configures the size of the 123Configures the size of the
124.BR listen(2) 124.BR listen (2)
125backlog queue. Default is the platform-dependent value 125backlog queue. Default is the platform-dependent value
126.BR SOMAXCONN , 126.BR SOMAXCONN ,
127(128 on most GNU/Linux systems). 127(128 on most GNU/Linux systems).
128.TP 128.TP
129\fBaccess\-log \fIBOOL\fR 129\fBaccess\-log \fIBOOL\fR
130Enable apache-style HTTPD access logging. Valid \fIBOOL\fR values are: 130Enables the apache-style HTTP access logging. Valid \fIBOOL\fR values are:
131.BR 1 , 131