Alertmanager (alertmanager)
Groups, silences and routes the platform alerts to email and webhook receivers.
Generated from catalog/services/alertmanager.yaml: do not edit by hand.
Summary
| Version | 0.28.1 |
| Use | install and configure, configure and connect |
| Layer | functional (AI catalog) |
| Category | Observability |
| Installation methods | binary |
| External connection | no |
| Sandbox only | no |
Licence
| SPDX identifier | Apache-2.0 |
| Licence policy | core licence (MIT or Apache-2.0) |
| Licence exception | - |
| Platform component | alertmanager |
Packages and artifacts
A package the project of the service publishes (its image, its binary archive, its Python or OS package) carries the licence of the service; a third-party package carries the licence written on its row, read from the official upstream metadata.
| Kind | Package | Version | Licence | Details |
|---|---|---|---|---|
| binary archive | alertmanager-0.28.1.linux-amd64.tar.gz | 0.28.1 | Apache-2.0 | https://github.com/prometheus/alertmanager/releases/download/v0.28.1/alertmanager-0.28.1.linux-amd64.tar.gz, x86_64, checksum sha256 |
Supported systems and architectures
| Method | Operating systems | Architectures |
|---|---|---|
binary | RHEL family (dnf), Debian family (apt), Arch Linux (pacman) | x86_64 (architecture of the artifacts of the descriptor) |
Certified host systems: RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). The host preflight accepts these systems (other releases of a known family give a warning, end of life releases are refused) and the x86_64 and aarch64 architectures.
Prerequisites
Host
The descriptor declares no host preflight check.
Programs the commands and checks of the service start on the host, outside the managed roots: add them to allowed_commands of the agent (see Security of the Navin agent), else the agent refuses them with command_not_allowed: /usr/bin/curl.
Network and ports
| Component | Port name | Port | Opened in the host firewall |
|---|---|---|---|
alertmanager | http | 9093/tcp | yes |
alertmanager | cluster | 9094/tcp | yes |
Services and connections needed
This service has no dependency.
Installation methods and modes
| Method | Default | What the method uses |
|---|---|---|
binary | yes | the binary archives of the descriptor, unpacked under the service directory |
Components
| Component | Kind | Installation methods | Ports |
|---|---|---|---|
Alertmanager (alertmanager) | master | binary | 9093/tcp, 9094/tcp |
Single (single) (default)
One Alertmanager.
What the mode deploys:
| Component | Placement |
|---|---|
alertmanager | min 1, max 1 |
Cluster (cluster)
Three members sharing silences and notifications by gossip.
What the mode deploys:
| Component | Placement |
|---|---|
alertmanager | min 3, odd number, recommended 3 |
Install this service
The install wizard of the Navin Manager plans, validates and runs the installation; you need the services:install permission on the cluster.
-
Open the wizard. In Clusters, choose the row action Install services of the target cluster. The wizard opens on its first step, Service.
-
Choose the service. On the Service step, select Alertmanager. The card shows the licence
Apache-2.0. -
Choose the hosts and the mode. On the Hosts step, tick the hosts, then choose the Mode:
single(default),cluster. Each mode deploys the components listed in Installation methods and modes. -
Bindings. This service has no dependency: the Bindings step has nothing to bind.
-
Configure. On the Configure step, review the parameters (see Configuration parameters). Passwords left empty with a generated default are generated and sealed by the Manager.
-
Review and install. On the Install step the Manager validates the plan and shows the installation order; when it says "The plan is valid. Ready to install.", choose Install. A highly available mode is installed only when its HA checks pass.
-
Verify. The operation ends when the health checks of every instance pass (see Health checks); the service then shows as running in Services.
Connect an existing service
| Schemes | https, http |
| Default port | 9093 |
| Authentication | optional |
| Health check | /-/healthy |
| Authentication method | Fields | Description |
|---|---|---|
basic | username, password | Users of the web configuration file (--web.config.file, basic_auth_users hashed with bcrypt). |
client_certificate | client_cert, client_key | Client certificate required by tls_server_config (client_auth_type RequireAndVerifyClientCert). |
none | - | Default of Alertmanager: no authentication, keep it on a filtered internal network. |
Official documentation: https://prometheus.io/docs/alerting/latest/https/
High availability
| Cluster | native (native) |
| High availability | native (native) |
| Failover | client side (client) |
| Replication | native (native) |
| Quorum | gossip (gossip) |
| Discovery | static (static) |
| Entry point | client discovery (client-discovery) |
| Official documentation | https://prometheus.io/docs/alerting/latest/high_availability/ |
| Peer TLS parameter | tls_enabled |
| Cluster status command | status |
Topology per mode
| Modes | Highest catalog level | Distribution | Quorum component | Fault domains | Description |
|---|---|---|---|---|---|
single | standalone (standalone) | single (single) | - | 1 | One instance, no fault tolerance. |
cluster | cluster (cluster) | active-active (active-active) | - | 3 | Three members sharing silences and the notification log by gossip; Prometheus sends every alert to every member. |
Notes
- Prometheus must list every Alertmanager member, never a load balancer in front of them: the members deduplicate the notifications themselves.
Configuration parameters
Network
| Parameter | Type | Default | Allowed values | Required | Secret | Restart | Description |
|---|---|---|---|---|---|---|---|
HTTP port (port) | port | 9093 | - | no | no | no | Port of the API and user interface. |
Gossip port (cluster_port) | port | 9094 | - | no | no | no | Port of the gossip protocol between cluster members. |
TLS (tls_enabled) | bool | false | - | no | no | no | Serve the API and the interface over HTTPS (--web.config.file) with a certificate issued by the manager CA and, in cluster mode, protect the gossip between members with mutual TLS (--cluster.tls-config, TCP only). |
Routing
| Parameter | Type | Default | Allowed values | Required | Secret | Restart | Description |
|---|---|---|---|---|---|---|---|
Email recipients (email_to) | string | (empty) | - | no | no | no | Comma separated addresses; empty disables the email receiver. |
SMTP relay (smtp_smarthost) | string | localhost:25 | - | no | no | no | host:port of the bank mail relay. |
Sender (smtp_from) | string | alertmanager@localhost | - | no | no | no | From address of the alert emails. |
Webhook URL (webhook_url) | string | (empty) | - | no | no | no | Receiver called with every alert group; empty disables it. |
Endpoints
| Endpoint | Scheme | Component | Port | Path | TLS parameter | Binding parameters | Binding secrets | Provisioning command |
|---|---|---|---|---|---|---|---|---|
http | http | alertmanager | 9093 (port) | - | tls_enabled | - | - | - |
Commands
| Command | Component | Target | Description |
|---|---|---|---|
Cluster status (status) | alertmanager | every host | Shows the status and the peers of every member. |
Reload (reload) | alertmanager | every host | Reloads the configuration without restart. |
Health checks
Liveness (per instance)
| Component | Check | Details |
|---|---|---|
alertmanager | HTTP {{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn if config.tls_enabled else (host.ip or '127.0.0.1') }}:{{ config.port }}/-/healthy | Expected 200; 30 retries; interval 1 s; timeout 3 s |
Preflight checks
| Check | Type | Meaning | Severity | Components |
|---|---|---|---|---|
port_free | port_free {"param": "port"} | port 9093 free on the host | blocking | every component |
Uninstall
Paths removed when the data is purged: {{ paths.data }}, {{ paths.log }}.
Quick links
- Alertmanager interface:
{{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn }}:{{ config.port }}/
Upstream documentation
- Homepage: https://prometheus.io
- Source: https://github.com/prometheus/alertmanager
- High availability: https://prometheus.io/docs/alerting/latest/high_availability/
- Authentication: https://prometheus.io/docs/alerting/latest/https/