Consul agent telemetry reporting reference

This page provides reference information for the anonymized and aggregated telemetry data that Consul agents report. Consul does not report this data by default. For more information about this data, including instructions on how to opt-in to telemetry reporting, refer to Consul product telemetry.

Cluster data

We collect the following data about Consul clusters:

• Consul version
• Consul edition, such as CE or Enterprise
• Whether the FIPS-compliant version of Consul is used
• Deployment environment, such as Kubernetes, VM, or Nomad
• Operating system and architecture, such as Linux/amd64 or Linux/arm64
• Number of server agents
• Number of client agents
• Number of nodes in the catalog
• Number of unique services in the catalog
• Number of service instances in the catalog
• Number of KV entries
• Number of configuration entries per kind
• Whether transparent proxy is enabled
• Whether auto-encrypt is enabled

Gateway data

We collect the following data about gateways.

Mesh gateways

• Whether mesh gateways are used
• Number of mesh gateways in remote and local mode
• Number of mesh gateways across admin partitions and multi-cluster deployments
• Average latency between services connected through mesh gateways

Ingress gateways

• Whether ingress gateways are used
• Number of services the gateway routes to
• Number of tenants in namespaces and admin partitions that use ingress gateways
• Average latency from the ingress gateway to services

Terminating gateways

• Number of services routed through the gateway
• Number of tenants in namespaces and admin partitions that use terminating gateways
• Average latency from services to terminating gateway

API gateway

• Whether the API gateway is used
• Number of services the API gateway routes for the datacenter
• Number of tenants in namespaces and admin partitions that use the API gateway
• Average latency from the API gateway to services
• Whether reference grants are used for security

Multi-cluster deployment data

We collect the following data about multi-cluster deployments.

WAN federation

• Whether WAN federation is used
• Number of federated datacenters
• Number of each underlying runtime in the federated cluster, such as Kubernetes or VM
• Average latency between services in a federated cluster

Cluster peering

• Whether cluster peering is cluster
• Number of peered clusters
• Average number of exported services per peer
• Average latency between peers

Service mesh and L7 traffic data

We collect the following data about the service mesh and L7 traffic:

• Percent of registered services that use the service mesh
• Whether the service-router configuration entry is used
• Whether the service-resolver configuration entry is used
• Whether the service-splitter configuration entry is used
• Average number of requests in the mesh
• Average number of requests between datacenters in multi-cluster deployments
• Average latency between requests and responses in a datacenter
• Whether Consul DNS or KubeDNS is used
• Whether Kubernetes Services sync to Consul or the Consul catalog syncs to Kubernetes

Enterprise adoption data

We collect the following data about Consul Enterprise:

• Whether Admin partitions are used
• Number of admin partitions in the datacenter
• Nuimber of namespaces per admin partition
• Number of discoverable services in a partition, including exported services
• Whether namespaces are used
• Average number of services registered in a namespace
• Whether read replicas are used
• Average number of non-voting servers used
• Whether redundancy zones are used
• Whether automated upgrades are used
• Average completion time for an automated upgrade
• Frequency of upgrade failures
• Whether automated backups are used
• Whether Consul-Terraform-Sync (CTS) is used
• Which subsets of CTS features are used
• Whether network areas are used
• Whether network segments are used
• Whether an OIDC auth method is used
• Whether audit logging is used
• Whether Sentinel for KV is used

ACL data

We collect the following data about Consul ACLs:

• Whether the ACL system is enabled
• Whether the default policy is deny
• Number of auth methods in use by type
• Number of ACL tokens in the datacenter
• Number of ACL policies in the datacenter
• Whether the anonymous token has permissions
• Percentage of tokens with a finite TTL
• Number of tokens with with the acl:write permission
• Number of ACL roles in the datacenter
• Percentage of tokens that use built-in templates

Service-to-service authorization data

We collect the following data about service-to-service authorization in a datacenter:

• Number of service intentions in the datacenter
• Whether the default intention is deny
• Number of L7 service intentions in the datacenter
• Number of service intentions with JWT authorization in the datacenter
• Percentage of service instances the use the Envoy extension for external authorization
• Number of intentions with wildcard * allowed to access wildcard *
• Number of intentions with wildcard * allowed to access a defined service

Encryption data

We collect the following data about Consul's encryption features:

• Whether mTLS is enabled across the cluster
• Whether gossip traffic is encrypted
• Frequency of gossip key rotation
• Whether server agents verify the server hostname with each request
• Whether server agents verify incoming RPC traffic
• Percentage of client agents that verify the server hostname with each request
• Percentage of client agents that verify outgoing RPC traffic