PRTG Manual: Reports Step by Step
IMPORTANT INFORMATION |
---|
This section was moved and is no longer kept up to date. For a detailed, up-to-date step-by-step guide, see the Paessler website: How to set up reports in PRTG in 5 easy steps. |
This documentation refers to an administrator that accesses the PRTG web interface on a master node. Other user accounts, interfaces, or failover nodes might not have all of the options in the way described here. In a cluster, note that failover nodes are read-only by default.
To run a report or to create a new report, follow the steps in this section.
In this section:
- Step 1: Add a Report
- Step 2: Select a Report Template
- Step 3: Select Cluster Nodes and Sensors
- Step 4: Define a Report Schedule and Additional Settings
- Step 6: Check and Adjust the Included Sensors
- Step 7: Run Report
First, you need to create a new report:
- Click Reports in the main menu bar to show an overview list of all reports.
- Hover over and select Add Report from the menu to open the Add Report dialog.
- Enter a meaningful Report Name.
- Optionally, enter Tags for the new report and define the Security Context, your Time Zone for all dates in the report, as well as the Page Format and the Page Orientation if you want to generate PDF files.
For more information, see section Reports Settings.
You can also add a report via the context menu of an object. In this case, the selected object is automatically included in the report.
When a user with administrative rights creates a new object, only other users with administrative rights can view or edit the new object by default. When a read/write user creates a new object, all members of the read/write user's primary group can view and edit the new object as well. This behavior applies to libraries, maps, reports, notification templates, and schedules. For more information, see section Access Rights Management.
Step 2: Select a Report Template
Select a Report Template from the list of available templates. This template defines the overall look of your report and in which detail the report includes monitoring data. There are templates that offer optional data tables in addition to graphs. You can also specify the calculation interval for graphs.
For more information, see section Reports Settings.
Step 3: Select Cluster Nodes and Sensors
Select the cluster nodes and sensors that you want to include in the report:
- This step is only necessary if you run PRTG in a failover cluster. Select a Cluster Node from which PRTG takes the monitoring data.
If you select All cluster nodes, PRTG creates a report with data from all of your cluster nodes, but only the primary channel of every sensor appears in the report. - Reports show monitoring results based on sensor data. You can either add sensors manually or by tag. If you want to add sensors by tag, go to the Included Sensors section. Enter one or more tags separated by a comma or space in the Sensors by Tag field to include all sensors that have at least one of these tags in the report. For example, enter the tag bandwidthsensor to include all sensors that measure bandwidth.
- Use the Filter Included Sensors by Tag setting to explicitly filter for sensors with specific tags, or to additionally filter sensors that you manually added by tag. You can also leave the field empty.
For more information, see section Tags.
Step 4: Define a Report Schedule and Additional Settings
Define more detailed settings like a report schedule or a report period:
- In the Report Schedule section, select No schedule if you only want to run the report on demand, or choose a schedule if you want to automatically run the report on a regular basis.
By default, PRTG does not run scheduled reports on failover nodes. - Set a Report Period that suits your needs.
- Define how you want to handle percentiles. If you choose Show percentiles, the report displays an overview table with the percentiles of each channel for the whole report period, and the percentiles of the primary channel in the table for each scanning interval.
- In section Data Files, select if you want to include .csv and .xml data files in the report in addition to a .pdf file. You can only generate data files for reports that include data tables.
- Optionally, add custom Report Comments for the beginning and the end of your report.
- Define individual Access Rights for your user groups. These access rights specify which user groups can view or edit the report.
Save your settings. If you leave the page, all changes to the settings are lost.
For more information, see section Reports Settings.
Step 6: Check and Adjust the Included Sensors
After you save the settings, PRTG opens the Select Sensors Manually tab where you can manually add entire probes, groups, devices, or individual sensors via drag-and drop in addition to the sensors that you selected by tag. You can also remove sensors from the selection.
Go to the Sensors Selected by Tag tab to see a list of all sensors that you added by tag. To change tags, go back to the Settings tab.
The final report includes both manually selected sensors and sensors selected by tag.
For more information, see section Reports Settings.
Open the Run Now tab, select a period, and in section Report Processing, select View report as HTML. Click Run Report. PRTG immediately generates the report in a new browser window or tab. Depending on the number of selected sensors and the used template, it might take a few minutes until you see the report. If you do not want to wait, close the newly opened browser window or tab and select a PDF option. Click Run Report again. The report is then generated in the background and you get a ToDo ticket or email once it is finished.
Knowledge Base
Creating a PDF report does not work. What can I do?