Kloudfuse Managed Alerts

Kloudfuse-managed alerting aims to provide an opinionated view of how alerting framework should be. It allows for, what we believe are, more intuitive workflows that are easy to follow and less cluttered.

Using the Kloudfuse platform you can configure alerts, notify your teams, and manage alerts at a glance.

Note: Currently the Kloudfuse platform supports threshold-based category alerts on Metrics and Logs type of telemetry data. Please contact us to know about upcoming changes to other alert categories (automatic tracking changes in behavior or using explicit anomaly algorithms) and alert types (APM & Events)

Creating an alert

To create a monitor in the Kloudfuse platform follow these steps:

Navigate from the main page to Alerts > Rules and then click “Create New Alert”
Select an alert type corresponding to the kind of telemetry you want to alert on. Read further for each alert type:
- Metric based alerts
- Log based alerts

Contact points for notifying your teams

Contact points are used to define how your contacts are notified when an alert fires. The Kloudfuse platform supports the following types of contact points. The Kloudfuse platform supports Grafana message templates to customize notification messages for the contact point types.

Create contact point

Click “Contact points” to open the page listing existing contact points.
Click “Add New contact point”.
Add a descriptive name for the contact point In the “Name” field.
Use the “Choose contact point type” drop-down to select a type of contact point and fill out mandatory fields.
- Some contact point types, like email or webhook, have optional settings. So fill them as necessary.
- See contact point specific settings here.
Optionally test that the contact point is functioning appropriately using the “Test” button.
“Save contact point” to save your changes.

Edit contact point

To edit a contact point click “Contact points” to open the page listing existing contact points. Find the contact point to edit, then click the pen icon to edit the contact point. Make necessary changes, optionally test, and click “Save contact point”.

Delete contact point

To delete a contact point click “Contact points” to open the page listing existing contact points. Find the contact point to delete, then click the trash icon to delete the contact point. Confirm the choice when a window pops up.

Dealing with multiple contact points

In cases when multiple contact points are used within a single alert, the default one to one mapping provided by Kloudfuse UI may not work. Some additional configuration may be required based on your specific requirements. The policies can be further configured/updated by following these steps.

Contact point types

The following list of contact points is currently supported. This list will be enhanced as support for additional contact points is added.

Email
- Setting up email as contact point
PagerDuty
- Getting the integration key for PagerDuty
Slack
- Getting the integration key for Slack
Webhook
- Setting up webhook contact point integration
Flock
- Setting up Flock contact point integration
Microsoft Teams
- Setting up Microsoft Teams contact point
OpsGenie
- Setting up OpsGenie contact point
Google Hangouts
- Setting up Google Hangouts contact point

Manage alerts

The Alerts > Rules page lists the installed alerts in the system. A list of alerts can be searched using their state, labels, title, etc., intuitively on this page. Each alert can be further investigated by clicking on that alert from the list where the alert’s properties, current evaluation graph, and history are displayed.

Functions in alert queries

PromQL functions

Kloudfuse platform underlying query is always a PromQL query. These queries can be further extended using all https://prometheus.io/docs/prometheus/latest/querying/functions/ .

Kloudfuse Advance Functions/Algorithms

In addition to supporting full promql for alerting, Kloudfuse platform has some additional advance functions that can be used for detecting anomaly, outliers, etc. These functions are made available directly through detection methods in each stream. For example metric streams provides these detection methods.

Advance Auto-Alerting

Kloudfuse platform provides the ability to do alerting on all service endpoints of your services out of the box with a simple configuration update to enable. Enabling this feature results in the Kloudfuse platform starting to monitor the communication between various endpoints without requiring any instrumentation to your applications. On the collected data, it evaluates anomalies in streaming fashion using state-of-the-art statistical learning algorithms. Please see the /wiki/spaces/EX/pages/756056089 section for more details on this.

Contact points settings

Setting email notifications

Grafana lets user send email notification on alerts if configured. Grafana can be configured in more than one ways, but here we’ll give example of configuring grafana with gmail based notifications. (Other methods of authentication are weaker and therefore not listed here. This is the recommended way)

Firstly, grab an email address that you will be using to send the notifications. we’ll use grafana_alerts@domain.com.

create an app password in gmail. You will need to be using 2FA for the account (grafana_alerts@domain.com) to be able to create app password. https://support.google.com/mail/answer/185833?hl=en . Note down the app password as you will need it in step 3.
make sure you are connected to the cluster where kloudfuse stack is installed and you are in kfuse namespace
```
# connect to your cluster
kubectx <cluster-name>
kubens kfuse
```

create a kubernetes secret with the username and password you created in step 1.

kubectl create secret generic grafana-smtp-user-password --from-literal=user=grafana_alerts@domain.com --from-literal=password=<generated-app-password>

edit the values.yaml to uncomment settings related to smtp in grafana section (to look like the snippet below). Update following settings:

update host to your smtp mail server
update from_address to the smtp user you want to use

update from_name if needed

grafana:
  grafana:
    # grafana.ini - Grafana server configuration settings
    grafana.ini:
      ...
    # start -- Uncomment the following to enable smtp
       smtp:
         enabled: true
         host: your_smtp_hostname_colon_port
         skip_verify: true
         from_address: your_smtp_user@domain.com
         from_name: AlertsAdmin
     envValueFrom:
       GF_SMTP_USER:
         secretKeyRef:
           name: grafana-smtp-user-password
           key: user
       GF_SMTP_PASSWORD:
         secretKeyRef:
           name: grafana-smtp-user-password
           key: password
    # Uncomment the following to enable smtp -- end

issue the same kfuse helm install command which you used to install kfuse cluster again.

helm upgrade --create-namespace --install kfuse . -f [gcp|aws].yaml -f custom_values.yaml --set global.orgId=<your-company-name>

Setting Notifications to PagerDuty

Setting Kloudfuse (and grafana) alert notifications to PagerDuty is done in 2 simple steps:

Obtaining service integration key from PagerDuty
1. If you already have an existing service (using grafana-incoming-incidents service in the following example), then use following steps to get the integration key.
2. Otherwise, create a new service (test-incoming-notifications) and use that service’s integration key
Use the integration key obtained above in Kloudfuse platform by choosing “PagerDuty” as the contact point type.

Getting the slack webhook URL

Use a Slack webhook to create a contact point in slack.
Follow the link below to create a slack webhook and get its url- https://api.slack.com/messaging/webhooks
One the webhook is created, enter its URL in the webhook field while creating the contact point.
Use the Optional Slack Settings to mention specific user/group or send alerts to entire channel.

Setting webhook contact point integration

Add the webhook URL in the URL (mandatory) field.
Add any additional settings as necessary.

Setting Flock contact point integration

Setting flock integration with Kloudfuse alerting is same as setting up webhook based integration. However, the webhook url needs to be obtained from your flock app and some configuration at flock end is required.

Get a webhook url by creating an “incoming webhooks” from flock and pay attention to the transformations. Please add following transformation configuration in the incoming webhook you create:

{"text": "{
  status: \"$(json.status)\"
  alerts: $(json.alerts),
  groupLabels: $(json.groupLabels),
  commonLabels: $(json.commonLabels),
  commonAnnotations: $(json.commonAnnotations),
  externalURL: \"$(json.externalURL)\",
  version: \"$(json.version)\",
  groupKey: \"$(json.groupKey)\",
  truncatedAlerts: $(json.truncatedAlerts),
  orgId: $(json.orgId),
  title: \"$(json.title)\",
  state: \"$(json.state)\",
  message: \"$(json.message)\"
}"}

Use the URL from above step (it would look like: https://api.flock.com/hooks/sendMessage/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx) to create a webhook contact point as described here.

Setting up Microsoft Teams contact point

Setting Microsoft Teams integration with Kloudfuse alerting is similar to setting up a webhook based integration.

First head to Microsoft Teams and create a channel for alert notifications. Using test-notifications channel name in this example, and create a connection of type “incoming webhook” as shown below. Copy the created “URL” (example: https://kloudfuse.webhook.office.com/webhookb2/257d29a4-xxx )
Go to the Kloudfuse->Alerts->Contact Points->Add New Contact Point. Choose Microsoft Teams from the drop down menu. Use url from above in the “URL” field and save. (Test will send a test notification).

Setting up OpsGenie contact point

Navigate to Grafana tab in the Kloudfuse UI.
Create a OpsGenie-Grafana integration with steps in the https://support.atlassian.com/opsgenie/docs/integrate-opsgenie-with-grafana/
After completing the steps, navigate to Notifications Policies in the Grafana

Create a New Nested Policy for OpsGenie contact point

Please make sure to use the label name same as the contact point name and to choose the contact point from the dropdown from below.

Now use the contact point from Kloudfuse UI to any of the alert.

The above steps in Notification policies is a workaround till we get the Kloudfuse UI support for OpsGenie alerting.

Setting up Google Hangouts contact point

Create a new Google Workspace space for alertinghttps://support.google.com/a/users/answer/9300611?hl=en or you can use an existing space.
Create an incoming webhook for space https://developers.google.com/chat/how-tos/webhooks#create_a_webhook
Navigate to Grafana tab in the Kloudfuse UI. Select Contact Point and Click on New Contact Point.

Create a new Google Hangout Chat Integration and paste the webhook link in the URL section.

After completing the above steps, navigate to Notifications Policies in the Grafana

Create a New Nested Policy for Google Hangouts contact point

Please make sure to use the label name same as the contact point name and to choose the contact point from the dropdown from below.

Now use the contact point from Kloudfuse UI to any of the alert.

The above steps in Notification policies is a workaround till we get the Kloudfuse UI support for Google Hangouts alerting.