Alerts contact points
To manage contact points, click the Alerts tab, and select Contact points sub-menu.
The Contact points interface appears.
-
Selectors are for bulk actions, such as Delete.
-
List of all alerts in the system.
Includes:
-
Selectors for bulk actions
-
Contact point name that you define when you Add a contact point
-
Type of contact point you choose when you Add a contact point
The options are:
-
(Email)
-
(PagerDuty)
-
(Slack)
-
(Microsoft Teams)
-
(Webhook)
-
(Google Chat)
-
(OpsGenie)
-
-
-
For specific contact points, hover over the table row, and:
-
Click
(Edit) to change the definition of an existing contact point.
-
Click
(Delete) to remove the contact point from the system; see Delete contact point.
-
Add a contact point
To add a new contact point, follow these steps:
-
Click
(Add New Contact Point).
-
The Create Contact points interface appears.
-
Start by specifying the Contact point name.
-
[Optional] Specify Choose mute timing from the drop-down; see Mute timing for alerts for details.
-
Choose contact point type.
By default, the contact point is an Email. The other options are PagerDuty, Slack, Microsoft Teams, Webhook, Google Chat, and OpsGenie.
-
Depending on the contact point type, specify the settings.
To format subject, body of message, and similar fields, you can use the GO Templating Language.
-
Email
-
PagerDuty
-
Slack
-
Microsoft Teams
-
Webhook
-
Google Chat
-
OpsGenie
Required field:
- Addresses
-
Use one or more email addresses.
For multiple addresses, separate using a comma (,), a semicolon (;), or end of line (\n). Avoid spaces.
Optional fields:
- Single email
-
Select to have all recipients on the To line.
- Message
-
Plain text, or format with GO Templating Language.
A custom message in the Alert configuration replaces this default.
- Subject
-
Plain text, or format with GO Templating Language.
Required field:
- Integration Key
-
This is the PagerDuty integration key for your account.
Optional fields:
- Severity
-
Severity of the event: critical (default), error, warning, or info
Can use templates; see GO Templating Language.
- Class
-
The class or type of event, such as "cpu load", "ping failure", and so on
- Component
-
Component of the source responsible for the event, such as "mysql", "eth0", and so on
- Group
-
Logical grouping of service component, such as "app-stack"
- Summary
-
Summarize content. Can use templates in GO Templating Language.
- Source
-
Location of the affected system, such as hostname or FQDN
- Client
-
Monitoring client that triggers this event
- Client URL
-
URL of the monitoring client
- Details
-
A set of key/value pairs that provide further details about the incident.
Required fields:
To authenticate, use either a combination of Recipient and Token, or the Webhook URL.
- Recipient
-
Channel, private group, or IM channel (encoded ID or name)
- Token
-
Slack API token that starts with
xoxb
- Webhook URL
-
Incoming webhook URL for sending messages
Optional fields:
- Username
-
Username for the bot’s message
- Icon emoji
-
An emoji icon for the bot’s message; overrides the icon URL
- Icon URL
-
URL to image source icon for the bot’s message
- Mention Users
-
One or more users, in a comma-separated list, to notify in a channel, by ID
You can copy this from the user’s Slack profile.
- Mention Groups
-
One or more groups, in a comma-separated list, to notify in a channel, by ID
You can copy this from the group’s Slack profile URL.
- Mention Channel
-
Select one of the options from the drop-down:
-
Disabled
-
Every active channel member
-
Every channel member
-
- Endpoint URL
-
A custom Slack message API endpoint for non-webhook requests
Default is
https://slack.com/api/chat.postMessage
.
- Title
-
Templated title of the Slack message
- Text Body
-
Body of the Slack message
Required field:
- URL
-
Teams incoming webhook URL
Optional fields:
- Title
-
Templated title of the Teams message
- Second Title
-
Section title for the Teams message
Leave blank for none.
- Message
-
Templated body of the message
Required field:
- URL
-
The URL of the alert
Optional fields:
- HTTP Method
-
Choose one of:
-
POST
-
PUT
-
- HTTP Basic Authentication - Username
-
Username for basic HTTP authentication
- HTTP Basic Authentication - Password
-
Password for basic HTTP authentication
- Authorization Header - Scheme
-
Scheme for the authorization request header
Default is
Bearer
.
- Authorization Header - Credentials
-
Credentials for the authorization request header
You can set either HTTP Basic Authentication, or Authorization Request Header.
- Max Alerts
-
Maximum number of alerts to include in a notification
The system ignores additional alerts in the same batch. Value of
0
means that there is no limit on alerts.
- Title
-
Templated title of the message
- Message
-
Custom message
You can use template variables.
Required field:
- URL
-
Google Chat incoming webhook URL
Optional fields:
- Title
-
Templated title of the message
- Message
-
Body of the message of the
Required fields:
- API Key
-
OpsGenie API key
- Alert API URL
-
The URL of the alerts, such as
https://api.opsgenie.com/v2/alerts
Optional fields:
- Message
-
Alert text; can be plain text, or use format templates
Limited to 130 characters
- Description
-
Description of the incident
- Auto close incidents
-
When selected, automatically closes alerts in OpsGenie after alert status returns to ok
- Override priority
-
When selected, enables the user to set alert priority using
og_priority
annotation
- Send notification tags as
-
Sends the common annotations to OpsGenie as Tags, Extra Properties, or Tags & Extra Properties
- Responders
-
ID
ornames
of alert responders, with qualifying types (team
,user
,escalation
, orschedule
)
-
-
Click
(Test) to validate the configuration of the contact point.
-
Finalize the configuration by clicking
(Save contact point).
Add another configuration to the contact point
Organizations often have several communication methods, so you can establish multiple contact point types, or different alerting options depending on the roles of users and groups. You can therefore create several different contact point implementations, configure them differently, and have Kloudfuse group and manage them as a set, under the same contact point name.
-
Click
(Add another) to begin configuring another contact point, as described in the section Add a contact point.
-
Click
(Test) to ensure that the contact point works.
-
Click
(Save contact point).
-
[Optional] When working with multiple contact point definitions at the same time, a
(Delete) option appears for each contact point definition.
-
The new contact point appears in the list, with all specified types.