TrueNAS Nightly Development DocumentationThis content follows experimental nightly development software. Pre-release software is intended for testing purposes only.
Use the Product and Version selectors above to view content specific to a stable software release.
Reporting
7 minute read.
The Reporting screen displays graphs of system information for CPU, disk, memory, network, NFS, partition, target, UPS, ZFS, and system functions. Use the dropdown in the upper right corner to select between reporting graph display options. The CPU report displays by default.
To configure a third-party reporting integration, such as Graphite, click Exporters to open the Reporting Exporters screen.
The following sections provide examples of each report graph. There are a few controls to change the default graph view:
- The Auto Refresh toggle updates the graphs with the latest reporting data every few seconds. When active, the graph resets to the chosen Reset Zoom view every time the reporting data updates. Disable Auto Refresh before manually zooming in on any section of the graph.
- Step Back () moves the graph backward in time by whatever time increment is currently active in Reset Zoom.
- Step Forward () moves the graph forward in time by whatever time increment is currently active in Reset Zoom. The default graph view is to show the latest data, which disables this button.
- Zoom Out () adjusts the time period shown in the graph between 1 Hour, 1 Day, 1 Week, 1 Month, and 6 Month views.
- The Reset Zoom indicator shows which time value is active for the graph. The default 1 Hour is the default (and minimum) time period that can be active. When Zoom Out is active, click Reset Zoom to reset the graph view to 1 Hour.
- Zoom In () adjusts the time period shown in the graph between 1 Hour, 1 Day, 1 Week, 1 Month, and 6 Month views. This is active when the graph changes from the default 1 Hour view.
To manually adjust the vertical or horizontal precision of the graph, disable Auto Refresh, then click and drag within the graph view. A left-to-right (or vice-versa) motion increases the horizontal view precision, while an up-to-down (or vice-versa) motion increases the vertical precision.
Displays the CPU Temperature, CPU Usage, and System Load graphs.
Displays graphs for each selected system disk and by report type.
Displays both the Physical memory utilization and Swap utilization graphs.
Displays an Interface Traffic graph for each interface in the system.
Displays both the Processes and Uptime graphs.
Displays the UPS Charging percentage, UPS Runtime, UPS Voltage - Battery, UPS Voltage - Input, UPS Voltage - Output, UPS Input Current, UPS Input Frequency, UPS Input Load, and UPS Temperature.
The UPS service must be configured with a compatible Uninterruptible Power Supply (UPS) device.
Displays the ARC Size, ARC Hit Ratio, ARC Requests demand_data, ARC Requests demand_metadata, ARC Requests prefetch_data, and ARC Requests prefetch_metadata graphs with the Arc and L2 gigabytes and hits (%), and the hits, misses and total number of requests.
Exporter on the Reporting screen opens the Reporting Exporter screen. The Reporting Exporters screen displays reporting exporters configured on the system. Exporting enables TrueNAS SCALE to send Netdata reporting metrics to another time-series database. Exporters send Netdata reporting records as JSON objects to third-party reporting collection cloud services or applications installed on servers. For more information, see the Netdata exporting reference guide.
Add opens the Add Reporting Exporter screen.
Use the Add Reporting Exporter screen to configure third-party reporting integrations.
Setting | Description |
---|---|
Name | Enter a unique name for the exporter configuration. If configuring multiple instances, give each a distinct name. |
Type | Select the report object format. At present, GRAPHITE is the only current supported option. Selecting GRAPHITE displays the exporter configuration settings |
Enable | Select to enable sending reporting data to the configured exporter. Leave the checkbox clear to disable the explorer without removing the configuration. |
Additional settings populate based on the selected Type option.
See Adding a Reporting Exporter for guidance with configuring a Graphite exporter on TrueNAS.