Check out the new F5 Distributed Cloud Technical Knowledge Hub

Alerts - Webhook

Objective
Prerequisites
Configuration
Create Active Alert Policies
Concepts

Objective

This document provides instructions on how to configure alert notifications in F5® Distributed Cloud Services to route alert messages to your webhook. For information on alerts, see Alerts.

Prerequisites

A valid Account is required.

Note: If you do not have an account, see Create an Account.

A webhook.

Configuration

Configuring to send alerts requires you to create alert receiver, and policy in the F5® Distributed Cloud Console.

Alerts can be created in different services and namespaces. Alert functionality is available in Multi-Cloud Network Connect, Multi-Cloud App Connect, Web App & API Protection, Distributed Apps, Audit Logs and Alerts and Shared Configuration.

This example shows alert notifications for Webhook setup in Shared Configuration.

Step 1: Create Alert Policy.

Open F5 Distributed Cloud Console homepage, select Shared Configuration box.

Note: Homepage is role based, and your homepage may look different due to your role customization. Select All Services drop-down menu to discover all options. Customize Settings: Administration > Personal Management > My Account > Edit work domain & skills button > Advanced box > check Work Domain boxes > Save changes button.

Note: Confirm Namespace feature is in correct namespace, drop-down selector located in upper-left corner. Not available in all services.

Select Manage in left column menu > select Alerts Management > Alert Policies.

Note: If options are not showing available, select Show link in Advanced nav options visible in bottom left corner. If needed, select Hide to minimize options from Advanced nav options mode.

Select + Add Alert Policy button.

ALERTPOLICY2 2 2 — Figure: Alert Receiver

Step 2: Setup Alert Policy.

Enter Name.
Enter Labels and Description as needed.

Note: Toggle Show Advanced Fields to show Configure Receiver Default Notification Parameters.

Select Item in Alert Receivers drop-down menu in Alert Receivers Configuration box.
Select your Alert Receivers if available in list you created in Create Alert Receiver chapter.
Select + Add Item button in Alert Receivers page to Create Alert Receiver.

Note: + Add Item button in Alert Receivers Configuration box to add multiple Alert Receivers.

ALERTPOLICY 3 2 4 — Figure: Alert Policy Configuration

Step 3: Start configuring Alert Receiver.

Enter Name.
Enter Labels and Description as needed.
Select Webhook in Receiver drop-down menu.

Figure: Alert Receiver Name and Receiver Type
Select Configure link in Webhook URL box.

Figure: Alert Receiver

Select Secret Type in drop-down menu.
- Select Action in drop-down menu.
- Select Policy Type if needed,
- Enter Secret to Blindfold in box.
- Select Apply button.

WEBHOOKFORM3SECRET — Figure: Alert Receiver

Select Authentication drop-down menu option:
- None.
- Basic Authentication.
- Token Authentication.
- Enable TLS Wuth With Certificate Object.
Select TLS drop-down menu option:
- Enable
- Disable.
Select SNI Value drop-down menu option:
- SNI Value: SNI value to be used. Enter SNI Value in box below.
- No SNI: Do not use SNI.

ALERTS RECEIVER 10 2 2 4 — Figure: Alert Receiver

Select Server Verification drop-down menu option:
- Use Default Trusted CA List
- Use Custom CA List > select Certificate Object drop-down menu in Trusted CA List box.
Select Minimum TLS version drop-down menu option:
- Automatic, F5 Distributed Cloud will choose the optimal TLS version.
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
Select Maximum TLS version drop-down menu option:
- Automatic, F5 Distributed Cloud will choose the optimal TLS version.
- TLSv1.0
- TLSv1.1
- TLSv1.2
- TLSv1.3
Check Enable HTTP2 or Follow Redirects boxes if needed.
Select Contiue button.

Step 4: Setup Receiver Default Notification Parameters.

Toggle Show Advanced Fields in Alert Receiver Configuration box to Configure Receiver Default Notification Parameters.
- Select Configure link.

ALERTSADVANCED — Figure: Alert Policy Receiver

Toggle Show Advanced Fields in Notifications Parameters and Notifications Grouping and select notification intervals in boxes provided.
Confirm Notification Parameters and Notification Grouping is in two number format. Example: 60m not 1h.
Toggle Show Advanced Fields in Notification Grouping to show Group Notifications By drop-down menu.

Note: Update from default Individual if you want to receive alerts.
- Individual: This option disables grouping of alerts.
- F5XC Defined Group: Group the alerts by severity, group name and alert name.
- Custom: Specify set of labels for grouping the alerts.
- Default: Group the alerts by severity, group name and alert name.
Note: All fields must be in 2-digit form (60m, 60s) in Policy Rule Notification Parameters for intervals and group notifications for your policy rules to apply correctly and not error.
Select Apply button.

ALERTPOLICYPARAMETERS — Figure: Alert Policy Receiver

Step 5: Setup Policy Rules.

A minimum of one policy rule is populated by default with Any as match condition, and Send as Action. You can select different match conditions, and actions from the drop-down list for the Select Alerts and Action fields respectively. You can use combination of more than one policy rule. Select Add item to add more policy rules.

Select Configure link in Policy Rules box.

Select + Add Item button.

ALERTPOLICY 3 2 2 — Figure: Alert Policy Created

Select Alerts drop-down menu option.

Note: Matching Custom Criteria > Alertname Configure link > Select Matcher Type > select Apply button > select Apply button.

Select Action drop-down menu option.
Toggle Show Advanced Fields to show Policy Rule Notification Parameters to Configure.
Confirm Notification Parameters and Notification Grouping is in two number format. Example: 60m not 1h.

Note: All fields must be in 2-digit form (60m, 60s) for intervals and group notifications for your policy rules to apply correctly and not error.

Toggle Show Advanced Fields to show Group Notifications By drop-down menu.
- Update from default Individual if you want to receive alerts.
Select Apply button.
Order rules by dragging in Policy Rules page.

Note: Select + Add Item button to add additional rules.

Select Apply button, order rules by dragging.

Note: This applies the policy object to the policy set configuration and returns to the policy page.

Step 6: Complete creating Alert Policy.

Select Save and Exit button to create policy.

Step 7: Verify alerts are sent.

Select Manage > Alerts Management > select Alert Receivers.

Step 7.1: Verify receiver.

Depending on your receiver type, do one of the following:
- Select ... > Verify Webhook for receiver of webhook type.
  - Select Send Webhook button in confirmation box.
Obtain verification code from verification email or SMS sent to your email address or phone number.
Select ... > Enter Verification Code for your receiver object.
Enter code in Verify Receiver window.
Select Verify Receiver button.

Note: Wait for the notification that the verification is successful.

Step 7.2: Send test alert.

Select ... > Send Test Alert for your receiver object or SMS.
Select Send Test Alert button in confirmation window.
Check your inbox, verify alert is received.

Create Active Alert Policies

Step 1: Start creating active alert policies.

In Multi-Cloud Network Connect > Select Manage.

Note: Active Alert Policies can be created and edited in Multi-Cloud Network Connect, Multi-Cloud App Connect, Web App & API Protection, and Distributed Apps services by selecting Manage > Alerts Management > + Select Active Alert Policies.

Select Alerts Management > select Active Alert Policies.
+ Select Active Alert Policies.

ACTIVEALERTPOLICIES2 2 — Figure: Active Alert Policy Configuration

Step 2: Add active alert policies to the policy.

Select Item drop-down menu to select created alert policy needed.
+ Add Item button in Active Alert Policies pop-up window to add policy selection drop-down menus.

ACTIVEALERTPOLICIES2 4 — Figure: Active Alert Policy Configuration

Step 3: Complete creating the active alert policies.

Select Save and Exit button to complete creating the alert policy.

Concepts

Monitoring