Skip to content

alerts-jp-ca.adoc

Latest commit

 

History

History
250 lines (187 loc) · 9.94 KB

alerts-jp-ca.adoc

File metadata and controls

250 lines (187 loc) · 9.94 KB

Getting Alerts (Canada and Japan)

reuse::partial$beta-banner.adoc

In the Canada and Japan Clouds, create and receive alert notifications for your deployed resources (Mule app and APIs).

Alerts UI

  1. Alerts in Anypoint Monitoring

  2. Alert properties

  3. List of configured alerts.

    Each alert name opens to more information about the alert, including the alert threshold and recipients of alert notifications:

    Alert details

    1. Name of the selected alert

    2. Threshold configuration for triggering the alert

    3. Email address that receives an alert notification when the alert triggers

  4. Create Alert is for configuring a new alert.

  5. Enable, disable, or delete an alert from its (More menu).

For alerts in other Anypoint Platform clouds, see alerts-us-eu.adoc.

Before You Begin

Required prerequisites:

  • Your organization must subscribe to a tier in an Anypoint Platform cloud that supports this feature.

  • You must have the permissions required for viewing or managing Anypoint Monitoring.

  • At least one Mule application or API must be deployed to a supported host:

    • Mule application:

      • CloudHub 2.0

      • Runtime Fabric

      • Hybrid

    • API managed by Mule Gateway or Omni Gateway (formerly Flex Gateway)

      See gateway-home::index.adoc.

For information about deployment targets for Mule applications, see Runtime Plane Hosting Options.

Find Alerts

To find the list of alerts:

  1. In Anypoint Monitoring, navigate to Alerts.

  2. Review the alert list that returns.

    Each alert provides:

    • Alert Name: Name of the alert

    • Severity: Configured severity of the alert

    • Status: Current status of the alert

    • Metric: Name of the metric that the alert reports

    • Last Alerted: Most recent date and time the alert triggered or - for an alert that has never triggered

    • Creation Date: Alert creation date and time

    • Availability: Enabled or Disabled alert setting

Create an Alert

Configure an alert, the condition for triggering the alert, and the alert notification.

  1. From Alerts in Anypoint Monitoring, click Create Alert.

  2. Configure alert properties:

    1. Provide a name for the alert.

    2. Select the environment in your organization for this alert.

    3. Select the resource type and resource that the alert is for. Only active resources that can receive traffic are available.

      • Resource Type: API or Mule Application

      • Resource: Name of the API or Mule application

    4. For an API alert, select an API version and up to ten response codes.

    5. Click Next to open Set Alert Condition.

  3. In Set Alert Condition, configure the criteria for triggering the alert:

    1. Select the metric that the alert uses.

    2. Select the severity of the alert.

    3. Provide a threshold for triggering the alert.

    4. Click Next to open Configure Email Notification.

  4. In Configure Email Notification, configure the email to send when the alert triggers.

    To use variables in the email, see Email Notification Variables.

    1. Provide a subject.

    2. Provide the message.

    3. Identify recipients.

Enable, Disable, or Delete an Alert

Alerts are enabled by default when they are created. You can disable, re-enable, or delete an alert.

  1. In Anypoint Monitoring, navigate to Alerts.

  2. Find the alert in the Alerts table.

  3. Click the alert’s (More menu).

  4. Enable, disable, or delete the alert.

Alert Statuses

The Alerts page indicates whether an alert is currently triggering or in some other state.

Alert Severities

Use your organization’s alerting criteria when setting an alert’s severity. Available severity levels are:

  • Low

  • Medium

  • High

  • Critical

Alert Thresholds

Alert threshold configurations indicate when the data collected on a metric triggers the alert. Configurations for alert thresholds follow this form:

Configuration Pattern Example

Trigger alert when selected metric is Above|Less than|Above or equal to|Less than or equal to|Equal to Number for each of the last Number consecutive minutes.

Trigger alert when selected metric is Above 4 for each of the last 10 consecutive minutes.

The example configures an alert to trigger when the selected metric (such as Message Count) is Above 4 for 10 consecutive minutes. In other words, the count must exceed 4 for each minute of minutes 1-10. If the count exceeds 4 for 9 of 10 minutes, but not the tenth minute, the alert doesn’t trigger, even if the count exceeds 4 at minute 11. Following the same criteria, if the count exceeds 4 for each minute of minutes 11-20, the alert triggers.

Alert Metrics

A Mule application or API metric is part of the configuration for triggering the alert.

Mule app metrics:

  • Message Count: Total number of Mule messages that processed successfully

  • Message Error Count: Number of Mule messages that return an exception in a flow

  • Average Response Time: Response time (in milliseconds) of a message

  • CPU Utilization: Percent of CPU used on the virtual machine

    This metric includes all processes and is available only for apps deployed to CloudHub or Anypoint Runtime Fabric.

  • Memory Utilization: Percent of heap used

    This metric is available only for apps deployed to CloudHub or Anypoint Runtime Fabric.

    Anypoint Monitoring tracks heap usage and triggers memory alerts based on the value of heap_used/heap_total. Note that heap_total isn’t identical to the maximum heap memory allocated to the Mule app on CloudHub. For example, 0.2 vCores indicates that the maximum heap memory is 1 GB (see the table in CloudHub Workers), but the value of heap_total isn’t 1GB. Instead, heap_total is the maximum amount of memory that the JVM can use for heap memory, where objects are created and stored. In Java, this value changes dynamically depending on memory fragmentation, garbage collection, and other memory management features.

  • Thread Count: Total number of threads used

    This metric is available only for apps deployed to CloudHub or Anypoint Runtime Fabric.

API metrics:

  • Total Request Count: Sum of requests in the selected time period for the given API

    Data is aggregated in one minute increments.

  • Average Response Time: Average response time of requests in the selected time period for the given API

    Data is aggregated in one minute increments.

  • Response Codes: Sum of HTTP response codes that occur in the selected time period

Environments

Alerts are specific to one of your Anypoint Platform environments.

Your organization administrator creates the environments that are available to you.

Anypoint Platform supports these types of environments:

  • Design

  • Production

  • Sandbox

Email Notification Variables

Alerts deliver notifications as emails to designated recipients for each alert. Your email template can incorporate variables in the Subject and Message fields. For the description of each variable, see [alert-variables].

Table 1. Variables for Alerts
Alert Type Metric Applicable Variables partial$include-alert-variables.adoc partial$include-alert-variables.adoc partial$include-alert-variables.adoc

partial$include-alert-variables.adoc
⚡