README.md

[PACKAGE]: ../../raw/master/mkp/checkpoint_log_exporter-0.0.5-20230529.mkp "checkpoint_log_exporter-0.0.5-20230529.mkp"
# Log exporter agent plugin

This is a agent plugin to monitor the statrus of the Check Point log exporter `cp_log_export`.

---
### Download

* [Download latest mkp file][PACKAGE]

**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There might be incompatible changes.

---                   
### Installation

You can install the package by uploading it to your CheckMK site and as site user run 
```
mkp install PACKAGENAME-VERSION.mkp
```
or beginning with CMK2.2.x
```
mkp add PACKAGENAME-VERSION.mkp
mkp enable PACKAGENAME VERSION
```
In the non RAW editions of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_)

After you have installed the plugin you need to copy the agent plugin (`agents/plugins/checkpoint_log_exporter.sh`) to your checkmk agent plugins directory.

See here for more information on [how to use a Check Point appliance with the checkmk agent](doc/howto-install-cmk-agent.md). To add this plugin to your Checkmk agent installation see [here](doc/cp_log_exporter.md).

---
### Want to Contribute?
Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")

---
### Check Info

The plugin creates the service **_Log exporter_** with the **_name of the log exporter_** as item.

<details><summary>Montoring states</summary>

| State | condition | WATO | 
| ------ | ------ | ------ |
| WARN | if the exporter is not running | yes |
| WARN/CRIT | if the exporter is running, but has not read the log for 60/120 seconds | yes |

</details>

<details><summary>Perfdata</summary>

There are no perfdata

</details>

---
### WATO
<details><summary>Service monitoring rule</summary>

| Section | Rule name |
| ------ | ------ |
| Networking | Check Point log exporter  |

| Option | Defailt value |
| ------ | ------ |
| Maximum seconds not read | 60/120 seconds |
| State not running | WARN |

</details> 

<details><summary>Discovery rule</summary>

There is no discovery rule.

</details> 

---
### Sample Output

Sample output

![sample output](img/sample.png?raw=true "sample output")

Sample output details

![sample output details](img/sample-details.png?raw=true "sample output details")

<details><summary>Sample agent output</summary>

```
<<<checkpoint_log_exporter:sep(0)>>>

name: <REMOVED>
status: Not running
last log read at: 20 Jul 9:19:35
debug file: /opt/CPrt-R81.10/log_exporter/targets/<REMOVED>/log/log_indexer.elg

name: <REMOVED>
status: Running (77996)
last log read at: 13 Oct 14:40:54
debug file: /opt/CPrt-R81.10/log_exporter/targets/<REMOVED>/log/log_indexer.elg

name: <REMOVED>
status: Running (78617)
last log read at: 6 Dec 15:54:55
debug file: /opt/CPrt-R81.10/log_exporter/targets/<REMOVED>/log/log_indexer.elg
```


</details>