Monika Configuration

Monika configuration file

Type object
File match *monika*.yaml *monika*.yml monika.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/monika-configuration/latest.json
Source https://www.schemastore.org/monika-config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Monika monitoring configuration schema

Properties

probes object[]

Probe is a description of the target, methods, timing and payloads to begin monitoring/probing a target.

notifications object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object[]

Alerts of incidents and recoveries will be sent via these notification channels

db_limit object

Database internal configuration

3 nested properties
max_db_size number required

Maximum Monika database size

Default: 1000000000
deleted_data integer required

Delete strategy when limit reached

Default: 1
cron_schedule string required

Schedule to trim the db in crontab

Default: "*/1 * * * *"
status-notification string

Sends status notification periodically according to a cron schedule. Set to false to disable.

Default: "0 6 * * *"
certificate object

Check validity of your TLS certificate(s).

2 nested properties
domains string | object[] required

The list of domains to check

reminder integer

The number of days to send notification to user before the domain expires

Examples: 30
version string

Monika configuration version

Default: "1"

Definitions

urlFormat string
incidentThreshold integer

Number of times an alert should return true before Monika sends incident notifications

recoveryThreshold integer

Number of times an alert should return false before Monika sends recovery notifications

interval integer

The number of seconds to repeat the probe

postgres object[]

Monitor postgres readiness

redis object[]

Monitor redis health

mongo object[]

Monitor MongoDB health

mariadb object[]

Monitor MariaDB/Mysql health

ping object[]

The ICMP ping probe

requests object[]

The http or ping request to probe for

socket object

Socket is a TCP type request

host string required

Address to your host

port integer required

Host port to connect to

data string required

Data payload for the request

alerts object[]

The condition which will trigger an alert and the subsequent notification

body

The data bytes transmitted in an HTTP transaction message immediately following the headers if there are any

headers object

A list of strings sent and received by both the client program and server on every HTTP request and response

Accept string

Media type(s) that is/are acceptable for the response

Accept-Charset string

Character sets that are acceptable

Accept-Encoding string

List of acceptable encodings

Authorization string

Authentication credentials for HTTP authentication

Cache-Control string

Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain

Cookie string

An HTTP cookie previously sent by the server with Set-Cookie

Connection string

General header that allows the sender or client to specify options that are desired for that particular connection

Content-Type string

The Media type of the body of the request (used with POST and PUT requests

Keep-Alive string

General header used to inform how long a persistent connection should stay open

Origin string

Initiates a request for cross-origin resource sharing (asks server for Access-Control-* response fields)

Referer string

This is the address of the previous web page (referrer) from which a link to the currently requested page was followed

User-Agent string

The user agent string of the user agent