Automated reporting

Overview

Use the reporting functionality in the AppMon Client to produce a variety of reports from dashboards that you can easily share. Generate manual reports on the fly or schedule reports to run at regular intervals, like weekly performance reports.

To automate monitoring tasks, AppMon schedules reports or uses external actions to trigger them using REST interfaces. See Sample Use Cases below for more information.

The AppMon automated reporting functionality also lets you schedule sending email reports using SMTP protocol. Embedded images and styling information in the HTML email so the content appears in email clients without security warnings.

Report automation options

AppMon includes additions to the core reporting functionality so you can automate the process in various ways.

Scheduled Report Execution: Schedule a report to run at various intervals and send it using email. You can store the report in the file system and process it further. For example, you can publish it to a company web portal.

Retrieve Reports with REST Web Services Interface: You can use your own scheduler and receive reports using the REST interfaces. See Server REST Interfaces for more information.

Trigger Reports with REST Web Services Interface: To trigger and send a report at certain times such as when a test run completes, and send it by email, you can create a reporting task. See the walkthrough on this page to learn how.

You can use the REST interfaces to trigger reports. See Server REST Interfaces for more information.

Retrieve Detail Data for Further Processing: You can process the information in XML reports more than other report types. The report data includes charts, and you can also retrieve full details about PurePaths. See Server REST Interfaces and Server- and Client-Side XML Reporting for more information.

Sample use cases

This section lists common use cases and how you can implement them.

Use Case Implementation
The operator wants to send a weekly status report by email to the management team.
  • Define the dashboard to send.
  • Configure report details in the dashboard properties: Select report format, exclude unnecessary dashlets, and set correct reporting order for dashlets.
  • Create a scheduled report in the reporting dialog box and define the email details, including the recipient and schedule.
The build engineer wants to email a report after the nightly build and test run is complete.
  • Set up a dashboard and a report schedule similar to the previous use case.
  • Set the schedule to manual execution.
  • In your build scripts at the point when building and testing is finished, trigger the reporting task using the REST interfaces, see Server REST Interfaces for details.
A performance engineer wants to retrieve details from a chart for more detailed analysis.
  • Set up a dashboard with charts that display the information.
  • Retrieve the XML report that contains the necessary details for each chart using Server-side XML Reporting.
  • For a different time frame, adjust the dashboard filter or specify additional filter parameters for the REST calls.
A developer wants to retrieve details from PurePaths for statistical analysis of called code locations.
  • Set up a dashboard with a PurePath dashlet that includes the correct source and filter.
  • Retrieve the XML report, which contains the necessary details for the selected or all PurePaths, using the interfaces for Server-side XML Reporting and provide the parameter purePathDetails.
  • For a different time frame, adjust the dashboard filter or specify additional filter parameters for the REST calls.

Walkthrough

With automated reporting, you can present accumulated data to stakeholders or deliver the daily KPI status update to your inbox. Reporting is mandatory, and you don't want to spend too much time to gather the data, format the report, and process it. If you run a report twice, you should automate it with AppMon's reporting features.

This walkthrough demonstrates the AppMon reporting features and how they make reporting easier. Learn how to schedule your reports.

Create your own dashboards or use those that come with AppMon. If you don't have a System Profile, and have no data from Agents, use the built-in dashboards for self-monitoring.

Follow these steps to automate reporting:

  1. Open the reporting dialog box.
  2. Customize the necessary information.
  3. Create a reporting schedule.
  4. Automate report generation based on these schedules.

Create a report schedule

Create a schedule for your report if you want it to be sent out by email daily, weekly or both to various recipients.

To do this, click Report from the Dashboard menu, then click Create Schedule and create a new schedule. Create a schedule so that the PDF report is sent to your mailbox daily at 8am, and weekly, to your manager. You must create two schedules.

For the daily schedule, use the following definitions:

Start on: Today

Time to Send: 08:00AM

End: Forever

Recurrence: Every Day in Every Month

Define the exclusion for Saturday and Sunday separately:

Schedule Exclusion: Exclude Always

On: Saturday and Sunday

In: Every Month

The second schedule executes every month on the first of the month:

Start on: First day of the month

End: Forever

Recurrence: Every Month

Monthly Schedule: Send the Report on the First Day of the Month After you configure your dashboards with relevant data, automate reporting to save time. Also this automation capability can serve as a data export engine to your favorite tools. Get the data delivered at certain times or pull it into your automation tools from scheduled tasks for further processing.

Note

If the AppMon Server is not available on the network with the internal host name, but with some other host name or only when the link-address contains the domain name, you can still generated working links in the reports. Use the External hostname field to specify the fully qualified host name or IP address that AppMon uses to create links in reports, emails, and the server web interface. To access this, click Settings > Dynatrace Servers > Services > Management.