User Tools

Site Tools


products:cockpit.old:1.0:userguide:settings:email

E-mail Plugin

Purpose

  • The e-mail plugin gives the possibility to send alarms via e-mail and customize email title and content
  • This plugin can behave in two manners:
    • Alarm rules are DISABLED: The plugin will send one email per generated alert. At least one recipient must be set.
    • Alarm rules are ENABLED: The plugin will process only the filtered alerts. Emails will be sent to the recipients added by the rule.
  • The content and title of the email can be customized by using variables matching alarm parameter names, such as SID, SEVERITY, MESSAGE, etc…
  • You can build text of HTML email bodies.

Create/Edit

  • Press Create or select Edit in the table action menu to open the E-mail Plugin editor
ParameterDescription
Active Turns on and off the plugin
Name The display name of the plugin
To Recipients of the mail, use the plus icon to add several
CC CC recipients of the mail, use the plus icon to add several
BCC BCC recipients of the mail, use the plus icon to add several
Email format If HTTP, you can use markup
Subject The subject of the email
Body The body of the email (See below for possible variables)

If you leave Subject and body empty, a default format will be used

Email subject and body

You can build custom subject and body by using below variables:

  • %ID% : will write the Alarm ID
  • %GROUP% : will write the Group (Company) name
  • %SID% : will write the System ID (SID)
  • %INSTANCE% : will write the Pro.Monitor instance name
  • %SEVERITY% : will write the the Alarm severity level
  • %MESSAGE% : will write the message sent by the Alarm
  • %MODULE% : will write the Alarm module
  • %TO_CLEAR% : will write “true” or “false” depending on if the Alarm is to be cleared or not
  • %CLEARABLE% : will write “true” or “false” depending on if the Alarm is a “can-be-cleared” type or not
  • %TIMESTAMP% : will write the timestamp of the Alarm
  • %COMPONENT% : will write the Alarm component (i.e. “disk”)
  • %STACK% : will write the alarm stack type
  • %ALARM_TAG% : will write the description of the alarm tag
  • %CLEARED% : will write “CLEARED” if the Alarn has been already cleared or “” (none) if not
  • %COUNT% : will write alarm counter
  • %AGENT% : will write the Agent UUID (Pro.Monitor internal Agent unique identifier code)
  • %TIMESTAMP% : will write the timestamp of the Alarm
  • %TIMESTAMP_UNIX% : replaces by the unformatted timestamp of the Alarm in UNIX epoch format (milliseconds since January 1st 1970)
  • %TIMESTAMP_XXX% : replaces by the formatted timestamp of the Alarm using specified timezone (XXX):
    • Example: %TIMESTAMP_UTC%

Example:

Subject: %SEVERITY% - %SID% - %MESSAGE%
Will give: CRITICAL - S4H - System unreachable

/home/clients/8c48b436badcd3a0bdaaba8c59a54bf1/wiki-web/data/pages/products/cockpit.old/1.0/userguide/settings/email.txt · Last modified: 2024/05/01 18:39 (external edit)