TrueNAS SCALETrueCommand Version Documentation
This content follows TrueCommand version 3 releases. Use the Product and Version selectors above to view content specific to TrueNAS software or major versions.

Creating a Report

The Reports page customizes system metrics charts for data analysis.

ReportsList

Creating a Report

Click + CREATE REPORT to create a customizable report. Give the report a name and an optional description.

ReportsCreate

Click BROWSE WIDGETS or WIDGET to add charts to the report.

ReportsCreateWidgetsAdd

Widgets
SettingDescription
Custom Area ChartAdd a chart of data points with filled-in area.
Custom Bar ChartAdd a stacked vertical bar chart of data points.
Custom Line ChartAdd a chart of data points.
Average CPU Temperatures (Bar Chart)Show the average CPU temperature for the system.
Disk Activity ChartShow average disk activity as a percentage of capabilities.
Memory Utilization Percent (Area Chart)Show memory utilization of system as a function of time.
Network Traffic ChartChart of network traffic.
Network Device Chart (Download)Monitor network traffic per adapter.
Network Device Chart (Upload)Monitor network traffic per adapter.
Storage Utilization ChartTrack storage used over time.
Storage Pool Utilization ChartTrack storage used per-pool over time.
Disk IOPsTrack the number of total IOP writes and IOP reads.

Custom Charts

TrueCommand already configures most charts to report specific settings. To create a custom chart with custom settings, add a Custom Area Chart, Custom Bar Chart, or Custom Line Chart. Fill in the following options when adding a custom chart:

  • General settings: Enter a Title, Subtitle (optional), Axis label (optional), Point size, Line size, Y min (optional), and Y max (optional) for the chart. You can set Stack the values to bring data points on the chart closer together. Stack the values is helpful for charts with many different data points at the max Y value.
  • Data sources: Add data sources (like disk read and write IOPs) to the chart by clicking the Data sources dropdown and selecting which sources you want. You can add multiple data sources to one chart.
  • Summary: This step shows all chosen values. Click SAVE to add the custom chart to the report. Click BACK to change a setting or data source.

After adding charts to the report, click SAVE to make it available for use.

ReportsCreateReportSave

After creating a report, you can click GENERATE to generate the report, or you can go back to the reports page and create another.

ReportsGenerate

Edit a Report

Open the Reports page and click next to a report name to rename it, add a description, or add/delete a widget.

Share Report

By default, user-created reports are only available to that user. To share a report with other users or teams, open the Reports page and click the icon for the chart.

ReportsSharing

You can share reports with individual users or entire teams.

Delete a Report

To delete a report click . This permanently deletes the report but you can recreate it as needed.