From 10a084458a75e7f45e8e502fbf3a17eb5c6ff622 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Sun, 21 May 2023 15:41:44 +0000
Subject: [PATCH] Update README.md
---
README.md | 93 +++++++++++++++++++++++++++----------------------------
1 file changed, 46 insertions(+), 47 deletions(-)
diff --git a/README.md b/README.md
index 8a11fa4..4cb9038 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,29 @@
-# 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
-<details><summary>check_plugin_1</summary>
+### Acnowlegement
-</details>
-<details><summary>check_pluhin_2</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.
---
### 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
You can install the package by uploading it to your CheckMK site and as site user run
```
-mkp install PAKAGE_NAME.mkp
-mkp enable PAKAGE_NAME VERSION
+mkp install squid.mkp
+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_)
+The agentplugin requieres the **squidclient** package to be installed in addition to the _**Squid Web Proxy**_.
+
---
### Want to Contribute?
@@ -34,25 +32,34 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut
---
### 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>
-| State | condition | WATO |
-| ------ | ------ | ------ |
-| WARN | condition 1 | yes |
-| CRIT | condition 2 | no |
-| WARN/CRIT | condition 3 | no |
+| State | Counter | condition | WATO |
+| ----- | ----- |------ | ------ |
+| WARN/CRIT | Client Requests | not in levels | yes |
+| WARN/CRIT | Client Hits | not in levels | yes |
+| 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><summary>Perfdata</summary>
-| Metric | Unit | Perfometer |
-| ------ | ------ | ------ |
-| METRIC 1 | bit/s | yes |
-| METRIC 2 | C | yes |
-| METRIC 3 | V | no |
+| Metric | Unit | Perfometer |
+| ------ | ------ | ------ |
+| Client requests | 1/s | no |
+| Client errors | 1/s | 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>
@@ -60,43 +67,35 @@ The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT wi
### WATO
<details><summary>Service monitoring rule</summary>
-| Section | Rule name |
-| ------ | ------ |
-| Networking | NAME_OF_THE_RULE |
+| Section | Rule name |
+| ------ | ------ |
+| Applications, Processes & Services | Squid Web Proxy |
-| Option | Defailt value |
-| ------ | ------ |
-| OPTION 1 | 10/50|
-| OPTION 2 | 70/90 |
-| OPTION 3 | CHOICE 1 |
-| OPTION 4 | disabled |
+| Option | Defailt value | Predictive |
+| ------ | ------ | ---------- |
+| Set levels for Client Requests | none | optional |
+| Set levels for Client Hits | none | optional |
+| Set levels for Server Requests | none | optional |
+| Set levels for Squid CPU usage | 60.0/80.0 | optional |
+| Set levels for DNS response time | 2.0/4.0 | no |
</details>
-<details><summary>Discovery rule</summary>
+<details><summary>Bakery rule</summary>
-| Section | Rule name |
-| ------ | ------ |
-| Discovery of individual services | NAME_OF_THE_RULE |
+| Section | Rule name |
+| ------ | ------ |
+| Agent rules | Squid Web Proxy (Linux) |
-| Option | Defailt value |
-| ------ | ------ |
-| OPTION 1 | disabled |
+| Option | Defailt value |
+| ------ | ------ |
+| Port number | 3128 |
</details>
-<details><summary>HW/SW inventory rules</summary>
-The inventory plugin is not configurable.
-</details>
-
---
### Sample Output
Sample output
-
-Sample output details
-
-
-
--
GitLab