Skip to main content
Quick navigation

Alerts

Overview

Alerts allow you to be notified and react to Kafka infrastructure or application changes as soon as they happen.

You can integrate alerts with Slack, MS Teams and email to receive real-time notifications. Alternatively, set up arbitrary webhook destinations with any URL and custom headers. Find out how to configure integrations.

Alerts are periodically checked for every minute.

Create alerts

Alerts can be created for most resources (e.g. brokers or topics) in Conduktor Console.

To create an alert:

  1. Navigate to the required resource.
  2. Click on the Alerts tab.
  3. Click Create an alert:
Alert creation

In the New Alert pane enter the required details. Each alert has to have:

  • a unique name

  • a metric you want to measure (e.g. messageCount)

  • an operator and value for the threshold

  • an owner. This can be a group, an application instance or an individual user. The ownership will determine who can edit the alert.

    Ownership

    If the owner of an alert is deleted, the associated alerts will also be deleted.

  • (optional) a description explaining what the alert does or why you created it. This is useful if you're creating an external alert.

  • a destination: internal (Conduktor Console) or external (Slack, Teams, Email or Webhook). Each alert can have only one external destination. To verify that it works, click Send test.

Alert destinations

Once you've configured your integrations, you can choose from several alert destinations:

Slack

  • Destination channel: select from available Slack channels (your Slack app has to be invited to the channel first).

Microsoft Teams

  • Webhook URL: use the channel webhook URL from your Teams workflow configuration.

Email

  • Destination email: specify the recipient's email - this is where the notifications will be sent.
  • Subject: customize the email subject line to make them easily identifiable.
  • Body: the body of the email. You can use handlebars syntax (e.g., {{clusterName}}, {{threshold}}, for url because the template engine can escape the whole url, you will have to use {{{url}}} to not escape the url) to embed alert variables dynamically.

Email alerts will be sent from the sender address configured in your email integration settings.

Webhook

  • Method: select the HTTP method to use for the webhook request (POST, PUT).
  • URL: any webhook endpoint that accepts POST requests.
  • Custom Headers: add custom headers, as needed.
  • Body: receives structured JSON payload with alert details and metadata. You can use handlebars syntax (e.g., {{clusterName}}, {{threshold}}, for url because the template engine can escape the whole url, you will have to use {{{url}}} to not escape the url) to embed alert variables dynamically.
  • Authentication: configure authentication, if required by your webhook endpoint (basic auth or bearer token).

Click Send test for any external destinations to verify your configuration before saving the alert.

Manage alerts

You can deactivate an alert without deleting it. Deactivated alerts won't send notifications or record history/status until reactivated.

You can also test, duplicate or delete the alert at any point.

Select the event and click the three dots in the top-right corner:

Editing alerts

Alert history

Each alert will keep a history of when it was triggered and the status over time. This gives you an overview of successful or failed deliveries. Alerts with the firing status will trigger a notification every hour.

Alert details page. The left-hand side lists alert properties like name and description. The right-hand side displays a heatmap-style chart with red and grey squares indicating alert health and a table below listing recent alert notifications.

Alert list

Go to Settings > Alerts to see all the alerts, grouped by owner. You can sort the view by name, status or destination and activate/deactivate as required. You can also customize this view to show/hide columns relevant to you.