Overview

 

This plugin provides more flexibility when it comes to sending email action alerts. You have full control over the email message that gets send and can also specify additional filtering options e.g: just send the email when the Incident comes from a specific agent or server

 

Plugin Details

Author

Eugene Turetsky (Eugene.Turetsky@dynatrace.com)

dynaTrace Versions

6.1+

License

dynaTrace BSD

Support

Not Supported

Known Problems

 

Release History

2013-07-05 Initial Release 0.9.5,

2013-08-07 Release 0.9.6

2013-10-10 Release 0.9.7

2013-12-27 Release 0.9.8  

2014-02-26 Release 0.9.9.5

2014-07-01 Release 0.9.9.6

2014-07-22 Release 0.9.9.7

2014-09-16 Release 0.9.9.8 - 0.9.9.12 

2014-10-10 Release 0.9.9.13

2014-10-27 Release 0.9.9.14

2014-11-18 Added Java utility to verify correctness of Emails-Filters Dependency File

2014-12-28 Release 0.9.9.18

2015-04-19 Release 0.9.9.19

2015-04-29 Release 0.9.9.20

2015-05-20 Release 0.9.9.21

2015-09-06 Release 0.9.10

2015-10-01 Release 0.10.0

2015-11-17 Release 0.10.1

2015-12-04 Release 0.10.2

2015-12-20 Release 0.10.3

2015-12-29 Release 0.10.4

2016-01-03 Release 0.10.5

2016-04-24 Release 0.10.6

2016-07-09 Release 0.10.7

2016-10-09 Release 0.10.8

2016-10-13 Release 0.10.9

2016-11-16 Release 0.10.10

2016-11-21 Release 0.10.11

2016-12-06 Release 0.10.12

2017-01-16 Release 0.10.13

Downloadcom.dynatrace.diagnostics.plugins.extendedmailreport_0.10.13.jar

New in the Release 0.10.13

Improved plugin logging.

New in the Release 0.10.12

Added new predefined runtime variables PURE_PATH_N, where N = 1, 2, 3, 4, 5, ... up to 100. The ${DYNATRACE_INCIDENTS} runtime variable contains full list of the affected PurePaths.

New in the Release 0.10.11

Fixed issue with e-mail attachments which was introduced in the release 0.10.8 of the plugin.

New in the Release 0.10.10

Rounded off to the two decimal points values of the ${VIOLATED_TRIGGER_VALUE} and ${VIOLATED_MEASURE_VALUE} runtime variables.

New in the Release 0.10.9

Added ability to use filters by application in the Emails-Filters Dependency file. See example of the XML file here. The matching XSD schema file is located here. Plugin internally validates XML file using this schema. Please use the following link to validate correctness of the XML file outside of the plugin: XML-validation-link. 

New in the Release 0.10.8

Added new ${DYNATRACE_INCIDENTS} runtime variable which represents array of DT incidents and their subsequent violations with triggered values in JSON format. For details, please see next screenshots and correspondent files example-1-json-output.log and example-2-json-output.log:



New in the Release 0.10.7

Replaced old Dynatrace logo to a new one that matches to Dynatrace 6.3. 

Added missing semicolon separator in the VIOLATED_MEASURE_NAME_ALL variable.

New in the Release 0.10.6

Added new parameter - 'dynaTrace Server REST Protocol'. Its values are 'HTTP' or 'HTTPS'. Value of the 'dynaTrace Server REST Port' parameter should match to the chosen value of the 'dynaTrace Server REST Protocol' parameter. Default value is 'HTTP'. 

Fixed messages for measures with different units.

New in the Release 0.10.5

Fixed backward compatibility issue with older releases of the plugin.

New in the Release 0.10.4

Added ability to set quiet time intervals using the following three formats depicted below. These formats can be used equally in the “Quiet Time From/To” plugin configuration parameters or in the <from></from>/<to></to> tags of the plugin Emails-Filters Dependency File. They are listed below with examples from the plugin Emails-Filters Dependency File:

  1. “HH:mm” - this means that quiet time is every day from HH:mm to HH:mm (implemented already).
    For example:
    <from>8:15;12:00</from>
    <to>9:00;13:00</to>
    Quiet time contains two intervals: 
    1. Every day from 8:15 to 9:00
    2. Every day from 12:00 to 13:00.
  2. “<day-name-in-week> HH:mm” – this means that quiet time is from HH:mm to HH:mm on <day-name-in-week> every week. For example:
    <from>Saturday 8:15; Sunday 12:00; Saturday 6:00</from>
    <to>Saturday 9:00; Sunday 13:00; Sunday 18:00</to>
    Quiet time contains three intervals: 
    1. Every Saturday from 8:15 to every Saturday 9:00
    2. Every Sunday from 12:00 to every Sunday 13:00
    3. Every Saturday from 6:00 to every Sunday 18:00
  3. “MM/dd/YYYY HH:mm” – this means that quiet time is from HH:mm to HH:mm on MM/dd/YYYY day. For example:
    <from>12/26/2015 8:15; 12/27/2015 12:00</from>
    <to>12/26/2015 9:00; 12/27/2015 13:00</to>-
    Quiet time contains two intervals:
    1. From 8:15 on 12/26/2015 to 9:00 on 12/26/2015
    2. From 12:00 on 12/27/2015 to 13:00 on 12/27/2015

Added new configuration parameter to manage suppression of the Incident Ended notifications. New parameter name is 'Suppress Incident Ended Notification'. If the 'Suppress Incident Ended Notification' parameter is 'true' then if notification e-mail for the 'Incident Started' event was suppressed by one of the quiet time intervals then notification e-mail for the 'Incident Ended' event will be always suppressed by the plugin. If the 'Suppress Incident Ended Notification' parameter is 'false' then notification e-mail for the 'Incident Ended' event will be sent based on the quiet time intervals.

New in the Release 0.10.3

New features include:

  1. Added ability to manage multiple quiet time intervals. The "Quiet Time From" and "Quiet Time To" parameters contain semicolon separated "from" and "to" times respectively in the HH:mm format, where "HH" and "mm" are using notations explained in the Date and Time Patterns section here.
    Quiet Time intervals which are set using the "Quiet Time From" and "Quiet Time To" plugin configuration parameters are always applied to all filters which are set in the "Emails-Filters Dependency" file (see next section 2).
  2. Added ability to set Quiet Time intervals in filters. Now the "Emails-Filters Dependency" file has optional <quiet_time> tag which contains <from> and <to> values for quiet intervals. Please see example of the quiet time intervals in the XML file hereThe matching XSD schema file is located herePlugin internally validates XML file using this schema. 
  3. Enhanced support for different communication types between plugin and SMTP mail server: 
    1. Now, besides plain text and SMTP over SSL communications, plugin also supports the STARTTLS type of communication. New configuration parameter "SMTP STARTTLS" was added to reflect use of the SMTP STARTTLS communication. When it is 'true' the SMTP STARTTLS communication is used, otherwise this communication type is not used. Below is an example of the STARTTLS communication for Gmail SMTP server:
       
    2. Added ability to use different flavors of SMTP communication settings by utilizing additional SMTP Custom Properties. New parameter "SMTP Custom Properties File" points to the file which contains key and value pairs that will be added by the plugin to the SMTP properties file at run time. Example of the SMTP Custom Properties file is located here.  

New in the Release 0.10.2

Improved logging messages.

New in the Release 0.10.1

Improved default formatting of the Infrastructure Alerts incidents.

New in the Release 0.10.0

New features include:

New in the Release 0.9.10

New features include:

New in the Release 0.9.9.21

Added support for international languages. 

New in the Release 0.9.9.20

Extended filtering by server name for non-server resource type of incidents. 

New in the Release 0.9.9.19

New features include:

New in the Release 0.9.9.18

New features include:

Each variable from the above list contains a semicolon separated respective values (e.g. applications, violated measure names, violated measure descriptions, etc.) which are taken from violations of given incident.

Java utility which verifies correctness of the Email-Filters Dependency File

Standalone Java utility mimic the Extended Mail Action plugin code which processes the Email-Filters Dependency XML files. It checks correctness of the  Email-Filters Dependency XML file based on provided XSD schema and plugin's built-in internal rules. Below are few examples of utility usage:

New in the Release 0.9.9.14

Fixed a filtering issue for agent groups and servers. 

New in the Release 0.9.9.13

GA release.

New in the Release 0.9.9.8 - 0.9.9.12

New features include:

These parameters are taken in minutes. The extendedmailactionplugin.properties file is located in the 'res' subdirectory of the plugin's jar file. Example of the extendedmailactionplugin.properties file is located here.

There are two new parameters which are added to the plugin to uniquely identify instance of the action plugin. They are:

Please see example of using these parameters here. While the first parameter is required to identify instance of the plugin which is associated with the specific incident rule, the second parameter is optional and only necessary when there are two or more instances of this plugin setup for a given incident rule. The last scenario of having two or more instances of the Extended Mail Action Plugin (as well as any action plugin) for given incident rule is highly discouraged if incidents are thrown frequently. If you have need in having multiple instances of the Extended Mail Action Plugin for a given incident rule, and given version of the plugin does not allow you to cover your needs with a single plugin instance, please contact us to provide your use cases. We will make this plugin (or other action plugins) to accommodate your use cases that you will have to configure just one instance of the plugin per incident rule.

Note

This version of the plugin is a beta version now. It will become a GA release after successful beta testing.

New in the Release 0.9.9.7

Additional filtering of notification e-mails:

- MESSAGE;
- RULE_DESCRIPTION;
- VIOLATION_HEADER_1;
- VIOLATION_MESSAGE_1;
- VIOLATION_HEADER_2;
- VIOLATION_MESSAGE_2;
- VIOLATION_HEADER_3;
- VIOLATION_MESSAGE_3;
- VIOLATION_HEADER_4;
- VIOLATION_MESSAGE_4;
- VIOLATION_HEADER_5;
- VIOLATION_MESSAGE_5.

Notification e-mail will be sent only if match is found in any of the above variables, otherwise notification e-mail will not be sent.

New in the Release 0.9.9.6

Added support for e-mail notifications from the Cloud:

New in the Release 0.9.9.5

Changes include:

New in the Release 0.9.9.4

Added hosts' DNS name to IP address translation for the agents, monitors, collectors, and servers. New predefined variables are added to the list of maintained by the plugin variables:

Provided write-up of the Workaround of incorrect sensitivity issue for built-in OOTB incidents for dynaTrace action plugins.

New in the Release 0.9.8

Added ability to embed into dashboard names predefined variables which will be substituted with their runtime values. 

New in the Release 0.9.7

Here is list of new features:  

New in the Release 0.9.6

Here is list of new features:  

Installation

Import the Plugin into the dynaTrace Server. For details how to do this please refer to the Online Documentation on Plugin Management.

Usage

The plugin was originally shared through the following discussion forum entry: Automatic Dash Report via e-mail.
The following link contains documentation for the plugin: Extended Mail Action Plugin.

The Extended Email Report Action Plugin has the following features:

  1. Filtering of incidents based on
    1. agents
    2. agent groups
    3. monitors
    4. collectors
    5. servers
    6. sendOnlyPatterns
    7. measureNamePatterns
  2. Customize Subject and Body of the e-mail
    1. Add/replace Subject and/or Body of the OOTB e-mail which is generated by the Email Alert Action plugin 
  3. Embed predefined variables into the customized text in order to provide incident's details at runtime in the Subject and/or Body of the e-mail. This list consist of the following variables:
  4. Attach multiple custom and/or OOTB dashboards in PDF format
    1. Filter reports using agent-names/agent-hosts, agent-groups, and/or custom timeframe
  5. Customize To, CC, and BCC fields of the e-mail by providing lists of e-mail addresses
  6. Set From e-mail address
  7. Set specific SMTP mail server
  8. Supports setting up individual thresholds for the Dynatrace dynamic measures

The plugin provides a great extension to the default Email Alert Action plugin.

 Configuration

The following screenshot shows an example configuration for non-SSL SMTP server.
 
Next screenshot shows an example configuration for SSL SMTP server:

Next screenshot shows Report Filtering by Agent Name/Agent Host, Agent Group, and Custom Timeframe:

 

Next screenshot shows an example configuration of the Body parameter:

Next screenshot contains more complex example of the Body parameter (full content of the Body parameter is here):


Next screenshot shows e-mail which was created by the Body depicted in the previous screenshot:


 For more examples of Body, Body Header, and Body Footer parameters please see pages 11 - 13 of the Extended Mail Action Plugin document.

Next screenshot shows an example configuration of filtering by agents:
For more details about filtering see section 2 on page 7 of the Extended Mail Action Plugin document.

Next screenshot shows an example configuration for generating and attaching PDF files to the e-mail:
 

Custom Text

The following notation is used to embed predefined variables in the text:

Next is an example of custom text:

"I do not like incidents, especially when they are coming from the agent ${AGENT_NAME} which is running on the host ${AGENT_HOST}"

For more examples see section 4 on page 9 of the Extended Mail Action Plugin document.

 

Feedback

Please provide feedback on this plugin either by commenting on this page or by comments on the Community Plugins and Extensions

Contribution

Feel free to contribute any changes on Github

Comments

Please post comments in AppMon & UEM Plugins

Looking for old comments? Find them here (this page is loading very slow!)