Example

Let's say we need check every 5 seconds that podkosa.github.io/moni/ is up and returns a 2xx response. And if something is wrong, let's alert to standard STDOUT. Looks simple enough! For that we consulted our Moni Handbook and found a PingChecker and a ConsoleHandler.
Let's create a settings.yml file in the project directory and fill it as we go.

Security

This file will include your sensitive data, so be sure to take security measures

Containerization

If you're deploying inside a container (e.g. Docker), be sure to mount ./settings.yml:/moni/settings.yml through volumes

API key

Bot endpoints are protected with an API key. Pass it as a cookie, header or query parameter named access_token with you requests to Moni.

settings.yml

api_key: key

Integrations

Various integrations (like Slack and Telegram) use their own authentications methods and are not dependent on the Moni API key. Consult Integrations section for more info.

Checker

settings.yml

checkers:
  ping:
    servers:
      host1.com:
        endpoint: path/to/ping/
        protocol: 'https'
        cycle: 300
        handlers: [console]

Here we have a basic configurations of a Checker. Top level checkers must include named Checkers. For our example we chose a PingChecker, so we defined ping.
Next we need to define our servers. They consist of key:value pairs that represent host:config.

Handler

Now let's define a Handler, so Moni knows how to alert you if something goes wrong. For this example we keep it simple and just print out to STDOUT with ConsoleHandler, so we simple defined console. This simple handler doesn't require additional settings, so let's move on.

settings.yml

handlers:
  console:

Watchdog

With all of the above set, we have one last step to take (or rather one last to throw). Defining our Watchdog, that will run checks periodically.

settings.yml

watchdog:
  integrated: true

Watchdog

Consult Watchdog section for more details on this good pupper.

Starting up Moni

All set! Just start up Moni and you'll see something like:

Bash Session

INFO:     Started server process [1]
INFO:     Waiting for application startup.
Watchdog is running
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:80 (Press CTRL+C to quit)

Moni is up and Watchdog is already running your checks. When our host will not response, you'll see a message with details on what went wrong.

Bash Session

2022-10-31 12:00:00 PingChecker(podkosa.github.io) Cannot connect to host podkosa.github.io:443 ssl:default [Name or service not known]
2022-10-31 12:05:00 PingChecker(podkosa.github.io) 404, message='Not Found', url=URL('https://podkosa.github.io/moni/')
...