PRTG Manual: Report Settings
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.
Use the reports tabs to access all functionalities and settings of a report.
Click Go to all reports at the bottom of the page to open the overview list of all reports.
In this section:
- Run Now
- Stored Reports
- Settings
- Basic Report Settings
- Included Sensors
- Report Schedule
- Report Period
- Percentile Handling
- Data Files
- Report Comments
- Access Rights
- Select Sensors Manually
- Sensors Selected by Tag
- Comments
On the Run Now tab, you can immediately run a report with the settings that you defined before.
For more information, see section Run Reports.
On the Stored Reports tab, you can view reports that you created.
For more information, see section Run Reports.
Click the Settings tab to open the settings of a report.
When you set up or run a report, also keep in mind the remarks for reports.
Setting |
Description |
---|---|
Report Name |
Enter a name to identify the report. PRTG uses the name in reports lists and as the title of generated reports.
|
Tags |
Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.
|
Report Template |
Select a template for the report from the dropdown list. The template defines the overall look of your report and in which detail the report shows monitoring data. PRTG includes several preconfigured report templates. You can choose templates from the following categories:
|
Security Context |
Define the security context that the report uses for access to monitoring data. Select a user account from the dropdown list to define which objects are visible in the report. The report only contains objects that the selected user has the access rights to view. By default, the security context is the user account that creates the report.
|
Time Zone |
Select a time zone from the dropdown list. PRTG uses this time zone for all date-specific settings in the report. |
Page Format |
Define the page size in which PRTG creates .pdf files.
|
Page Orientation |
Define the page orientation for the data in PDF reports:
|
Setting |
Description |
---|---|
Cluster Node |
This setting is only visible if you run PRTG in a failover cluster. Select the cluster node from which the report takes monitoring data from the dropdown list. The available options are specific to your configuration. By default, the master node is set. Select All cluster nodes to create a report that includes data from all of your cluster nodes.
|
Sensors by Tag |
Select the sensors that you want to include in the report by tag. Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited. The report covers all sensors that have at least one of the tags. You can also leave the field empty. You can also use the plus sign (+) or the minus sign (-) to categorize tags as must have or must not have, for example, +snmp –wmi (must have the tag snmp and must not have the tag wmi).
|
Filter Included Sensors by Tag |
Filter the included sensors further. Use this option, for example, if you manually add entire probes, groups, or devices to the report and do not want to include all sensors that have these objects as their parent objects. PRTG then only includes the sensors in the report that have at least one of the tags that you enter here. Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited. You can also leave the field empty. You can also use the plus sign (+) or the minus sign (-) to categorize tags as must have or must not have, for example, +snmp –wmi (must have the tag snmp and must not have the tag wmi).
|
Setting |
Description |
---|---|
Schedule |
Define the time at which you want to automatically run the report:
|
Specific Hour |
This setting is only visible if you select Every day at a specific hour above. From the list, select the hour at which you want to run the report. |
Specify Day |
This setting is only visible if you select Every specific day of the week above. From the list, select a day of the week or a day of the month for which you want to run the report.
|
Specific Date |
This setting is only visible if you select Every specific date above. Enter a valid date in the format DD.MM., for example, 31.12. The report runs on this date every year. |
This setting is only visible if you select one of the schedule options above. Define what you want to do with a finished report:
|
|
Target Email Address |
This setting is only visible if you select one of the email options above. Enter one or more valid email addresses to which PRTG sends the report. Use commas to separate email addresses.
|
Email to User Group |
This setting is only visible if you select one of the email options above. From the list, select a user group to which you send an email with the report. All members of this group receive the email. You can edit user groups in the User Groups settings.
|
File Compression |
This setting is only visible if you select one of the email options above. Define if PRTG compresses the attached report files before it sends them:
|
Setting |
Description |
---|---|
Report Period Type |
Define the type of period for which you want to create the report:
|
Period |
Define the period that the report covers:
|
Day Period |
This setting is only visible if you select Day above. From the list, select the hours at which a day starts and ends. The default setting is 0:00-23:59. |
Week Period |
This setting is only visible if you select Week above. From the list, select the days of the week when the week starts and ends:
|
Month Period |
This setting is only visible if you select Month above. From the list, select the days of the month when the month starts and ends:
|
Year Period |
This setting is only visible if you select Year above. From the list, select when the year starts and ends:
|
Report Schedule |
From the list, select a specific time span for which you want to generate the report. The report only includes monitoring data for specific hours or weekdays within the defined period. Select None to include all available monitoring data in the report, or choose a schedule, for example Weekdays, to exclude all weekends from the report. The available schedules depend on your configuration.
|
Setting |
Description |
---|---|
Percentile Results |
Define if you want to include an additional percentile calculation of your data in the report:
|
Percentile Type |
This setting is only visible if you enable Show percentiles above. Enter the percentile type that you want PRTG to use for the calculation. If you choose, for example, to calculate the 95th percentile, enter 95 here and 5% of peak values are discarded. Enter an integer. |
Percentile Averaging Interval |
This setting is only visible if you enable Show percentiles above. Enter a value to define the averaging interval on which PRTG bases the percentile calculation. The default value is 300 seconds (5 minutes). This means that PRTG takes 5-minute averages as basic values for the percentile calculation. Enter an integer. |
Percentile Mode |
This setting is only visible if you enable Show percentiles above. Select the mode for percentile calculation:
|
Setting |
Description |
---|---|
Files in CSV / XML Format |
Define if you want to generate .csv and .xml files for data tables in the report in addition to the .pdf file:
|
Setting |
Description |
Introductory Comment |
Enter a custom text that the report displays at the top of the first page. Enter a string or leave the field empty. |
Final Comment |
Enter a custom text that the report displays below the last data table or graph on the last page. Enter a string or leave the field empty. |
Setting |
Description |
---|---|
User Group Access |
Define the user groups that have access to the object. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:
|
Save your settings. If you change tabs or use the main menu without saving, all changes to the settings are lost.
Click the Select Sensors Manually tab to manually add sensors that you want to include in the report.
You see a split screen: On the left side, there is a list of objects that the report already contains, and on the right side, you see your device tree. You can add objects to the report via drag-and-drop.
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.
The following actions are available:
Action |
Description |
---|---|
Add items |
From the device tree on the right side, drag objects and drop them onto the list on the left side. You can add entire probes, groups, devices, or single sensors. PRTG adds each dropped object as a new list item.
|
Select channels |
If you add a sensor to the selection, you can specify the channels that the report includes. By default, PRTG selects all channels. To exclude a channel from the report, disable the check box in front of a channel name.
|
Change order |
You can change the order of list items on the left side via drag-and-drop. Click |
Remove |
To remove any objects from the report, click |
PRTG automatically saves your selection. There is no undo function.
The final report includes both manually selected sensors and sensors selected by tag.
Click the Sensors Selected by Tag tab to view all sensors that you added to the report by tag in section Included Sensors of the report settings. This is for your information only, you cannot change sensors here.
To edit the sensor selection, go to the Settings tab of the report and change the tags that the report uses to include sensors. Additionally, you can also exclude sensors with specific tags there.
For sensors that you add by tag, PRTG automatically includes all channels in the report unless you use a cluster and select All cluster nodes in the Cluster Node setting of the report. In this case, the report only includes the primary channel of each sensor.
The final report includes both manually selected sensors and sensors selected by tag.
On the Comments tab, you can enter free text for each object. You can use this function for documentation purposes or to leave information for other users.
KNOWLEDGE BASE
What security features does PRTG include?
Creating a PDF report does not work. What can I do?