Register notification rules

By default, notifications are delivered through meshIQ Kafka Console Notifications . To register a notification rule that allows you to deliver and receive notifications by other means (such as email, Slack, Jira, or Webhook), you need to register a recipient first. For recipient registration, see Register recipients.

After recipients are set up, you can register a new rule.

Create a Rule

Select Create Rule at the top right of the notification rules screen.

Rule Preferences

Set basic information for the new rule to be registered.

• Rule (Action/Alarm) name. A name that identifies the rule to be created.
• Explanation (Description). Detailed description of the rules.
• Creation type (Creator):
  • manager. Rules registered by administrator.
  • individual. Rules for meshIQ Kafka Console users to register.

Click Continue.

Select target cluster

Select the cluster to which the created rule will be applied. Then click Continue.

Setting metric criteria

Select the metric that will be the basis for evaluation in the rule and set the standard value.

• Component type
  • Broker. Metrics related to Kafka broker:
    • Number of brokers in a cluster
    • Abnormal broker status (Not running)
    • Abnormal number of active controllers
    • Broker disk skewed
    • Increasing producer request failure
    • Kafka Broker instance DOWN
    • Produce messages per minute
    • Produce bytes per minute
    • Consume bytes per minute
    • Consumer lag
  • Kafka network. Metrics related to Kafka network:
    • Remaining network resources
    • Request latency - Fetch follower
    • Request latency - Fetch consumer
    • Request latency - Produce
  • Node. Metrics related to the server on which the broker is operating:
    • CPU usage
    • Node disk usage
    • Node DOWN
    • Memory usage
    • Node disk usage per mount point
  • Topic. Topic-related metrics:
    • Topic message-in/sec
    • Topic bytes-in/sec
    • Topic bytes-out/sec
    • Topic message-in increasement in the last T minutes
    • Topic byte-in increasement in the last T minutes
    • Topic bytes-out increase in the last T minutes
    • Topic message-in increase in the last T hours
    • Topic bytes-in increasement in the last T hours
    • Topic bytes-out increase in the last T hours
  • Partition. Partition-related metrics:
    • Broker partition skewed
    • Leader partition skewed
    • Number of the offline-partitions
    • Number of partitions in a broker
    • Number of partitions in a cluster
    • Number of the under-min-ISR partitions
    • Number of the under-replicated parts
  • Consumer group. Consumer group related metrics:
    • Consumer group lag
    • Consumer group status is not STABLE
  • Zookeeper. Zookeeper-related metrics:
    • Zookeeper connection status warning
    • Zookeeper instance DOWN
  • Schema Registry. Schema registry-related metrics:
    • Schema Registry instance DOWN
  • Connect. Metrics related to Kafka Connect server:
    • Connect instance DOWN
  • CMPS
    • Cluster Message Consumption Per Second
    • Cluster Message Consumption Per Second (Consumer Group Level)
    • Cluster Message Consumption Per Second (Consumer Group - Topic Level)
• Metric. Select supported metrics for each component.
• Metric detailed settings. Set evaluation conditions for the metric by selecting an Operator and entering a Value.

Click Continue.

Setting notification conditions

If a notification is unconditionally issued just because a rule is met, the number of notifications may become too large. Therefore, it is generally configured to generate a notification when the same rule continues for several minutes.

• Severity. Set the importance of notifications:
  • CRITICAL
  • WARNING
  • INFORMATION
  • UNKNOWN
• Interval. Set how often the same notification occurs.
• Duration. The time interval during which the condition is met for rule evaluation
• Activation. Toggle to activate condition.

Alarm Type

Set the recipients who will receive notifications. The recipient or recipient group must be registered in advance.

• Recipient type. It supports various recipient types as follows:
  • EMAIL
  • Slack
  • sms
  • JIRA
  • WEBHOOK
• Recipient group. A group that groups multiple recipients into one.
• Individual recipient. Individual recipients.
• Add recipient type. Add a recipient type to send notifications to multiple types of recipients simultaneously (for example, both email and Slack).
• Message detailed settings. Title and content of the notification that the recipient receives.

Click Create.