Alerts

The Alert Component is designed to send notifications to Microsoft Teams and Slack channels based on incoming records from an event source. It allows users to define thresholds and time intervals to control when alerts are sent, ensuring that notifications are meaningful and actionable.

Key Capabilities

  • Send alerts to Teams or Slack channels.

  • Configure thresholds to trigger alerts only when a minimum number of records are received.

  • Control alert frequency with time intervals between notifications.

  • Customize alert format with colors, sections, facts, and attachments.

Configuration Overview

All Alert Component configurations are organized into:

  • Basic Information

  • Meta Information

  • Resource Configuration

Configuring Meta Information

Common Fields (Teams & Slack)

  • Webhook URL – URL of the channel group webhook where alerts will be sent.

  • Threshold – Number of in-event records required to trigger an alert.

    • Example: A threshold of 100 means the component sends an alert only after receiving 100 records.

  • Time Interval (seconds) – Minimum time gap between two alerts. The next alert is sent only if both the threshold and time interval conditions are satisfied.

  • Channel – Select notification channel:

    • Teams

    • Slack

Configuring for Microsoft Teams

  • Type – Pre-filled as Message Card.

  • Theme Color – Enter a Hex color code for the card ribbon.

    • Example: #0000FF (Blue), #FF0000 (Red).

  • Sections – Define alert message details:

    • Activity Title – Title of the alert.

    • Activity Subtitle – Subtitle for the alert.

    • Text – Message text body.

    • Facts – Key-value pairs.

      • Name: Label for the fact.

      • Value:

        • Can be dynamic using @data.column_name to fetch values from event data.

        • Or static custom text.

    • Add New Facts – Add more key-value pairs.

    • Add New Section – Add additional sections to structure the alert message.

Sample Hex Codes for Teams Alerts:

  • Blue – #0000FF

  • Red – #FF0000

  • Yellow – #FFFF00

  • Green – #008000

  • Black – #000000

Configuring for Slack

  • Attachments – Define the structure of Slack messages.

    • Title – Bold header text.

    • Color – Hex color code for sidebar ribbon.

    • Text – Main content body of the alert.

  • Fields – Used to add structured information:

    • Title – Header for the field.

    • Value – Content for the field (text, numbers, or links).

    • Short – Boolean (true/false) for compact display.

  • Footer – Additional info appended at the bottom of the message.

  • Timestamp – Unix timestamp (in seconds).

    • Example: 1697540874 (17 Oct 2023).

  • Footer Icon – Image URL displayed alongside the footer.

    • Example:

      https://cdn1.iconfinder.com/data/icons/google-s-logo/150/Google_Icons-09-512.png

Usage Notes

  • The second alert is sent only if both conditions are satisfied:

    1. Threshold of records has been reached.

    2. Time Interval since the last alert has passed.

  • Use dynamic placeholders (@data.column_name) in Teams or Slack messages to insert event-specific values automatically.

  • Test webhooks with small payloads before production use.

Example Use Cases

  • Send a Teams alert when more than 500 failed records are detected in a data ingestion job.

  • Notify Slack when 1000 sales transactions are processed within an hour.

  • Post colored alerts to Slack channels (green for success, red for failure).

  • Provide detailed pipeline failure summaries with timestamps and dynamic column values.