Downloading the usage report

Required global permission: View summary usage metrics

The usage report summarizes the number of table rows and cells that data generation jobs applied generators to.

The usage report was introduced in V876. The report does not include jobs that ran before V876 was released.

Selecting the download option for the usage report

To download the report, on Tonic Settings view, click Download Usage Report.

The report is downloaded as usage_report.csv.

Information in the usage report

Each entry in the report represents a table that was processed by a data generation job.

The report contains the following columns:

  • Date - The date and time when the data generation job completed.

  • WorkspaceName - The name of the Tonic Structural workspace.

  • WorkspaceId - The identifier of the Structural workspace.

  • JobId - The identifier of the data generation job.

  • TableMode - How the table was processed.

    • PassThrough indicates that none of the columns had assigned generators.

    • Masked indicates that the data generation job applied generators to table columns.

    • Truncated indicates that the table mode was Truncate. No generators were applied.

  • TableName - The name of the table.

  • RowCount - The number of rows in the table that were processed. Indicates that generators were applied or that the rows were included in a subset.

  • CellCount - The number of processed rows multiplied by the total number of columns in the table.

Limiting the number of rows in the usage report

The environment setting USAGE_ROWS_COUNT_LIMIT determines the maximum number of rows to include in the report. When the number of rows exceeds this limit, Structural removes rows from the oldest jobs one job at a time until the number of rows is within the limit.

To determine the value, use the following formula:

<number of days> * <number of jobs per day> * <number of tables>

The default value is 450,000. This value was calculated based on 90 days with 5 jobs per day that each process 1000 tables.

For information on how to change an environment setting value, go to Configuring environment settings.

Last updated