Monitoring

The monitoring service allows external monitoring tools to monitor the system state. The monitoring configuration can be configured from the “Monitoring settings” page (Admin ‣ monitoring)

Monitoring
Remote monitoring enabled

The monitoring service is only enabled if “Remote monitoring enabled” is checked.

IP filter

If set, only clients that connect from an approved IP address are allowed to access the monitoring service. The “IP filter” can be multiple IP addresses (comma separated) or an IP range in CIDR format. Example: 192.168.88.0/24, 10.0.0.16.

Password

The monitoring client should authenticate with the password.

The monitoring service should be accessible on URL:

https://Hostname/unprotected/monitor/Service?password=Password[&data=…]

Hostname

The hostname (or IP address) to monitor.

Service

The name of the service to check.

Password

The monitoring password

data

Optional data field.

The possible results from the service call:

OK

Service is working correctly. Optionally a number will be added indicating the value from the service call.

Warning

Service is in warning state. Optionally a number will be added indicating the value from the service call.

Critical

Service is in critical state. Optionally a number will be added indicating the value from the service call.

Unknown

Service is in unknown state (assume the service is in error state). Optionally a number will be added indicating the value from the service call.

Supported services

The following services are supported:

Certificate store size

The number of certificates from the certificate store.

Service

cert-store-size

Example: https://example.com/unprotected/monitor/cert-store-size?password=secret

Corrupted mail count

The number of corrupt emails from the corrupt email store.

Service

corrupted-mail-count

Example: https://example.com/unprotected/monitor/corrupted-mail-count?password=secret

CRL store size

The number of CRLs from the CRL store.

Service

crl-store-size

Example: https://example.com/unprotected/monitor/crl-store-size?password=secret

MPA queue size

The number of emails from the MPA queues.

Service

mpa-queue-size

data

queue={[error | outgoing | spool | respool]}

Example: https://example.com/unprotected/monitor/mpa-queue-size?password=secret&data={queue=spool}

MTA queue size

The number of emails from the MTA queues.

Service

mta-queue-size

Example: https://example.com/unprotected/monitor/mta-queue-size?password=secret

SMS queue size

The number of emails from the SMS queue.

Service

sms-queue-size

Example: https://example.com/unprotected/monitor/sms-queue-size?password=secret

User store size

The number of users.

Service

user-store-size

Example: https://example.com/unprotected/monitor/user-store-size?password=secret