Skip to content

[release-1.29] Ambient Multicluster Telemetry #6799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
istio-testing merged 1 commit into from
Jan 28, 2026
Merged

[release-1.29] Ambient Multicluster Telemetry #6799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ ISTIO_EXTENSIONS = [
"//source/extensions/filters/http/istio_stats",
"//source/extensions/filters/http/peer_metadata:filter_lib",
"//source/extensions/filters/network/metadata_exchange:config_lib",
"//source/extensions/filters/network/peer_metadata",
]

envoy_cc_binary(
Expand Down
1 change: 1 addition & 0 deletions extensions/common/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ envoy_cc_library(
"@com_google_absl//absl/strings",
"@com_google_absl//absl/types:optional",
"@envoy//envoy/common:hashable_interface",
"@envoy//envoy/local_info:local_info_interface",
"@envoy//envoy/registry",
"@envoy//envoy/stream_info:filter_state_interface",
"@envoy//source/common/common:hash_lib",
Expand Down
156 changes: 139 additions & 17 deletions extensions/common/metadata_object.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

#include "extensions/common/metadata_object.h"

#include "envoy/config/core/v3/base.pb.h"
#include "envoy/registry/registry.h"
#include "source/common/common/hash.h"
#include "source/common/protobuf/utility.h"
Expand All @@ -24,7 +25,10 @@ namespace Istio {
namespace Common {

namespace {
static absl::flat_hash_map<absl::string_view, BaggageToken> ALL_BAGGAGE_TOKENS = {

// This maps field names into baggage tokens. We use it to decode field names
// when WorkloadMetadataObject content is accessed through the Envoy API.
static absl::flat_hash_map<absl::string_view, BaggageToken> ALL_METADATA_FIELDS = {
{NamespaceNameToken, BaggageToken::NamespaceName},
{ClusterNameToken, BaggageToken::ClusterName},
{ServiceNameToken, BaggageToken::ServiceName},
Expand All @@ -34,6 +38,25 @@ static absl::flat_hash_map<absl::string_view, BaggageToken> ALL_BAGGAGE_TOKENS =
{WorkloadNameToken, BaggageToken::WorkloadName},
{WorkloadTypeToken, BaggageToken::WorkloadType},
{InstanceNameToken, BaggageToken::InstanceName},
{RegionToken, BaggageToken::LocalityRegion},
{ZoneToken, BaggageToken::LocalityZone},
};

// This maps baggage keys into baggage tokens. We use it to decode baggage keys
// coming over the wire when building WorkloadMetadataObject.
static absl::flat_hash_map<absl::string_view, BaggageToken> ALL_BAGGAGE_TOKENS = {
{NamespaceNameBaggageToken, BaggageToken::NamespaceName},
{ClusterNameBaggageToken, BaggageToken::ClusterName},
{ServiceNameBaggageToken, BaggageToken::ServiceName},
{ServiceVersionBaggageToken, BaggageToken::ServiceVersion},
{AppNameBaggageToken, BaggageToken::AppName},
{AppVersionBaggageToken, BaggageToken::AppVersion},
{DeploymentNameBaggageToken, BaggageToken::WorkloadName},
{PodNameBaggageToken, BaggageToken::WorkloadName},
{CronjobNameBaggageToken, BaggageToken::WorkloadName},
{JobNameBaggageToken, BaggageToken::WorkloadName},
{InstanceNameBaggageToken, BaggageToken::InstanceName},

};

static absl::flat_hash_map<absl::string_view, WorkloadType> ALL_WORKLOAD_TOKENS = {
Expand Down Expand Up @@ -61,6 +84,36 @@ absl::optional<absl::string_view> toSuffix(WorkloadType workload_type) {

} // namespace

std::string WorkloadMetadataObject::baggage() const {
const auto workload_type = toSuffix(workload_type_).value_or(PodSuffix);
std::vector<std::string> parts;
if (!workload_name_.empty()) {
parts.push_back("k8s." + std::string(workload_type) + ".name=" + std::string(workload_name_));
}
// Map the workload metadata fields to baggage tokens
const std::vector<std::pair<absl::string_view, absl::string_view>> field_to_baggage = {
{Istio::Common::NamespaceNameToken, Istio::Common::NamespaceNameBaggageToken},
{Istio::Common::ClusterNameToken, Istio::Common::ClusterNameBaggageToken},
{Istio::Common::ServiceNameToken, Istio::Common::ServiceNameBaggageToken},
{Istio::Common::ServiceVersionToken, Istio::Common::ServiceVersionBaggageToken},
{Istio::Common::AppNameToken, Istio::Common::AppNameBaggageToken},
{Istio::Common::AppVersionToken, Istio::Common::AppVersionBaggageToken},
{Istio::Common::InstanceNameToken, Istio::Common::InstanceNameBaggageToken},
{Istio::Common::RegionToken, Istio::Common::LocalityRegionBaggageToken},
{Istio::Common::ZoneToken, Istio::Common::LocalityZoneBaggageToken},
};

for (const auto& [field_name, baggage_key] : field_to_baggage) {
const auto field_result = getField(field_name);
if (auto field_value = std::get_if<absl::string_view>(&field_result)) {
if (!field_value->empty()) {
parts.push_back(absl::StrCat(baggage_key, "=", *field_value));
}
}
}
return absl::StrJoin(parts, ",");
}

Envoy::ProtobufTypes::MessagePtr WorkloadMetadataObject::serializeAsProto() const {
auto message = std::make_unique<Envoy::Protobuf::Struct>();
const auto suffix = toSuffix(workload_type_);
Expand Down Expand Up @@ -94,6 +147,12 @@ Envoy::ProtobufTypes::MessagePtr WorkloadMetadataObject::serializeAsProto() cons
if (!identity_.empty()) {
(*message->mutable_fields())[IdentityToken].set_string_value(identity_);
}
if (!locality_region_.empty()) {
(*message->mutable_fields())[RegionToken].set_string_value(locality_region_);
}
if (!locality_zone_.empty()) {
(*message->mutable_fields())[ZoneToken].set_string_value(locality_zone_);
}

if (!labels_.empty()) {
auto* labels = (*message->mutable_fields())[LabelsToken].mutable_struct_value();
Expand Down Expand Up @@ -136,6 +195,12 @@ WorkloadMetadataObject::serializeAsPairs() const {
if (!app_version_.empty()) {
parts.push_back({AppVersionToken, app_version_});
}
if (!locality_region_.empty()) {
parts.push_back({RegionToken, locality_region_});
}
if (!locality_zone_.empty()) {
parts.push_back({ZoneToken, locality_zone_});
}
if (!labels_.empty()) {
for (const auto& l : labels_) {
parts.push_back({absl::StrCat("labels[]", l.first), absl::string_view(l.second)});
Expand All @@ -161,6 +226,8 @@ absl::optional<std::string> WorkloadMetadataObject::owner() const {
return {};
}

std::string WorkloadMetadataObject::identity() const { return identity_; }

WorkloadType fromSuffix(absl::string_view suffix) {
const auto it = ALL_WORKLOAD_TOKENS.find(suffix);
if (it != ALL_WORKLOAD_TOKENS.end()) {
Expand Down Expand Up @@ -195,6 +262,9 @@ google::protobuf::Struct convertWorkloadMetadataToStruct(const WorkloadMetadataO
if (!obj.cluster_name_.empty()) {
(*metadata.mutable_fields())[ClusterMetadataField].set_string_value(obj.cluster_name_);
}
if (!obj.identity_.empty()) {
(*metadata.mutable_fields())[IdentityMetadataField].set_string_value(obj.identity_);
}
auto* labels = (*metadata.mutable_fields())[LabelsMetadataField].mutable_struct_value();
if (!obj.canonical_name_.empty()) {
(*labels->mutable_fields())[CanonicalNameLabel].set_string_value(obj.canonical_name_);
Expand All @@ -216,6 +286,12 @@ google::protobuf::Struct convertWorkloadMetadataToStruct(const WorkloadMetadataO
if (const auto owner = obj.owner(); owner.has_value()) {
(*metadata.mutable_fields())[OwnerMetadataField].set_string_value(*owner);
}
if (!obj.locality_region_.empty()) {
(*metadata.mutable_fields())[RegionMetadataField].set_string_value(obj.locality_region_);
}
if (!obj.locality_zone_.empty()) {
(*metadata.mutable_fields())[ZoneMetadataField].set_string_value(obj.locality_zone_);
}
return metadata;
}

Expand All @@ -228,8 +304,15 @@ convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata) {
std::unique_ptr<WorkloadMetadataObject>
convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata,
const absl::flat_hash_set<std::string>& additional_labels) {
absl::string_view instance, namespace_name, owner, workload, cluster, canonical_name,
canonical_revision, app_name, app_version;
return convertStructToWorkloadMetadata(metadata, additional_labels, {});
}

std::unique_ptr<WorkloadMetadataObject>
convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata,
const absl::flat_hash_set<std::string>& additional_labels,
const absl::optional<envoy::config::core::v3::Locality> locality) {
absl::string_view instance, namespace_name, owner, workload, cluster, identity, canonical_name,
canonical_revision, app_name, app_version, region, zone;
std::vector<std::pair<std::string, std::string>> labels;
for (const auto& it : metadata.fields()) {
if (it.first == InstanceMetadataField) {
Expand All @@ -242,6 +325,8 @@ convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata,
workload = it.second.string_value();
} else if (it.first == ClusterMetadataField) {
cluster = it.second.string_value();
} else if (it.first == IdentityMetadataField) {
identity = it.second.string_value();
} else if (it.first == LabelsMetadataField) {
for (const auto& labels_it : it.second.struct_value().fields()) {
if (labels_it.first == CanonicalNameLabel) {
Expand All @@ -260,9 +345,19 @@ convertStructToWorkloadMetadata(const google::protobuf::Struct& metadata,
}
}
}
auto obj = std::make_unique<WorkloadMetadataObject>(instance, cluster, namespace_name, workload,
canonical_name, canonical_revision, app_name,
app_version, parseOwner(owner, workload), "");
std::string locality_region = std::string(region);
std::string locality_zone = std::string(zone);
if (locality.has_value()) {
if (!locality->region().empty() && locality_region.empty()) {
locality_region = locality->region();
}
if (!locality->zone().empty() && locality_zone.empty()) {
locality_zone = locality->zone();
}
}
auto obj = std::make_unique<WorkloadMetadataObject>(
instance, cluster, namespace_name, workload, canonical_name, canonical_revision, app_name,
app_version, parseOwner(owner, workload), identity, locality_region, locality_zone);
obj->setLabels(labels);
return obj;
}
Expand All @@ -274,7 +369,8 @@ convertEndpointMetadata(const std::string& endpoint_encoding) {
return {};
}
return absl::make_optional<WorkloadMetadataObject>("", parts[4], parts[1], parts[0], parts[2],
parts[3], "", "", WorkloadType::Unknown, "");
parts[3], "", "", WorkloadType::Unknown, "",
"", "");
}

std::string serializeToStringDeterministic(const google::protobuf::Struct& metadata) {
Expand All @@ -292,8 +388,8 @@ std::string serializeToStringDeterministic(const google::protobuf::Struct& metad

WorkloadMetadataObject::FieldType
WorkloadMetadataObject::getField(absl::string_view field_name) const {
const auto it = ALL_BAGGAGE_TOKENS.find(field_name);
if (it != ALL_BAGGAGE_TOKENS.end()) {
const auto it = ALL_METADATA_FIELDS.find(field_name);
if (it != ALL_METADATA_FIELDS.end()) {
switch (it->second) {
case BaggageToken::NamespaceName:
return namespace_name_;
Expand All @@ -316,12 +412,22 @@ WorkloadMetadataObject::getField(absl::string_view field_name) const {
return "unknown";
case BaggageToken::InstanceName:
return instance_name_;
case BaggageToken::LocalityRegion:
return locality_region_;
case BaggageToken::LocalityZone:
return locality_zone_;
}
}
return {};
}

std::unique_ptr<WorkloadMetadataObject> convertBaggageToWorkloadMetadata(absl::string_view data) {
std::unique_ptr<WorkloadMetadataObject>
convertBaggageToWorkloadMetadata(absl::string_view baggage) {
return convertBaggageToWorkloadMetadata(baggage, "");
}

std::unique_ptr<WorkloadMetadataObject>
convertBaggageToWorkloadMetadata(absl::string_view data, absl::string_view identity) {
absl::string_view instance;
absl::string_view cluster;
absl::string_view workload;
Expand All @@ -330,6 +436,8 @@ std::unique_ptr<WorkloadMetadataObject> convertBaggageToWorkloadMetadata(absl::s
absl::string_view canonical_revision;
absl::string_view app_name;
absl::string_view app_version;
absl::string_view region;
absl::string_view zone;
WorkloadType workload_type = WorkloadType::Unknown;
std::vector<absl::string_view> properties = absl::StrSplit(data, ',');
for (absl::string_view property : properties) {
Expand All @@ -344,32 +452,46 @@ std::unique_ptr<WorkloadMetadataObject> convertBaggageToWorkloadMetadata(absl::s
cluster = parts.second;
break;
case BaggageToken::ServiceName:
// canonical name and app name are always the same
canonical_name = parts.second;
app_name = parts.second;
break;
case BaggageToken::ServiceVersion:
// canonical revision and app version are always the same
canonical_revision = parts.second;
app_version = parts.second;
break;
case BaggageToken::AppName:
app_name = parts.second;
break;
case BaggageToken::AppVersion:
app_version = parts.second;
break;
case BaggageToken::WorkloadName:
case BaggageToken::WorkloadName: {
workload = parts.second;
std::vector<absl::string_view> splitWorkloadKey = absl::StrSplit(parts.first, ".");
if (splitWorkloadKey.size() >= 2 && splitWorkloadKey[0] == "k8s") {
workload_type = fromSuffix(splitWorkloadKey[1]);
}
break;
case BaggageToken::WorkloadType:
workload_type = fromSuffix(parts.second);
break;
}
case BaggageToken::InstanceName:
instance = parts.second;
break;
case BaggageToken::LocalityRegion:
region = parts.second;
break;
case BaggageToken::LocalityZone:
zone = parts.second;
break;
default:
break;
}
}
}
return std::make_unique<WorkloadMetadataObject>(instance, cluster, namespace_name, workload,
canonical_name, canonical_revision, app_name,
app_version, workload_type, "");
return std::make_unique<WorkloadMetadataObject>(
instance, cluster, namespace_name, workload, canonical_name, canonical_revision, app_name,
app_version, workload_type, identity, region, zone);
}

} // namespace Common
Expand Down
Loading