+
+

CLI for Hybrid Application Alerts

Use these commands to control alerts for apps that are deployed to your local Mule server and managed with Runtime Manager.

Command Description

Describes an alert

Creates new alert for standalone runtime

Modifies alert for standalone runtime

Lists all alerts for standalone runtimes in the environment

runtime-mgr standalone-alert describe

> runtime-mgr standalone-alert describe [options] <alertId>

This command describes the alert passed in alertId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-alert create

> runtime-mgr standalone-alert create [options] <name>

This command creates a new alert for a standalone runtime with the ID passed in name. The alert name is limited to 256 characters.

Besides the default --help, -f/--fields and -o/--output options, this command also takes:

Value Description

--severity <val>

Alert severity

--resourceType <type>

Alert resource type

--resource [id]

Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on resourceType resource can be application, server, server-group or cluster.

--condition <val>

Alert trigger condition

--period [minutes]

Condition duration in minutes

--threshold [num]

Condition threshold number

--operator [type]

Condition operator explaining values relation to threshold.

--subject <string>

Alert notification email subject

--content <string>

Alert notification email body

--recipient [username]

Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs.

--email [emailAddress]

Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses.

runtime-mgr standalone-alert modify

> runtime-mgr standalone-alert modify [options] <alertId>

This command modifies the alert passed in alertId.

Besides the default --help, -f/--fields and -o/--output options, this command also takes:

Value Description

--name <value>

Alert name

--severity <value>

Alert severity

--resourceType <type>

Alert resource type

--resource [id]

Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on resourceType resource can be application, server, server-group or cluster.

--condition <value>

Alert trigger condition

--period [minutes]

Condition duration in minutes

--threshold [num]

Condition threshold number

--operator [type]

Condition operator explaining values relation to threshold.

--subject <string>

Alert notification email subject

--content <string>

Alert notification email body

--recipient [username]

Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs.

--email [emailAddress]

Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses.

runtime-mgr standalone-alert list

> runtime-mgr standalone-alert list [options]

This command lists all alerts for standalone Mules in the current environment.

This command accepts only the default options: --help, -f/--fields and -o/--output.

Was this article helpful?

💙 Thanks for your feedback!

Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!