Name

Reporting Monitor

Description

The Reporting Monitor executes the client-side report for the selected dashboard and either provides the result via email or stores it in a folder on the file system. It is executed on a Collector which is running on the same machine as the dynaTrace Client.

Plug-In Version

3.2.0

Compatible with

dynaTrace 3.1.0, 3.1.1, 3.2.x

Starting with dynaTrace 3.5, automated reporting is fully integrated into the product, this plugin is not necessary any more, see documentation under Automated Reporting for more information.


In dynaTrace 3.2.x, this plugin is shipped out-of-the-box with the product. No separate installation is necessary.

Author

dynaTrace community

License

dynaTrace BSD

Support

dynaTrace Supported

Downloads

Download plug-in Reporting Monitor v.3.2.0

Key benefits

  • Can send scheduled, automated reports via email or store it on the file system.
  • Easy customizable to fit to your needs.
  • Integrates with dynaTrace 3+.
  • Open Source: adapt the Reporting Monitor to your needs

Key features

  • Generate a report from a Dashboard and send it via email
  • Generate a report from a Dashboard and store it anywhere on the file system
  • Can provide report in HTML (both as attachment and as HTML email), PDF and XML format
  • Configurable email sending options
  • Chartable success state
  • Alerting on success state

Technical overview

  • Uses SMTP protocol to send email
  • Inlines images in HTML email so the email is displayed without security warnings about foreign content
  • Plugin is deployed once and can then be executed on any dynaTrace Collector where a dynaTrace Client executes on the same machine
  • OS independent

Install Description

  1. Define a machine where the dynaTrace Client is executing
  2. Make sure a Collector is also running on that machine
  3. Open dynaTrace Server preferences (right click on dynaTrace Server Node in cockpit and then select preferences from context menu).

  4. Import the Reporting Monitor, either as .jar-file or from a folder where it is extracted
  5. Activate the Reporting Monitor in the dynaTrace Server preferences.
  6. Adapt server-wide plug-in properties (opened with double-click or clicking on "Properties")


    In the server-wide plug-in properties (dynaTrace Server preferences >> Plug-ins) you can edit the default values and set the state. Every newly added Monitor which uses the Reporting Monitor will receive these default values. You can choose between "Edit", "Read" or "Hidden", so the default Settings can be edited, read-only or are not visible in the individual Reporting Monitor settings.

Setup Execution

  1. How to create a Reporting Monitor
    1. Open your System Profile >> Preferences
    2. Choose "Monitors" from the configuration panel
    3. Choose Add...
    4. Choose Reporting Monitor from the list of available Types
    5. Rename your Reporting Monitor and adapt description
    6. Confirm.

  2. How to schedule a Reporting Monitor
    1. Open System Profile >> Preferences
    2. Choose "Monitors" from the configuration panel (Property Navigation)
    3. Select the Monitor you wish to edit and click "Edit..." button
    4. Preferences dialog opens.
    5. Select a predefined schedule or create your own schedule if none fits.
    6. Confirm.

  3. How to configure a Reporting Monitor
    1. Open System Profile >> Preferences
    2. Choose "Monitors" from the configuration panel (Property Navigation)
    3. Select the Monitor you wish to edit and click "Edit.." button
    4. Select the "Settings" tab


      The following configuration options are available:
      1. dynaTrace Client Port - The Port that is configured on the dynaTrace Client as "Listen Port" under "Allow non-ssl connections" in the Client Preferences. This is the Port under which the dynaTrace Client exposes WebServices. Note Using an SSL Connections to the dynaTrace Client is currently not implemented in the plugin.
      2. Dashboard - The Dashboard that is reported.
      3. Report Type - The type of report that is created. One of the following:
        1. HTML email - Send the report as HTML email. If file storing is configured, store the report in HTML format.
        2. HTML as Attachment - Send the report as normal email with an attached HTML file. If file storing is configured, store the report in HTML format.
        3. PDF - Send/store the report in PDF format
        4. XML - Send/store the report in XML format
      4. Send email - allows to turn on/off sending emails as part of executing the plugin
        1. email Subject - The subject of the email that is sent. Defaults to "Your scheduled report"
        2. email Sender - The email address to use for the 'from' field. Defaults to "unknown@example.com"
        3. email Receivers - The list of target email addresses separated by semicolon or comma.
        4. email Cc Receivers - The list of target email cc-addresses separated by semicolon or comma (optional).
        5. email Bcc Receivers - The list of target email bcc-addresses separated by semicolon or comma (optional).
        6. Bounce - Address to which undeliverable mail should be sent.
        7. STMP Host - The hostname of the mail server used to send emails. The mail server needs to be configured to accept mails via the SMTP protocol.
        8. SMTP Port - The port on the mail server that is configured for receiving email. When left empty, the default port '25' is used.
        9. SMTP User - The username that will be used for authentication (optional).
        10. SMTP Password - The password of the SMTP user (optional).
      5. Store on file system - Enables storing the report on the file system.
        1. File System Location - Defines where on the file system the resulting file should be stored. Not needed when using only email delivery.

  4. How to control where the Reporting Monitor is executed


    In general monitors always run on dynaTrace Collectors. As you can see in the previous screenshot you can decide centrally from your dynaTrace Client (in the monitor's settings) on which Collector a specific Monitor Task is executed..

    Note: Tasks are always executed on the server, Monitors are executed on a collector.


  5. How to test, run, suspend a Reporting Monitor


    "Run Now" will provide the success/failure state of the plugin as measure, "Try Now" will not read this measure. This way you can avoid to trigger alarms if the execution of the plugin is linked to incidents via the measure.

Known Problems

  • The plugin does not support SSL connections to the client currently.
  • Image files are not included as part of HTML reports if HTML is sent as attachment, sending the report as HTML formatted email includes images correctly.
  • With dynaTrace Client Version 3.1.0 and 3.1.1, the Dashboard needs to be open on the client that is used for generating the report. This limitation will be removed in version 3.2.0.
  • There is a possible problem with mail sending in some versions of the JDK.
    Symptom: When executing the plugin to send emails, an error message is reported that contains the text "no object DCH for MIME type multipart/mixed;"
    Cause: There is a problem in the JavaMail API provided by Sun Microsystems which is fixed starting with JDK 1.6 update 10. On previous patchlevels of JDK 1.6.0 the problem can be fixed by putting the file "mail-1.4.1.jar" into dynaTrace's ./server/lib/endorsed directory.
    Workaround:
    1. Extract the file "mail-1.4.1.jar" from the downloaded Reporting Monitor and store it in the installation of the dynaTrace Server and any related dynaTrace Collector at ./server/lib/endorsed and ./collector/lib/endorsed
    2. Restart both Server and Collector

      See https://support.dynatrace.com/supportportal/browse/SUP-2582 and http://project.dynatrace.local:8080/jira/browse/JLT-16904 for details.