Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
Snippets Groups Projects
Commit 10a08445 authored by thl-cmk's avatar thl-cmk :flag_na:
Browse files

Update README.md

parent 1c224ee2
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 46 additions and 47 deletions
README.md
+ 46
− 47
View file @ 10a08445
# Title # Squid Web Proxy
A short description about the plugin This CheckMK plugin monitors the prsformance of the _**Squid Web Proxy**_. This plugin is intended to use with the Agent Bakery of CheckMK.
if there are more than on plugin put it in collapsable sections ### Acnowlegement
<details><summary>check_plugin_1</summary>
</details> This plugin is based on the work of Allan GooD: allan[dot]cassaro[at]gmail[dot]com. See https://github.com/allangood/check_mk/tree/master/plugins/squid for more details.
<details><summary>check_pluhin_2</summary>
</details>
--- ---
### Download ### Download
* [PACKAGE_NAME.mkp (latest version)](https://thl-cmk.hopto.org/gitlab/checkmk/PATH_TO_THE_PACKAGE/-/raw/master/PACKAGE_NAME.mkp "Download latest version") * [squid.mkp (latest version)](https://thl-cmk.hopto.org/gitlab/checkmk/various/squid/-/raw/master/squid.mkp "Download latest version")
--- ---
### Installation ### Installation
You can install the package by uploading it to your CheckMK site and as site user run You can install the package by uploading it to your CheckMK site and as site user run
``` ```
mkp install PAKAGE_NAME.mkp mkp install squid.mkp
mkp enable PAKAGE_NAME VERSION mkp enable squid VERSION
``` ```
In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_) In the Enterprise/Free/Cloud edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_)
The agentplugin requieres the **squidclient** package to be installed in addition to the _**Squid Web Proxy**_.
--- ---
### Want to Contribute? ### Want to Contribute?
...@@ -34,25 +32,34 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut ...@@ -34,25 +32,34 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut
--- ---
### Check Info ### Check Info
The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT with the **_HOW_TO_BUILD_THE_ITEM_** as item The plugin creates the service **_Squid_** the items _**Client**_, _**Server**_, _**CPU**_ and _**DNS**_.
<details><summary>Montoring states</summary> <details><summary>Montoring states</summary>
| State | condition | WATO | | State | Counter | condition | WATO |
| ------ | ------ | ------ | | ----- | ----- |------ | ------ |
| WARN | condition 1 | yes | | WARN/CRIT | Client Requests | not in levels | yes |
| CRIT | condition 2 | no | | WARN/CRIT | Client Hits | not in levels | yes |
| WARN/CRIT | condition 3 | no | | WARN/CRIT | Server Requests | not in levels | yes |
| WARN/CRIT | CPU Usage | not in levels | yes |
| WARN/CRIT | DNS response time | not in levels | yes |
</details> </details>
<details><summary>Perfdata</summary> <details><summary>Perfdata</summary>
| Metric | Unit | Perfometer | | Metric | Unit | Perfometer |
| ------ | ------ | ------ | | ------ | ------ | ------ |
| METRIC 1 | bit/s | yes | | Client requests | 1/s | no |
| METRIC 2 | C | yes | | Client errors | 1/s | no |
| METRIC 3 | V | no | | Client hits | 1/s | no |
| Client bytes in/out | bit/s | yes |
| Server requests | 1/s | no |
| Server errors | 1/s | no |
| Server bytes in/out | bit/s | yes |
| CPU utilization | % | yes |
| CPU time | seconds | no |
| DNS response time | seconds | yes |
</details> </details>
...@@ -60,43 +67,35 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi ...@@ -60,43 +67,35 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi
### WATO ### WATO
<details><summary>Service monitoring rule</summary> <details><summary>Service monitoring rule</summary>
| Section | Rule name | | Section | Rule name |
| ------ | ------ | | ------ | ------ |
| Networking | NAME_OF_THE_RULE | | Applications, Processes & Services | Squid Web Proxy |
| Option | Defailt value | | Option | Defailt value | Predictive |
| ------ | ------ | | ------ | ------ | ---------- |
| OPTION 1 | 10/50| | Set levels for Client Requests | none | optional |
| OPTION 2 | 70/90 | | Set levels for Client Hits | none | optional |
| OPTION 3 | CHOICE 1 | | Set levels for Server Requests | none | optional |
| OPTION 4 | disabled | | Set levels for Squid CPU usage | 60.0/80.0 | optional |
| Set levels for DNS response time | 2.0/4.0 | no |
</details> </details>
<details><summary>Discovery rule</summary> <details><summary>Bakery rule</summary>
| Section | Rule name | | Section | Rule name |
| ------ | ------ | | ------ | ------ |
| Discovery of individual services | NAME_OF_THE_RULE | | Agent rules | Squid Web Proxy (Linux) |
| Option | Defailt value | | Option | Defailt value |
| ------ | ------ | | ------ | ------ |
| OPTION 1 | disabled | | Port number | 3128 |
</details> </details>
<details><summary>HW/SW inventory rules</summary>
The inventory plugin is not configurable.
</details>
--- ---
### Sample Output ### Sample Output
Sample output Sample output
![sample output](/doc/sample.png?raw=true "sample output") ![sample output](/doc/sample.png?raw=true "sample output")
Sample output details
![sample output details](/doc/sample-details.png?raw=true "sample output details")
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com