Add the forwarder to your project with:
npm i @sakuli/forwarder-checkmkIt is assumed that the client is already monitored by checkmk and that an agent is installed and running on it.
Create a new folder spool in the installation path of the checkmk agent. This is the folder where the results will be written and stored into. Don’t forget to grant writing permissions for the folder to the user running Sakuli checks.
Now you have to set up the properties for the checkmk receiver. In order to do this, edit the sakuli.properties in the folder containing the testsuites:
| Property | Default | Effect |
|---|---|---|
sakuli.forwarder.check_mk.enabled |
false |
Enables writing to the spool file |
sakuli.forwarder.check_mk.spooldir |
/var/lib/check_mk_agent/spool (Linux)<CMK_installation_path>\\spool (Windows) |
Path to the spool folder as defined above. On Windows, the backslashes have to be escaped with ‘'. Check_MK is expecting the result files from Sakuli in here |
sakuli.forwarder.check_mk.freshness |
600 |
Defines the maximal age in seconds for which the result is still valid. If the last modification of the result file is older than this property, the result file will be ignored. The Check_MK service will turn into UNKNOWN |
sakuli.forwarder.check_mk.spoolfile_prefix |
sakuli_suite_ |
Defines the result file prefix. It can be used to change the default naming convention for the Check_MK output files |
sakuli.forwarder.check_mk.service_description |
${testsuite.id} |
Defines the service description which is used within the check result |
sakuli.forwarder.check_mk.piggyback_hostname |
local |
Defines Hostname for check results, configurable for piggyback results |
sakuli.forwarder.check_mk.output.details |
true |
Dis- / Enables detailed HTML output |
sakuli.forwarder.check_mk.section_name |
local |
Name of the reported section (<<<YOUR_SECTION_NAME>>>) |
sakuli.forwarder.check_mk.url |
URL address to add to the spool file (Available from version 2.3.0) |
An example configuration could look like this:
sakuli.forwarder.check_mk.enabled=true
sakuli.forwarder.check_mk.spooldir=/var/lib/check_mk_agent/spool
sakuli.forwarder.check_mk.freshness=600
sakuli.forwarder.check_mk.spoolfile_prefix=sakuli_suite_
sakuli.forwarder.check_mk.service_description=My_Custom_Service
sakuli.forwarder.check_mk.piggyback_hostname=MyHost