Reporting

3 minute read.

Last Modified 2023-11-17 15:28 EST

The SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!

Reporting Namespace

The reporting namespace has 3 commands, and is based on system reporting functions found in the SCALE API and web UI. It provides access to reporting database configuration methods through the reporting namespace commands and the child namespaces and their commands.

To view reporting graphs, go to Reporting in the TrueNAS SCALE web UI.

Reporting Commands

The following reporting namespace commands allow you to configure the system reporting database.

You can enter commands from the main CLI prompt or from the system namespace prompt.

Clear Command

The clear command erases all existing data from the system reporting database.

Using the Clear Command

Description

clear does not require entering properties or arguments.

Enter the command string and then press Enter.

Usage

From the CLI prompt, enter:

system reporting clear

Press Enter.

The command returns an empty line.

Command Example

system reporting clear

Config Command

The config command returns the current system reporting configuration.

Using the Config Command

Description

config does not require entering properties or arguments.

Enter the command string and then press Enter.

Usage

From the CLI prompt, enter:

system reporting config

Press Enter.

Returns a table containing current configuration properties.

Command Example

system reporting config
+----------------------------+-------+
|                         id | 1     |
|                   graphite |       |
|                  graph_age | 12    |
|               graph_points | 1200  |
| graphite_separateinstances | false |
+----------------------------+-------+

Update Command

The update command allows you to change system reporting configuration settings.

Using the Update Command

Description

update has 5 optional properties, see table below.

Separate multiple properties with a single space. Enter the full command string and then press Enter.

Update Properties

Property	Required	Description	Syntax Example
`graphite`	No	Graphite integration is deprecated in TrueNAS SCALE 23.10 (Cobia).
`graphite_separateinstances`	No	Graphite integration is deprecated in TrueNAS SCALE 23.10 (Cobia).
`graph_age`	No	Sets the maximum age of stored reporting graphs in months. Requires the `confirm_rrd_destroy=true` flag to erase existing reporting data.	`graph_age=12`
`graph_points`	No	Sets the number of points for each hourly, daily, weekly, monthly, and yearly graph. Requires the `confirm_rrd_destroy=true` flag to erase existing reporting data.	`graph_points=1200`
`confirm_rrd_destroy`	Yes*	Required for either `graph_age` or `graph_points`. Erases all existing reporting database data.	`confirm_rrd_destroy=true`

Usage

From the CLI prompt, enter:

system reporting update graph_age=12 graph_points=1200 confirm_rrd_destroy=true

Where 12 is the maximum age of stored graphs in months and 1200 is the number of points for each graph. Press Enter.

The command returns an empty line. Use config to confirm changes.

Command Example

system reporting update graph_age=12 graph_points=1200 confirm_rrd_destroy=true

Reporting

Reporting Namespace

Reporting Commands

Clear Command

Description

Usage

Config Command

Description

Usage

Update Command

Description

Usage

Related Content

SCALE Tutorials

SCALE UI Reference

Have more Questions?