Nav

Alerts on Runtime Manager

logo cloud active logo hybrid active logo server active logo pcf disabled

Starting on May 14, 2016 all CloudHub Alerts created through the old alerts mechanism were migrated to a global view and are managed as explained in this document.

Overview

You can set up Alerts that trigger the sending of emails whenever certain events related to your application or servers occur. This mechanism works in the same way for applications deployed through any of the deployment scenarios.

Runtime Manager includes several out of the box standard alert types, for example:

  • You exceed a certain number of events processed in 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 lets you create your own custom alerts for your application. Custom alerts are triggered by notifications that your application sends to the Runtime Manager console (using the CloudHub Connector). See Custom Application Alerts for more on this. Custom alerts are only available for apps deployed to CloudHub, you can’t set one up for an app that you deploy locally.
Apps deployed to Pivotal Cloud Foundry (PCF) currently don’t support any Alerts.

Access Alerts

To view and configure your alerts, you can:

  • Select the Alerts tab to display a full list of alerts on your account

  • On the Applications tab, click an application to open the application dashboard, then click the View Associated Alerts link

  • On the Servers tab, click a server to open the servers dashboard, then click the View Associated Alerts link

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

Click the plus sign next to Create your first alert

create alert

Fill in the required fields:

  1. Enter a unique alert Name.

  2. Select a 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.
  3. Select a Source to determine if this alert is to be related to applications or servers. This field may not appear if your Anypoint Platform account doesn’t support local servers.

  4. For applications, select an Application Type to determine if it is destined for applications deployed to CloudHub or local servers.

    You can’t create a single alert that spans applications both on CloudHub and a local servers. You must create two separate alerts to reach both types.

    For servers, select a Server Type to 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.

  5. Select which application(s)/server(s) this alert should be applied to.

  6. Select the Condition that needs to occur for the alert to be triggered. The options depend on whether your alert is linked to a server, to an application running on CloudHub, or to an application running locally. Certain conditions require additional data, explained in a section below.

  7. Provide a Subject for the email that will be sent. Your subject may include variable Alert Properties.

  8. Write a Message to fill the body of the email. Your message may include variable Alert Properties.

  9. List the recipients of this email. You can select users of the platform, or also freely write email addresses of people who aren’t in the organization.

  10. Click Create Alert.

  11. If a 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, different event types exist. Some of these are self explaining notifications for different events such as 'Application Deployment Success', others require that you complete additional parameters that appear as new fields in the form.

Below are the event types for each.

Conditions on CloudHub Deployed Applications

On an application that’s deployed to CloudHub, you can select any of these alert conditions:

  • CPU Usage - refers to the CPU usage of the CloudHub worker(s) that run the app

    cpu

    You must then set up a few parameters for this condition to be enabled, these specify a duration and capacity threshold that triggers the alert.

  • Memory Usage - the percentage of total memory allocated to the CloudHub worker(s) that run the app (includes the memory being consumed by jvm itself).

    memo

    You must then set up a few parameters for this condition to be enabled, these specify a duration and capacity threshold that triggers the alert.

  • Custom Notification alert – looks at custom notifications and alerts when one contains a certain text

    custom

    You must set up a few parameters for this condition to be enabled, these reference the notifications that are the output of a CloudHub connector that must priorly exist in your 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 the Custom Application Alerts tutorial.

    On Custom Notification Alerts, you can access a set of Alert Properties that can be compiled into in the notification message to provide a better context.
  • Exceeds event traffic threshold

    traffic

    You must then set up a few parameters for this condition to be enabled, these specify a duration and capacity threshold that triggers the alert.

  • 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.

    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 that triggers 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 will trigger the alert.

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

  • Application Deployment failure

  • Application Deleted

Conditions on Mule Servers

The available alert events vary depending on the Server Type field, that lets you select between Server, Server Group, or Cluster.

The alerts detailed below are available on all target types (Servers, Server Groups and Clusters):

  • CPU Usage - refers to the CPU usage of the servers

    cpu

    You must then set up a few parameters for this condition to be enabled, these specify a duration and capacity threshold that triggers the alert.

  • Memory Usage - the total memory usage in MB on the server

    memo

    You must then set up a few parameters for this condition to be enabled, these specify a duration and capacity threshold that triggers the alert.

  • Server Load Average - the average processing per a given time period

    alerts on runtime manager load average

    Windows environments don’t provide this information, so this metric won’t be available on Windows environments.
  • Server Thread Count - amount of threads on the JVM

    alerts on runtime manager thread count

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

In addition to these common alerts, below are some additional alerts which vary according to the target type. These are all self explanatory 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}

The name of the application triggering the alert.

All app alerts

${name}

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

All server alerts

${severity}

The severity of the notification triggering the alert.

All

${period}

Timeframe over which to measure

Conditional

${periodTimeUnit}

Period time unit

Conditional

${currentValue}

Current value of metric that triggers the alert

Conditional

${threshold}

Count over timeframe which triggers the alert

Conditional

${message}

The message from the notification triggering the alert.

Custom Application Notification

${priority}

The priority of the notification triggering the alert.

Custom Application Notification

Editing Existing Alerts

If you view the panel for an application or server, you will see a View Alerts link. In there you will be able to see and manage the alerts that are sourced from it. You can also click on the Alerts link on the left panel to view all alerts together.

alerts

From this menu you can filter the displayed alerts, click on an alert name to directly edit it, or click on the icon next to one to open its panel to 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 one.

edit

Switching an Alert Off

Select one or multiple alerts in the alert menu and click the switch to change its state form on to off or viceversa.

on

All users of the Anypoint Platform, even those without permissions to create alerts, can switch the existing alerts that are already created into an active or inactive state. This determines what email alerts will reach their inbox.

When an alert is disabled or enabled the change is reflected for all users.

Duplicating an Alert

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

duplicate

Deleting an Alert

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

duplicate

Viewing an Alert’s History

From the Alerts page, click on 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 that 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. Simply click the Manage Application button on the applications tab(for applications deployed on premises) access the or the Manage Server button on the servers tab. Once there, select the Alerts History tab.

alerts on runtime manager 3afb7