Skip to main content

A command-line assistant for acknowledging and managing Nagios Core alerts.

Project description

mozzo

A lightweight CLI for acknowledging and managing Nagios Core alerts and reporting via its native CGI scripts.

Flake8 Lint Run Tests PyPI version

About

Mozzo interacts with Nagios Core (4.x) via cmd.cgi and statusjson.cgi using standard HTTPS requests. It allows you to acknowledge alerts, schedule downtime, generate service/host uptime reporting and view statuses without needing to install specialized Nagios libraries or scrape HTML.

[!NOTE] This is compatible with Nagios Core 4.4.x and hasn't been tested with 4.5.x but will probably work.

Table of Contents

Installation

Option 1: Run from Source (Standalone)

You can clone the repository and run the script directly:

git clone https://github.com/sadsfae/mozzo.git
cd mozzo
chmod +x mozzo.py
./mozzo.py --help

Option 2: Install via pip

Install globally or in a virtual environment to make the mozzo command available anywhere:

git clone https://github.com/sadsfae/mozzo.git
cd mozzo
pip install .
mozzo --help

Option 3: Install via Pypi

python -m venv mozzo
. !$/bin/activate
pip install mozzo

Configuration

Mozzo requires a configuration file named config.yml. It will search for this file in the following order:

  1. ~/.config/mozzo/config.yml
  2. ./config.yml (Current directory)
  3. /etc/mozzo/config.yml

[!TIP] Copy the example config.yml and edit it first.

mkdir -p ~/.config/mozzo
curl -s -o ~/.config/mozzo/config.yml https://raw.githubusercontent.com/sadsfae/mozzo/refs/heads/main/config.yml
vim ~/.config/mozzo/config.yml

Your config.yml needs the following structure:

nagios_server: https://nagios.example.com
nagios_cgi_path: /nagios/cgi-bin
nagios_username: nagiosadmin
nagios_password: mysecurepassword
default_downtime: 120 # in minutes
default_reporting_days: 365 # in days
verify_ssl: false
date_format: "%m-%d-%Y %H:%M:%S"

Usage

[!IMPORTANT] You can run mozzo (if installed) or ./mozzo.py or python mozzo.py (if running from source).

View Nagios Process Status

mozzo --status

List Unhandled or Alerting services

mozzo --unhandled

List Service Issues

mozzo --service-issues [ --host host.example.com ]

Acknowledge a Specific Service

mozzo --ack --host host01.example.com --service "HTTP"

Acknowledge a Host and all its Services

mozzo --ack --host host01.example.com --all-services

[!TIP] You can pass --days including a float value for downtime, otherwise the value in config.yml is used.

Acknowledge All Alerting Services

Acknowledge all WARNING, CRITICAL, and UNKNOWN services across all hosts that are not already acknowledged, in downtime, or have notifications disabled.

mozzo --ack --all

List Acknowledgement History for a Service

mozzo --host host01.example.com --service "HTTP" --ack-history

List Acknowledgement History for a Host

mozzo --host host01.example.com --ack-history

List Acknowledgement History for a Custom Timeframe

mozzo --host host01.example.com --ack-history --days 30

Set Downtime for a Specific Host

mozzo --set-downtime --host host01.example.com
mozzo --set-downtime --host host01.example.com --days 0.5

Set Downtime for a Host and all its Services

mozzo --set-downtime --host host01.example.com --all-services

Set Downtime for a Specific Service

mozzo --set-downtime --host host01.example.com --service "HTTP"
mozzo --set-downtime --host host01.example.com --service "HTTP" --days 2

Disable Alerting for a Specific Service

mozzo --disable-alerts --host host01.example.com --service "HTTP"

Disable Alerting for all Services on a Host

mozzo --disable-alerts --host host01.example.com --all-services

Enable Alerting for all Services on a Host

mozzo --enable-alerts --host host01.example.com --all-services

Enable Alerting for a Specific Service

mozzo --enable-alerts --host host01.example.com --service "HTTP"

Toggle Global Alerts

mozzo --disable-alerts
mozzo --enable-alerts

Setting Ack or Downtime with a Custom Message

mozzo --ack --host host01.example.com --message "Acknowledged per ticket INC-12345"
mozzo --set-downtime --host host01.example.com --all-services -m "Patching window"

Acknowledging all Unhandled Issues

  • This bash one-liner can ack all unhandled issues in one swoop.
mozzo --unhandled | grep -E -i "critical|warning" | while read -r level host arrow service; do mozzo --ack --host "$host" --service "$service"; done

Listing all Services by Host

mozzo --status --host host01.example.com

Listing Service Details by Host

mozzo --status --host host01.example.com --service "DNS"

Listing Service Details on All Hosts

mozzo --status --service "DNS"

Listing Service Details with Output

To show DNS results for all hosts that have the service:

mozzo --status --service "DNS" --show-output

To show DNS results for a specific host that has the service:

mozzo --status --host host01.example.com --service "DNS" --show-output

Listing Service Details with Filter

  • You can filter results by passing a human-readable status to --output-filter.
  • Valid options are: PENDING, OK, WARNING, UNKNOWN, and CRITICAL. (Filters are case-insensitive).

To show DNS results for all hosts that have the service in a CRITICAL state:

mozzo --status --service "DNS" --output-filter CRITICAL

To show DNS results for a specific host that has the service in a CRITICAL state, while also showing the plugin output:

mozzo --status --host host01.example.com --service "DNS" --show-output --output-filter critical

[!TIP] Use --show-output to see the Nagios plugin's full details

Further, you can combine them all to show full plugin output for all DNS failures:

mozzo --status --service "DNS" --output-filter CRITICAL --show-output

Viewing Nagios Logs

View Nagios alert logs from the last 24 hours:

mozzo --log

View logs for a custom time range:

mozzo --log --days 7

View logs for the last 12 hours:

mozzo --log --days 0.5

View raw log including state dumps (for debugging):

mozzo --log --full

[!NOTE] On busy servers, --log may take 1-2 minutes as it downloads the full log file. Use shell pipes to limit output: mozzo --log | head -n 100

Service Reporting and Uptime

  • We also support reporting for uptime per host and per service based on Nagios archivejson.cgi

Uptime Reporting

[!NOTE] Default uptime reporting uses default_reporting_days from config.yml

Default is 365 days unless you specify --days

Report Uptime by Service

mozzo --status --host host01.example.com --service "DNS" --uptime --days 180

Report Uptime by Host

mozzo --status --host host01.example.com --uptime

Exporting Report Data

  • You can export in both JSON and CSV
mozzo --status --host host01.example.com --service "DNS" --uptime --format json > /tmp/host01_dns.json
mozzo --status --host host01.example.com --service "HTTP" --uptime --format csv > /tmp/host01_http.csv

Contributing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mozzo-0.12.2.tar.gz (57.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mozzo-0.12.2-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

Details for the file mozzo-0.12.2.tar.gz.

File metadata

  • Download URL: mozzo-0.12.2.tar.gz
  • Upload date:
  • Size: 57.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mozzo-0.12.2.tar.gz
Algorithm Hash digest
SHA256 e348a1792e1c4d5f6a01df96ee4bd2da2bab76181f3bdb965916d4c0823c0e67
MD5 68703d5d93dc1287b7cae5a635433487
BLAKE2b-256 f9fc9519e9dbc104ceb33e69a2d0f9fe75fcf483229d405e17141b95dd064d43

See more details on using hashes here.

File details

Details for the file mozzo-0.12.2-py3-none-any.whl.

File metadata

  • Download URL: mozzo-0.12.2-py3-none-any.whl
  • Upload date:
  • Size: 39.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mozzo-0.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 374923595a58fe71bcb8ba2f74bc0e2d61a05dd506746f3261715bff15742581
MD5 85e6b680a71e0d5e6d0280962f11553a
BLAKE2b-256 92f5dd783f732010ea82ed35a98ef5ff571b7779d247a096aca10bade55d64b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page