diff --git a/envoy/admin/v3/clusters.proto b/envoy/admin/v3/clusters.proto index 7a5e83c9..b526fa31 100644 --- a/envoy/admin/v3/clusters.proto +++ b/envoy/admin/v3/clusters.proto @@ -29,7 +29,7 @@ message Clusters { } // Details an individual cluster's current status. -// [#next-free-field: 7] +// [#next-free-field: 8] message ClusterStatus { option (udpa.annotations.versioning).previous_message_type = "envoy.admin.v2alpha.ClusterStatus"; @@ -80,6 +80,9 @@ message ClusterStatus { // :ref:`Circuit breaking ` settings of the cluster. config.cluster.v3.CircuitBreakers circuit_breakers = 6; + + // Observability name of the cluster. + string observability_name = 7; } // Current state of a particular host. diff --git a/envoy/admin/v4alpha/clusters.proto b/envoy/admin/v4alpha/clusters.proto index cc452557..116dc226 100644 --- a/envoy/admin/v4alpha/clusters.proto +++ b/envoy/admin/v4alpha/clusters.proto @@ -29,7 +29,7 @@ message Clusters { } // Details an individual cluster's current status. -// [#next-free-field: 7] +// [#next-free-field: 8] message ClusterStatus { option (udpa.annotations.versioning).previous_message_type = "envoy.admin.v3.ClusterStatus"; @@ -80,6 +80,9 @@ message ClusterStatus { // :ref:`Circuit breaking ` settings of the cluster. config.cluster.v4alpha.CircuitBreakers circuit_breakers = 6; + + // Observability name of the cluster. + string observability_name = 7; } // Current state of a particular host. diff --git a/envoy/config/cluster/v3/cluster.proto b/envoy/config/cluster/v3/cluster.proto index 6b89257c..efc08ae0 100644 --- a/envoy/config/cluster/v3/cluster.proto +++ b/envoy/config/cluster/v3/cluster.proto @@ -21,6 +21,7 @@ import "google/protobuf/wrappers.proto"; import "xds/core/v3/collection_entry.proto"; +import "udpa/annotations/migrate.proto"; import "udpa/annotations/security.proto"; import "udpa/annotations/status.proto"; import "udpa/annotations/versioning.proto"; @@ -683,11 +684,16 @@ message Cluster { // Any ``:`` in the cluster name will be converted to ``_`` when emitting statistics. string name = 1 [(validate.rules).string = {min_len: 1}]; - // An optional alternative to the cluster name to be used while emitting stats. - // Any ``:`` in the name will be converted to ``_`` when emitting statistics. This should not be - // confused with :ref:`Router Filter Header - // `. - string alt_stat_name = 28; + // An optional alternative to the cluster name to be used for observability. This name is used + // emitting stats for the cluster and access logging the cluster name. This will appear as + // additional information in configuration dumps of a cluster's current status as + // :ref:`observability_name ` + // and as an additional tag "upstream_cluster.name" while tracing. Note: access logging using + // this field is presently enabled with runtime feature + // `envoy.reloadable_features.use_observable_cluster_name`. Any ``:`` in the name will be + // converted to ``_`` when emitting statistics. This should not be confused with :ref:`Router + // Filter Header `. + string alt_stat_name = 28 [(udpa.annotations.field_migrate).rename = "observability_name"]; oneof cluster_discovery_type { // The :ref:`service discovery type ` diff --git a/envoy/config/cluster/v4alpha/cluster.proto b/envoy/config/cluster/v4alpha/cluster.proto index 062123fc..927bbdda 100644 --- a/envoy/config/cluster/v4alpha/cluster.proto +++ b/envoy/config/cluster/v4alpha/cluster.proto @@ -694,11 +694,16 @@ message Cluster { // Any ``:`` in the cluster name will be converted to ``_`` when emitting statistics. string name = 1 [(validate.rules).string = {min_len: 1}]; - // An optional alternative to the cluster name to be used while emitting stats. - // Any ``:`` in the name will be converted to ``_`` when emitting statistics. This should not be - // confused with :ref:`Router Filter Header - // `. - string alt_stat_name = 28; + // An optional alternative to the cluster name to be used for observability. This name is used + // emitting stats for the cluster and access logging the cluster name. This will appear as + // additional information in configuration dumps of a cluster's current status as + // :ref:`observability_name ` + // and as an additional tag "upstream_cluster.name" while tracing. Note: access logging using + // this field is presently enabled with runtime feature + // `envoy.reloadable_features.use_observable_cluster_name`. Any ``:`` in the name will be + // converted to ``_`` when emitting statistics. This should not be confused with :ref:`Router + // Filter Header `. + string observability_name = 28; oneof cluster_discovery_type { // The :ref:`service discovery type `