TrueNAS SCALETrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.


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.

What does TrueNAS SCALE use for reporting?

TrueNAS SCALE uses Netdata to gather metrics, create visualizations, and provide reporting statistics.

Click Netdata from the Reporting screen to see the built-in Netdata UI. This UI bases metrics off your local system and browser time, which might be different from the default TrueNAS system time.

To configure a third-party reporting integration, such as Graphite, click Exporters to open the Reporting Exporters screen.

Report Graphs

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.

CPU Graphs

Displays the CPU Temperature, CPU Usage, and System Load graphs.

Click Here for More Information

CPU graphs show the amount of time spent by the CPU in various states such as executing user code, executing system code, and being idle. Graphs of short-, mid-, and long-term load are shown, along with CPU temperature graphs.

Disk Graphs

Displays graphs for each selected system disk and by report type.

Click Here for More Information

Disk graphs show read and write statistics on I/O, percent busy, latency, operations per second, pending I/O requests, and disk temperature. Use the Select Disks dropdown list to select the disks and the Select Reports dropdown to select the report types to display.

Disk Report Setting Options

Select AllDisplays all available graphs for any or all disks selected on the Disks dropdown list.
Disk TemperatureDisplays the minimum, maximum, and mean temperature readings for the disk selected.
Disk I/ODisplays the disk read and write I/O stats in bytes/s.
Temperature monitoring for the disk is disabled if HDD Standby is enabled. Check the Storage > Disks Edit Disk* configuration form for any or all disks in the system if you do not see the temperature monitoring graph.

Large petabyte systems may report storage numbers inaccurately. Storage configurations with more than 9,007,199,254,740,992 bytes will round the last 4 digits.

For example, a system with 18,446,744,073,709,551,615 bytes reports the number as 18,446,744,073,709,552,000 bytes.

Memory Graphs

Displays both the Physical memory utilization and Swap utilization graphs.

Click Here for More Information

Memory graphs display memory usage and swap graphs display the amount of free and used swap space.

Network Graphs

Displays an Interface Traffic graph for each interface in the system.

Click Here for More Information

Network graph report received and transmitted traffic in megabytes per second for each configured interface.

System Graphs

Displays both the Processes and Uptime graphs.

Click Here for More Information

System graphs display the number of processes grouped by state, sleeping, running, stopped, zombies and blocked, and system uptime.

UPS 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.

UPS Reporting
Figure 8: UPS Reporting

ZFS Graphs

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.

Click Here for More Information

ZFS graphs show compressed physical ARC size, hit ratio, demand data, demand metadata, and prefetch data and metadata.

Reporting Exporters Screen

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.

Reporting Exporters Screen
Figure 11: Reporting Exporters Screen

Add opens the Add Reporting Exporter screen.

Add Reporting Exporter

Use the Add Reporting Exporter screen to configure third-party reporting integrations.

Add Reporting Exporter
Figure 12: Add Reporting Exporter
NameEnter a unique name for the exporter configuration. If configuring multiple instances, give each a distinct name.
TypeSelect the report object format. At present, GRAPHITE is the only current supported option. Selecting GRAPHITE displays the exporter configuration settings
EnableSelect 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.

Graphite Settings

Graphite Exporter Settings
Figure 13: Graphite Exporter Settings
Graphite Setting Descriptions
Destination IpRequired. Enter the IP address of the Graphite server.
Destination PortRequired. Enter the port the Graphite server monitors.
PrefixEnter the top level of the file hierarchy for the path to use to store exported records. For example, enter the top-level folder name for the path, and use Namespace to enter the folder for the data records. For example, enter dragonfish.
namespaceEnter the name of the folder where you store data records. Use the Prefix to define the full path. You can also enter the host name to add to all data records sent to the Graphite server. Defaults to truenas.
Update Every(Optional) Enter the number of seconds for the interval to send data to the Graphite database. Defaults to 1.
Buffer On Failures(Optional) Enter the number of iterations (Update Every seconds) to buffer data when the Graphite server is not available. Defaults to 10.
Send Names Instead Of Ids(Optional) Enter true to send Netdata chart and dimension names to Graphite or false to send IDs. Defaults to true.
Matching Charts(Optional) Enter one or more space-separated patterns in regular expression. Use the asterisk () as a wildcard to send all charts or the exclamation mark (!) to define a negative match to specify the charts to send to Graphite. Defaults to ().

See Adding a Reporting Exporter for guidance with configuring a Graphite exporter on TrueNAS.