system-license-usages

Retrieves daily license usage for each node in the cluster. Cluster administrator permission is required.

Command properties

PropertyDescription
Command typeDriver query
Required permissionCluster administrator
License usageNot counted
Parallel executionNot supported
Distributed executionNot supported

Syntax

system-license-usages

Options

None

Output fields

FieldTypeDescription
_timetimestampDate for which license usage was aggregated
nodestringNode name
volumelongCumulative size of log data collected on that date (bytes)
countlongNumber of logs collected on that date

Error codes

Parsing errors
Error codeMessageDescription
95020No read permission. Cluster administrator permission is required.The user does not have cluster administrator permission
Runtime errors

N/A

Description

The system-license-usages command retrieves daily license usage statistics for each node in the cluster. You can view the number of logs and byte size of logs collected by each node per date.

This command requires cluster administrator permission.

Examples

  1. Retrieve all license usage

    system-license-usages
    

    Retrieves daily license usage for all nodes in the cluster.

  2. Retrieve total daily collection volume by node

    system-license-usages
    | stats sum(volume) as total_volume, sum(count) as total_count by node
    

    Retrieves the total collection size and count by node across all dates.

  3. Retrieve total cluster usage by date

    system-license-usages
    | stats sum(volume) as total_volume, sum(count) as total_count by _time
    | sort _time
    

    Retrieves the license usage trend for the entire cluster by date.