Product usage configuration entry reference

This topic provides reference information for product usage configuration entries, which enable opt-in telemetry reporting to help improve Consul operations. For more information, refer to Opt-in to data reporting.

Configuration model

Kind: string | required | must be set to product-usage
Name: string | must be set to global
Enabled: boolean | false
Reporting: map
- Mode: string

Complete configuration

When every field is defined, a proxy defaults configuration entry has the following form:

Kind = "product-usage"  
Name = "global"  

Enabled = true  

Reporting {  
 Mode = "connected"       
}

Specification

`Kind`

Specifies the type of configuration entry to implement. Must be set to product-usage.

Values

Default: None
This field is required.
Data type: String value that must be set to product-usage.

`Name`

Specifies a name for the configuration entry that is used to identify the configuration entry. Must be set to global.

Values

Default: None
This field is required.
Data type: String that must be set to global.

`Enabled`

When set to true, enables anonymous telemetry reporting to help improve Consul development.

Values

Default: false
Data type: Boolean

`Reporting`

Optional map to configure reporting behavior for connected or air-gapped environments.

Values

Default: None
Data type: Map of the following field:
- Mode must be set to one of the following string values:
  - connected: Telemetry reporters export data in datacenters with external network access
  - air-gapped: Telemetry export is disabled and snapshots are retained in memory for manual reporting

Examples

The following example configuration enabled opt-in telemetry reporting for air-gapped environments.

Kind = "product-usage"  
Name = "global"  

Enabled = true  

Reporting {  
 Mode = "air-gapped"       
}