CheckMK Special Agent for Mailcow

Go to file

mellis 13258ae201 added debug decorator function and type hints		2024-01-17 15:15:55 +01:00
images	added images, extended Readme	2024-01-16 15:04:51 +01:00
local	added debug decorator function and type hints	2024-01-17 15:15:55 +01:00
mkp	MKP 1.1.4, bugfix for the last bugfix :-)	2023-09-22 16:19:53 +02:00
.gitignore	changed local repo	2024-01-16 14:31:53 +01:00
LICENSE	Initial commit	2023-08-19 13:46:16 +02:00
README.md	ReadMe fix	2024-01-16 15:36:58 +01:00

Mailcow-CheckMK

CheckMK Special Agent for Mailcow

Monitors various aspects of a Mailcow instance:

Email domains with quota usage, number of mailboxes, number of aliases

Mailboxes with quota usage, number of messages, last logins via IMAP/POP3/SMTP

You have to create an API Key for the MKP to work. Login to your Mailcow instance and go to

System|Configuration

Take a note of the section API, expand it and activate "Activate API" in the section "Read-Only Access"

Don't forget to insert the IP of your CheckMK instance into the textbox "Allow API access from these IPs/CIDR networks".

Tested only with dockerized versions of Mailcow

Tested with Mailcow version 2022-07a and higher

Please feel free to add other working environments via review/email.

Upload and enable the MKP
Apply changes
Click Setup, search for "Mailcow"
Click on "Mailcow Server Information" below "Other integrations"
Create a new rule and fill in all mandatory information (Hostname, API Key)
Adjust all other options to your needs
Bind this rule to your Mailcow host object (e.g. via "Explicit hosts")
If you have no host object at all, create a dummy host for this (with no IP or something like 127.0.0.2)
Assure that your agents settings for this host object are correct (must contain "Configured API integrations")
Apply your changes
Execute a service discovery on your Mailcow host(s) and accept the newly detected services
Feel free to adjust the various parameters for thresholds within the available parameter sections (Setup, "Service monitoring rules" after searching for "Mailcow")