Help : Server : Reports

The reports control panel allows you to upload new report templates, view installed report templates, view reports, delete report templates and run reports.

There are two types of report template:

  • Interactive Interactive templates prompt for additional information before they can generate a report. An interactive template will contain an ask action that specifies which parameters are needed. When an interactive template is evaluated it will prompt for the missing parameters using a form.
  • Scheduled Scheduled reports are updated each night. By default reports will updated at 2am (this time can be changed by setting PeriodicReportHour in the configuration file).

For more information, see the tutorial Creating your own reports.

To install a new report template

  1. Construct a report template using a text editor on your PC. This file needs to be saved in plain text (do not store it as a Word document!).
  2. Connect to the Traffic Server using your web browser.
  3. Click on the Server button at the top of the page.
  4. Provide the administrator user and password.
  5. Click on the Reports button on the left of the page.
  6. Click on the Browse button and select the report template you created in step 1.
  7. Click on the Submit button to upload your report template.

To view an installed template

Templates may be viewed by simply clicking on the <report>.shtml link in the reports table. Copying an existing template is often the best starting point for authoring new report templates. Simply use your browser to save the template to your local disk, edit it, and then install the new report template.

To view a report

Click on a <report>.html link to see the report.

To delete a template

Click on the Delete link to remote a template.

To test a template

Click on the Run button to evaluate a template. In the case of a Scheduled report, the result will be the creation of a <report>.html file that can then be viewed. If an Interactive template is evaluated, the result will be form prompting for parameters. Once the requested parameters have been supplied, click the Run button to generate a report, or click the Schedule button to create a scheduled template.

To schedule an report based on an interactive template

Click on the Run button to evaluate an interactive template. A form will prompt for parameters. Once the requested parameters have been supplied, click the Schedule button to create a scheduled template. The new template will generate a report during the next scheduled reporting cycle.

To disable a scheduled report

Click on the Disable button next to a scheduled report in order to prevent it from automatically running at scheduled reporting times. If a report is disabled it will have an Enable button that will allow the report to be re-enabled.

To email a scheduled report

Click on the Edit button and then enter an email address, or a comma separated list of email addresses. Each night when the report is run, it will be emailed to the list of receipients.
Note: You must configure the smtpHost parameter in the configuration file before reports can be emailed.