Skip to content

Commit dbec5bf

Browse files
markuslfmarkuslf
committed
docs(readme): fix typos, broken links, and incorrect descriptions
1 parent 768cff8 commit dbec5bf

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Do you think more people should know about it? Sharing is caring, so feel free t
6464
* Have a look at the [INSTALL](https://github.com/Linuxfabrik/monitoring-plugins/blob/main/INSTALL.md) document for the various options, including SELinux etc.
6565
* For details on installing the plugins in Icinga Director, see [ICINGA](https://github.com/Linuxfabrik/monitoring-plugins/blob/main/ICINGA.md).
6666

67-
If you want to run your own instance of Icinga, you could set it up in a few clicks using the infrastructure provider Exoscale. We provide the images at the [Exoscale Marketplace](https://www.exoscale.com/marketplace/). Alternatively, you can set up a self-hosted Icinga infrastructure using our [LFOps Ansible collection](github.com/Linuxfabrik/lfops).
67+
If you want to run your own instance of Icinga, you could set it up in a few clicks using the infrastructure provider Exoscale. We provide the images at the [Exoscale Marketplace](https://www.exoscale.com/marketplace/). Alternatively, you can set up a self-hosted Icinga infrastructure using our [LFOps Ansible collection](https://github.com/Linuxfabrik/lfops).
6868

6969

7070
## Reporting Issues
@@ -116,7 +116,7 @@ See some of our check plugins at a glance on an Icinga server:
116116
<img alt="hin-status" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/hin-status.png" width="30%"/> &nbsp;
117117
<img alt="icinga-topflap-services" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/icinga-topflap-services.png" width="30%"/> &nbsp;
118118
<img alt="infomaniak-events" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/infomaniak-events.png" width="30%"/> &nbsp;
119-
<img alt="infomaniak-swiss-backp-devices" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/infomaniak-swiss-backp-devices.png" width="30%"/> &nbsp;
119+
<img alt="infomaniak-swiss-backup-devices" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/infomaniak-swiss-backup-devices.png" width="30%"/> &nbsp;
120120
<img alt="infomaniak-swiss-backup-products" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/infomaniak-swiss-backup-products.png" width="30%"/> &nbsp;
121121
<img alt="journald-query" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/journald-query.png" width="30%"/> &nbsp;
122122
<img alt="journald-usage" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/journald-usage.png" width="30%"/> &nbsp;
@@ -215,7 +215,7 @@ See some of our check plugins at a glance on an Icinga server:
215215
<img alt="wildfly-server-status" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/wildfly-server-status.png" width="30%"/> &nbsp;
216216
<img alt="wildfly-thread-usage" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/wildfly-thread-usage.png" width="30%"/> &nbsp;
217217
<img alt="wildfly-uptime" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/wildfly-uptime.png" width="30%"/> &nbsp;
218-
<img alt="wildfly-xa-datasources-stats" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/wildfly-xa-datasources-stats.png" width="30%"/> &nbsp;
218+
<img alt="wildfly-xa-datasource-stats" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/wildfly-xa-datasource-stats.png" width="30%"/> &nbsp;
219219
<img alt="wordpress-version" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/wordpress-version.png" width="30%"/> &nbsp;
220220
<img alt="xca-cert" src="https://download.linuxfabrik.ch/monitoring-plugins/assets/screenshots/xca-cert.png" width="30%"/> &nbsp;
221221

@@ -328,15 +328,15 @@ Since the primary hosting platform is Linux, which uses IEC, the plugins display
328328
| 1000\^1 | KB | | Bytes | Kilobytes |
329329
| 1000\^2 | MB | | Bytes | Megabytes |
330330
| 1000\^3 | GB | | Bytes | Gigabytes |
331-
| 1000\^4 | TB | | Bytes | Terrabytes |
331+
| 1000\^4 | TB | | Bytes | Terabytes |
332332
| 1000\^5 | PB | | Bytes | Petabytes |
333333
| 1000\^6 | EB | | Bytes | Exabytes |
334334
| 1000\^7 | ZB | | Bytes | Zetabytes |
335335
| 1000\^8 | YB | | Bytes | Yottabytes |
336336
| 1000\^1 | Kbps | | Bits per Second | Kilobits |
337337
| 1000\^2 | Mbps | | Bits per Second | Megabits |
338338
| 1000\^3 | Gbps | | Bits per Second | Gigabits |
339-
| 1000\^4 | Tbps | | Bits per Second | Terrabits |
339+
| 1000\^4 | Tbps | | Bits per Second | Terabits |
340340
| 1000\^5 | Pbps | | Bits per Second | Petabits |
341341
| 1000\^6 | Ebps | | Bits per Second | Exabits |
342342
| 1000\^7 | Zbps | | Bits per Second | Zetabits |
@@ -409,8 +409,8 @@ To avoid problems when passing *parameter values* that start with a `-`, the com
409409
├── lib Link to the Linuxfabrik Python libraries
410410
├── unit-test File for unit tests
411411
│ ├── retc Files for simulating return codes
412-
│ ├── stdin Files for simulating output to STDOUT
413-
│ ├── stdout Files for simulating output to STDERR
412+
│ ├── stdin Files for simulating input to STDIN
413+
│ ├── stdout Files for simulating output to STDOUT
414414
│ └── run The unit test
415415
└── plugin-name The monitoring plugin
416416
```
@@ -456,7 +456,7 @@ A: In Bash, use `/usr/lib64/nagios/plugins/check-command | cut -f1 -d'|'`
456456

457457
Q: **Do the plugins also handle proxy environment variables like `HTTP_PROXY`?**
458458

459-
A: Yes, `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `http_proxy` are automatically used by the Linuxfabrik monitoring plugins if they are set.
459+
A: Yes, `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` are automatically used by the Linuxfabrik monitoring plugins if they are set.
460460

461461

462462
Q: **Icinga does not seem to pass the environment variable `http_proxy` to the plugins. What am i doing wrong?**
@@ -495,7 +495,7 @@ So the `|` character is reserved to separate plugin output from performance data
495495

496496
Q: **Negative values for plugin arguments cause problems in Icinga.**
497497

498-
A: As of 2024-11, Icinga still passes parameter values to plugins without a leading `=`. This causes plugins to assume that parameters starting with negative values are additional but unknown arguments. In Icinga this can be avoided by prefixing the first minus sign of a value with a backslash `\`, which is later removed by the [base.py](https://github.com/Linuxfabrik/lib/blob/main/base.py) library (v2024112001+, v2.0.0.0+). So just use `\-60` or `\-60:-3600` instead of `-60` or `-60:-3600` (see [#789](https://github.com/Linuxfabrik/monitoring-plugins/issues/789>)).
498+
A: As of 2024-11, Icinga still passes parameter values to plugins without a leading `=`. This causes plugins to assume that parameters starting with negative values are additional but unknown arguments. In Icinga this can be avoided by prefixing the first minus sign of a value with a backslash `\`, which is later removed by the [base.py](https://github.com/Linuxfabrik/lib/blob/main/base.py) library (v2024112001+, v2.0.0.0+). So just use `\-60` or `\-60:-3600` instead of `-60` or `-60:-3600` (see [#789](https://github.com/Linuxfabrik/monitoring-plugins/issues/789)).
499499

500500

501501
Q: **On Windows, sometimes Windows Defender randomly kills a plugin. Why?**

0 commit comments

Comments
 (0)