No description
Find a file
Thorben Günther 7a6b7c9cdb
cache: Take alert status (firing, resolved) into account
Otherwise a resolved alert would not trigger a notification, since its
fingerprint - which is a generated hash from the labels - remains the
same.
2023-02-08 20:41:05 +01:00
docker Add version flag 2023-01-16 14:35:53 +01:00
.build.yml Add version flag 2023-01-16 14:35:53 +01:00
.gitignore Add version flag 2023-01-16 14:35:53 +01:00
cache.go cache: Take alert status (firing, resolved) into account 2023-02-08 20:41:05 +01:00
config.go cache: Add config options for duration and cleanup interval 2023-02-08 20:41:03 +01:00
config_test.go cache: Add config options for duration and cleanup interval 2023-02-08 20:41:03 +01:00
functions.go Support ntfy tags 2022-10-12 17:04:44 +02:00
go.mod Upgrade dependencies 2022-10-13 01:15:04 +02:00
go.sum Upgrade dependencies 2022-10-13 01:15:04 +02:00
LICENSE Initial commit 2022-10-09 14:19:48 +02:00
main.go cache: Take alert status (firing, resolved) into account 2023-02-08 20:41:05 +01:00
README.md cache: Add config options for duration and cleanup interval 2023-02-08 20:41:03 +01:00

ntfy-alertmanager

builds.sr.ht status

A bridge between ntfy and Alertmanager.

Installation

Simply use go build or the docker image with docker-compose file. ntfy-alertmanager:latest is built from the latest tagged release while ntfy-alertmanager:dev is built from the master branch.

Configuration

You can specify the configuration file location with the --config flag. By default the configuration file will be read from /etc/ntfy-alertmanager/config. The format of this file is scfg.

ntfy-alertmanager has support for setting ntfy priority and tags. Define a decreasing order of labels in the config file and map those labels to tags or priority.

  • For priority the first found value will be chosen.
  • Tags are added together.

Example:

# http listen address
http-address :8080
# Log level (either debug, info, warning, error)
log-level info
# When multiple alerts are grouped together by Alertmanager, they can either be sent
# each on their own (single mode) or be kept together (multi mode) (either single or multi; default is single)
alert-mode single
# Optionally protect with HTTP basic authentication
user webhookUser
password webhookPass

labels {
    order "severity,instance"

    severity "critical" {
        priority 5
        tags "rotating_light"
    }

    severity "info" {
        priority 1
    }

    instance "example.com" {
        tags "computer,example"
    }
}

ntfy {
    # URL of the ntfy topic - required
    topic https://ntfy.sh/alertmanager-alerts
    # ntfy access control (https://ntfy.sh/docs/config/#access-control)
    user user
    password pass
}

# When the alert-mode is set to single, ntfy-alertmanager will cache each single alert
# to avoid sending recurrences.
cache {
    # How long messages stay in the cache for
    duration 24h
    # Interval in which the cache is cleaned up
    cleanup-interval 1h
}

Alertmanager config

receivers:
    - name: "ntfy"
      webhook_configs:
          - url: "http://127.0.0.1:8080"
            http_config:
                basic_auth:
                    username: "webhookUser"
                    password: "webhookPass"

Contributing

Report bugs on the issue tracker.