TrueNAS SCALE Version Documentation
This content follows the TrueNAS SCALE 24.04 (Dragonfish) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.
Reporting
5 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.
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 in the form of 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 checkbox clear to disable the explorer without removing configuration. |
Additional settings populate based on the selected Type option.
See Adding a Reporting Exporter for guidance with configuring a Graphite exporter on TrueNAS.