Skip to main content
Version: v2.5

Receiver Configuration

The Alertmanager Config Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus.

This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see this section.

Creating Receivers in the Rancher UI​

Available as of v2.5.4

Prerequisites:

  • The monitoring application needs to be installed.
  • If you configured monitoring with an existing Alertmanager Secret, it must have a format that is supported by Rancher's UI. Otherwise you will only be able to make changes based on modifying the Alertmanager Secret directly. Note: We are continuing to make enhancements to what kinds of Alertmanager Configurations we can support using the Routes and Receivers UI, so please file an issue if you have a request for a feature enhancement.

To create notification receivers in the Rancher UI,

  1. Click Cluster Explorer > Monitoring and click Receiver.
  2. Enter a name for the receiver.
  3. Configure one or more providers for the receiver. For help filling out the forms, refer to the configuration options below.
  4. Click Create.

Result: Alerts can be configured to send notifications to the receiver(s).

Receiver Configuration​

The notification integrations are configured with the receiver, which is explained in the Prometheus documentation.

Native vs. Non-native Receivers​

By default, AlertManager provides native integration with some receivers, which are listed in this section. All natively supported receivers are configurable through the Rancher UI.

For notification mechanisms not natively supported by AlertManager, integration is achieved using the webhook receiver. A list of third-party drivers providing such integrations can be found here. Access to these drivers, and their associated integrations, is provided through the Alerting Drivers app. Once enabled, configuring non-native receivers can also be done through the Rancher UI.

Currently the Rancher Alerting Drivers app provides access to the following integrations:

Changes in Rancher v2.5.8​

Rancher v2.5.8 added Microsoft Teams and SMS as configurable receivers in the Rancher UI.

Changes in Rancher v2.5.4​

Rancher v2.5.4 introduced the capability to configure receivers by filling out forms in the Rancher UI.

The following types of receivers can be configured in the Rancher UI:

The custom receiver option can be used to configure any receiver in YAML that cannot be configured by filling out the other forms in the Rancher UI.

Slack​

FieldTypeDescription
URLStringEnter your Slack webhook URL. For instructions to create a Slack webhook, see the Slack documentation.
Default ChannelStringEnter the name of the channel that you want to send alert notifications in the following format: #<channelname>.
Proxy URLStringProxy for the webhook notifications.
Enable Send Resolved AlertsBoolWhether to send a follow-up notification if an alert has been resolved (e.g. [Resolved] High CPU Usage).

Email​

FieldTypeDescription
Default Recipient AddressStringThe email address that will receive notifications.
Enable Send Resolved AlertsBoolWhether to send a follow-up notification if an alert has been resolved (e.g. [Resolved] High CPU Usage).

SMTP options:

FieldTypeDescription
SenderStringEnter an email address available on your SMTP mail server that you want to send the notification from.
HostStringEnter the IP address or hostname for your SMTP server. Example: smtp.email.com.
Use TLSBoolUse TLS for encryption.
UsernameStringEnter a username to authenticate with the SMTP server.
PasswordStringEnter a password to authenticate with the SMTP server.

PagerDuty​

FieldTypeDescription
Integration TypeStringEvents API v2 or Prometheus.
Default Integration KeyStringFor instructions to get an integration key, see the PagerDuty documentation.
Proxy URLStringProxy for the PagerDuty notifications.
Enable Send Resolved AlertsBoolWhether to send a follow-up notification if an alert has been resolved (e.g. [Resolved] High CPU Usage).

Opsgenie​

FieldDescription
API KeyFor instructions to get an API key, refer to the Opsgenie documentation.
Proxy URLProxy for the Opsgenie notifications.
Enable Send Resolved AlertsWhether to send a follow-up notification if an alert has been resolved (e.g. [Resolved] High CPU Usage).

Opsgenie Responders:

FieldTypeDescription
TypeStringSchedule, Team, User, or Escalation. For more information on alert responders, refer to the Opsgenie documentation.
Send ToStringId, Name, or Username of the Opsgenie recipient.

Webhook​

FieldDescription
URLWebhook URL for the app of your choice.
Proxy URLProxy for the webhook notification.
Enable Send Resolved AlertsWhether to send a follow-up notification if an alert has been resolved (e.g. [Resolved] High CPU Usage).

Custom​

The YAML provided here will be directly appended to your receiver within the Alertmanager Config Secret.

Teams​

Enabling the Teams Receiver for Rancher Managed Clusters​

The Teams receiver is not a native receiver and must be enabled before it can be used. You can enable the Teams receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the Teams option selected.

  1. In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click Cluster Explorer.
  2. Click Apps.
  3. Click the Alerting Drivers app.
  4. Click the Helm Deploy Options tab
  5. Select the Teams option and click Install.
  6. Take note of the namespace used as it will be required in a later step.

Configure the Teams Receiver​

The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration.

[Microsoft Teams]
teams-instance-1: https://your-teams-webhook-url

When configuration is complete, add the receiver using the steps in this section.

Use the example below as the URL where:

  • ns-1 is replaced with the namespace where the rancher-alerting-drivers app is installed
url: http://rancher-alerting-drivers-prom2teams.ns-1.svc:8089/v2/teams-instance-1

SMS​

Enabling the SMS Receiver for Rancher Managed Clusters​

The SMS receiver is not a native receiver and must be enabled before it can be used. You can enable the SMS receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the SMS option selected.

  1. In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click Cluster Explorer.
  2. Click Apps.
  3. Click the Alerting Drivers app.
  4. Click the Helm Deploy Options tab
  5. Select the SMS option and click Install.
  6. Take note of the namespace used as it will be required in a later step.

Configure the SMS Receiver​

The SMS receiver can be configured by updating its ConfigMap. For example, the following is a minimal SMS receiver configuration.

providers:
  telegram:
    token: 'your-token-from-telegram'

receivers:
- name: 'telegram-receiver-1'
  provider: 'telegram'
  to:
    - '123456789'

When configuration is complete, add the receiver using the steps in this section.

Use the example below as the name and URL, where:

  • the name assigned to the receiver, e.g. telegram-receiver-1, must match the name in the receivers.name field in the ConfigMap, e.g. telegram-receiver-1
  • ns-1 in the URL is replaced with the namespace where the rancher-alerting-drivers app is installed
name: telegram-receiver-1
url http://rancher-alerting-drivers-sachet.ns-1.svc:9876/alert

Configuring Multiple Receivers​

By editing the forms in the Rancher UI, you can set up a Receiver resource with all the information Alertmanager needs to send alerts to your notification system.

It is also possible to send alerts to multiple notification systems. One way is to configure the Receiver using custom YAML, in which case you can add the configuration for multiple notification systems, as long as you are sure that both systems should receive the same messages.

You can also set up multiple receivers by using the continue option for a route, so that the alerts sent to a receiver continue being evaluated in the next level of the routing tree, which could contain another receiver.

Example Alertmanager Configs​

Slack​

To set up notifications via Slack, the following Alertmanager Config YAML can be placed into the alertmanager.yaml key of the Alertmanager Config Secret, where the api_url should be updated to use your Webhook URL from Slack:

route:
  group_by: ['job']
  group_wait: 30s
  group_interval: 5m
  repeat_interval: 3h
  receiver: 'slack-notifications'
receivers:
- name: 'slack-notifications'
  slack_configs:
  - send_resolved: true
    text: '{{ template "slack.rancher.text" . }}'
    api_url: <user-provided slack webhook url here>
templates:
- /etc/alertmanager/config/*.tmpl

PagerDuty​

To set up notifications via PagerDuty, use the example below from the PagerDuty documentation as a guideline. This example sets up a route that captures alerts for a database service and sends them to a receiver linked to a service that will directly notify the DBAs in PagerDuty, while all other alerts will be directed to a default receiver with a different PagerDuty integration key.

The following Alertmanager Config YAML can be placed into the alertmanager.yaml key of the Alertmanager Config Secret. The service_key should be updated to use your PagerDuty integration key and can be found as per the "Integrating with Global Event Routing" section of the PagerDuty documentation. For the full list of configuration options, refer to the Prometheus documentation.

route:
 group_by: [cluster]
 receiver: 'pagerduty-notifications'
 group_interval: 5m
 routes:
  - match:
      service: database
    receiver: 'database-notifcations'

receivers:
- name: 'pagerduty-notifications'
  pagerduty_configs:
  - service_key: 'primary-integration-key'

- name: 'database-notifcations'
  pagerduty_configs:
  - service_key: 'database-integration-key'

Example Route Config for CIS Scan Alerts​

While configuring the routes for rancher-cis-benchmark alerts, you can specify the matching using the key-value pair job: rancher-cis-scan.

For example, the following example route configuration could be used with a Slack receiver named test-cis:

spec:
  receiver: test-cis
  group_by:
#    - string
  group_wait: 30s
  group_interval: 30s
  repeat_interval: 30s
  match:
    job: rancher-cis-scan
#    key: string
  match_re:
    {}
#    key: string

For more information on enabling alerting for rancher-cis-benchmark, see this section.

Trusted CA for Notifiers​

If you need to add a trusted CA to your notifier, follow the steps in this section.