Contact Free trial Login

Configure Alerts

Set up alerts that send an email notification when certain events occur. These can be events for an application or server. Runtime Manager includes several standard alert types that trigger notifications for common events, for example when:

  • An application exceeds a certain number of events processed within a certain time period.

  • A deployment completes with success or failure.

  • CloudHub encounters a problem with the worker on an application via the worker monitoring system.

  • A server is disconnected or deleted.

CloudHub also enables you to create a custom alert for an application. Custom alerts are triggered by notifications that your application sends to Runtime Manager console using the CloudHub Connector. See Custom Application Alerts for more information. Custom alerts are available only for applications deployed to CloudHub. You cannot configure an alert for an application deployed to a customer-hosted runtime.

Access Alerts

You can view alerts in Runtime Manager in a few ways.

  • In Runtime Manager, click the Alerts tab to display a full list of alerts on your account.

  • In the menu on the left, click the Applications tab, click an application to open the application dashboard, then click the View Associated Alerts link.

  • In the menu on the left, click the Servers tab, click a server to open the servers dashboard, then click the View Associated Alerts link.

Rate Limits on Alerts

Anypoint Platform enforces rate limits that determine how often an alert is triggered. These limits prevent excessive emails from being sent. The rate limit is determined by several factors, including:

  • CloudHub: When using CloudHub-Connector to trigger notifications and alerts, there is a limit of five custom application alerts per IP address, per second. If an application uses multiple workers, this limit is multiplied by the number of workers assigned to the application, since the limitation is enforced per IP.
    Custom notifications that trigger emails are also subject to the rate limit on email notifications described below.

  • Alert emails: Both standard and custom alerts have a rate limit where only one alert notification email is sent every 2.5 seconds. This limit is enforced by a combination of organization, environment, alert (name/ID), and resource (application, server, server group, or cluster).

Create an Alert

If you access the alerts screen through any of the paths listed above and you don’t have any alerts set up yet, you will see the following screen:

first-alert
  1. Click the plus sign next to Create your first alert

    create alert
  2. Fill in the required fields:

    • Name - Unique and meaningful name for the alert

    • Severity Level - (Critical, Warning or Info)

      Different severity levels currently have no effect on alerts, but will in the future when further features are released.
    • Source - Determines if this alert is associated with applications or servers. This field may not appear if your Anypoint Platform account doesn’t support local servers.

    • Application Type - Associate the alert with applications deployed to CloudHub or local servers.

      You can’t create a single alert that spans applications deployed to both CloudHub and local servers. You must create two separate alerts to reach both types.
    • Server Type - For servers, determine if you’re managing a single server, a server group, or a cluster. If your servers aren’t available on your menu, see Managing Servers.

    • Application(s) or Server(s) - Select the application or server to which to apply the alert.

    • Condition - The condition that triggers the alert. The options depend on whether your alert is linked to a server, an application running on CloudHub, or an application running locally. Certain conditions require additional data, which is explained in a section below.

    • Subject - Subject of the email that will be sent. Your subject may include variable Alert Properties.

    • Message - Enter the body text for the email. Your message may include variable Alert Properties.

    • Recipients - List the recipients of this email. You can select users of the platform, or enter email addresses of people who aren’t in the organization.

  3. Click Create Alert.

  4. If an event that meets an alert condition occurs, an email like the following is sent:

    AlertEmailMsg

See below for more information on the alert conditions available for each alert source.

Alert Conditions

Depending on what your alert’s source is, you can select different event types. Some event types are simple success or failure notifications such as 'Application Deployment Success' and more complex notifications which require you to define parameters that appear as new fields in the form.

Conditions on CloudHub Deployed Applications

For applications deployed to CloudHub, you can choose any of the following alert conditions:

  • CPU Usage - CPU usage of the CloudHub worker(s) that run the application.

    cpu

    To enable this condition, you must specify the duration and capacity threshold that triggers the alert.

  • Memory Usage - Percentage of total memory allocated to the CloudHub worker(s) that run the application (includes the memory consumed by the JVM itself).

    memo

    To enable this condition, you must specify the duration and capacity threshold that triggers the alert.

  • Custom Notification alert – Looks at custom notifications and alerts when one contains specified text.

    custom

    To enable this condition, you must specify the notifications that are the output of a CloudHub connector. This connector must exist in your Mule application. An alert is raised when the text in one of the notifications matches or contains the string that you provide in the Contains field. See Custom Application Alerts for more information.

    On Custom Notification Alerts, you can access a set of alert properties that you can compile into the notification message to provide more context.

  • Exceeds event traffic threshold

    traffic

    To enable this condition, you must specify the duration and capacity threshold that triggers the alert. This threshold applies to all events of any type. If during a certain period you get more than N events, you get an alert. The meaning of this depends on the events you are tracking on your application. For more information on event tracking, see Business Events.

  • Secure data gateway disconnected

  • Secure data gateway connected

  • Worker not responding

  • Deployment success

  • Deployment failure

Conditions on Locally Deployed Applications

On an application that’s deployed to local servers, both via the cloud console or the Anypoint Platform Private Cloud Edition, you can select any of these alert conditions:

  • Number of errors

    alerts on runtime manager 387e2

    You must provide the number of errors that triggers the alert. The time unit is per minute. An alarm is triggered when the error count goes over the threshold number in the timeslot of one minute.

    This alert is currently not available on the Anypoint Platform Private Cloud Edition.
  • Number of Mule messages

    alerts on runtime manager 51033

    You must provide the number of Mule messages, since the application was started, that trigger the alert.

    This alert is currently not available on the Anypoint Platform Private Cloud Edition.
  • Response time

    alerts on runtime manager 45785

    You must provide the maximum accepted response time—​anything over this value triggers the alert.

    This alert is currently not available on the Anypoint Platform Private Cloud Edition.
  • Application Deployment success

  • Application Deployment failure

  • Application undeployed

Conditions on Mule Servers

The available alert events vary depending on the Server Type field. The alerts detailed below are available on all target types (servers, server groups, and clusters):

  • CPU Usage - CPU usage of the servers.

    cpu

    To enable this condition, specify values in the duration and capacity threshold parameters that, when crossed, trigger the alert.

  • Memory Usage - Total memory usage in MB on the server.

    memo

    To enable this condition, specify values in the duration and capacity threshold parameters that, when crossed, trigger the alert.

  • Server Load Average - Average processing for a given time period.

    alerts on runtime manager load average
    Windows environments don’t provide this information, so this metric isn’t available on Windows environments.
  • Server Thread Count - Number of threads on the JVM.

    alerts on runtime manager thread count
None of the alerts listed above are currently available on the Anypoint Platform Private Cloud Edition.

The following alerts vary according to the target type (server, server groups, or clusters), and require no additional parameters.

Servers

  • Server up

  • Server disconnected

  • New server registered

  • Agent’s version changed

  • Runtime’s version changed

  • Server deleted

Server Groups

  • Server added to a Server Group

  • Server removed from a Server Group

  • Server added to a Server Group

  • Server removed from a Server Group

  • Server group is up

  • Server group is partially up (some servers are not running) !!!!!!

  • Server group is down

  • A server group’s node came up

  • A server group’s node went down

Clusters

  • Cluster Created

  • Cluster Deleted

  • Server added to a Cluster

  • Server removed from a Cluster

  • Cluster is up

  • Cluster is down

  • A cluster’s node came up

  • A cluster’s node went down

  • Cluster presents visibility issues

Alert Properties

The following properties are available and can be used in the alert Email to, Subject, and body fields.

Variable Description Applicable Alerts

${app}

Name of the application triggering the alert.

All app alerts

${currentValue}

Current value of metric that triggers the alert

Conditional

${message}

Message from the notification triggering the alert.

Custom Application Notification

${name}

Name of the target (server, server group, or cluster) triggering the alert.

All server alerts

${period}

Timeframe over which to measure

Conditional

${periodTimeUnit}

Period time unit

Conditional

${operator}

An operator, such as: < > =

Conditional

${priority}

Priority of the notification triggering the alert.

Custom Application Notification

${resource}

Name of the resource triggering the alert, such as server or app.

All

${severity}

Severity of the alert.

All

${state}

State of the resource triggering the alert, such as Running or Disconnected.

All

${threshold}

Count over timeframe which triggers the alert

Conditional

${value}

A value associated with an element

Conditional

Editing Existing Alerts

To see the alerts for an application or server, click the View Alerts link in the panel for that application or server. You can also click the Alerts link in the left panel to view a list of all alerts.

alerts

From this menu you can filter the displayed alerts, click on an alert name to directly edit it, or click the icon next to one to open its panel and view its settings. From this panel you can click the edit icon next to the name to edit the same options you have when creating a new alert.

edit

Switching an Alert On or Off

To change an alert’s state, select one or more alerts and click the switch to on or off.

on

All users of Anypoint Platform, even those without permissions to create alerts, can control whether email alerts are sent by setting each alert to an Active or Inactive state.

When an alert is disabled or enabled the change is applied for all users who receive email notifications for that alert.

Duplicating an Alert

Select one or several alerts and then, from the alert panel, click the duplicate icon. You can then edit your new alert.

duplicate

Deleting an Alert

Select one or several alerts and then, from the alert panel, click the delete icon.

duplicate

Viewing Alert History

From the Alerts page, click an alert name to open its corresponding panel. From this panel you can edit the alert, view its status and settings, and view a full history of all of the times the alert has been triggered:

history

You can also see the alert history record of an individual server or of an application that’s deployed to one.

  1. On the Applications tab, click the Manage Application button (for applications deployed on premises), or click the Manage Server button on the Servers tab.

  2. Click the Alerts History tab.
    The history record for the alert is displayed.

alerts on runtime manager 3afb7

Was this article helpful?

πŸ’™ Thanks for your feedback!

Edit on GitHub