Skip to content

feat(otel): copy service labels into GCM Metric #14930

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
dbolduc merged 2 commits into from
Jan 13, 2025
Merged

feat(otel): copy service labels into GCM Metric #14930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
038422c
feat(otel): copy service labels into GCM Metric
dbolduc Jan 10, 2025
0e0eac5
fix test on oldepst deps
dbolduc Jan 13, 2025
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
45 changes: 35 additions & 10 deletions google/cloud/opentelemetry/internal/time_series.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include <opentelemetry/common/attribute_value.h>
#include <opentelemetry/sdk/metrics/data/metric_data.h>
#include <opentelemetry/sdk/metrics/export/metric_producer.h>
#include <opentelemetry/sdk/resource/semantic_conventions.h>
#include <cctype>

namespace google {
Expand All @@ -28,6 +29,8 @@ namespace otel_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
namespace {

namespace sc = opentelemetry::sdk::resource::SemanticConventions;

google::protobuf::Timestamp ToProtoTimestamp(
opentelemetry::common::SystemTimestamp ts) {
return internal::ToProtoTimestamp(
Expand Down Expand Up @@ -69,25 +72,46 @@ double AsDouble(opentelemetry::sdk::metrics::ValueType const& v) {
google::api::Metric ToMetric(
opentelemetry::sdk::metrics::MetricData const& metric_data,
opentelemetry::sdk::metrics::PointAttributes const& attributes,
opentelemetry::sdk::resource::Resource const* resource,
std::function<std::string(std::string)> const& name_formatter) {
google::api::Metric proto;
proto.set_type(name_formatter(metric_data.instrument_descriptor.name_));

auto& labels = *proto.mutable_labels();
for (auto const& kv : attributes) {
auto key = kv.first;
auto add_label = [](auto& labels, auto key, auto const& value) {
// GCM labels match on the regex: R"([a-zA-Z_][a-zA-Z0-9_]*)".
if (key.empty()) continue;
if (key.empty()) return;
if (!std::isalpha(key[0]) && key[0] != '_') {
GCP_LOG(INFO) << "Dropping metric label which does not start with "
"[A-Za-z_]: "
<< key;
continue;
return;
}
for (auto& c : key) {
if (!std::isalnum(c)) c = '_';
}
labels[std::move(key)] = AsString(kv.second);
labels[std::move(key)] = AsString(value);
};

google::api::Metric proto;
proto.set_type(name_formatter(metric_data.instrument_descriptor.name_));

auto& labels = *proto.mutable_labels();
if (resource) {
// Copy several well-known labels from the resource into the metric, if they
// exist.
//
// This avoids duplicate timeseries when multiple instances of a service are
// running on a single monitored resource, for example running multiple
// service processes on a single GCE VM.
auto const& ra = resource->GetAttributes().GetAttributes();
for (std::string key : {
sc::kServiceName,
sc::kServiceNamespace,
sc::kServiceInstanceId,
}) {
auto it = ra.find(std::move(key));
if (it != ra.end()) add_label(labels, it->first, it->second);
}
}
for (auto const& kv : attributes) {
add_label(labels, kv.first, kv.second);
}
return proto;
}
Expand Down Expand Up @@ -210,7 +234,8 @@ std::vector<google::monitoring::v3::TimeSeries> ToTimeSeries(
if (!ts) continue;
ts->set_unit(metric_data.instrument_descriptor.unit_);
*ts->mutable_metric() =
ToMetric(metric_data, pda.attributes, metrics_name_formatter);
ToMetric(metric_data, pda.attributes, data.resource_,
metrics_name_formatter);
tss.push_back(*std::move(ts));
}
}
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/opentelemetry/internal/time_series.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
#include <google/api/monitored_resource.pb.h>
#include <google/monitoring/v3/metric_service.pb.h>
#include <opentelemetry/sdk/metrics/metric_reader.h>
#include <opentelemetry/sdk/resource/resource.h>
#include <functional>
#include <string>

Expand All @@ -37,6 +38,7 @@ auto constexpr kMaxTimeSeriesPerRequest = 200;
google::api::Metric ToMetric(
opentelemetry::sdk::metrics::MetricData const& metric_data,
opentelemetry::sdk::metrics::PointAttributes const& attributes,
opentelemetry::sdk::resource::Resource const* resource,
std::function<std::string(std::string)> const& metrics_name_formatter);

google::monitoring::v3::TimeSeries ToTimeSeries(
Expand Down
61 changes: 57 additions & 4 deletions google/cloud/opentelemetry/internal/time_series_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ namespace otel_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
namespace {

namespace sc = opentelemetry::sdk::resource::SemanticConventions;

using ::google::cloud::testing_util::IsProtoEqual;
using ::google::protobuf::TextFormat;
using ::testing::_;
Expand Down Expand Up @@ -133,7 +135,6 @@ auto Interval(std::chrono::system_clock::time_point start,
}

auto TestResource() {
namespace sc = opentelemetry::sdk::resource::SemanticConventions;
return opentelemetry::sdk::resource::Resource::Create({
{sc::kCloudProvider, "gcp"},
{sc::kCloudPlatform, "gcp_compute_engine"},
Expand Down Expand Up @@ -247,13 +248,13 @@ TEST(ToMetric, Simple) {
opentelemetry::sdk::metrics::PointAttributes attributes = {
{"key1", "value1"}, {"_key2", "value2"}};

auto metric = ToMetric(md, attributes, PrefixWithWorkload);
auto metric = ToMetric(md, attributes, {}, PrefixWithWorkload);

EXPECT_EQ(metric.type(), "workload.googleapis.com/test");
EXPECT_THAT(metric.labels(), UnorderedElementsAre(Pair("key1", "value1"),
Pair("_key2", "value2")));

metric = ToMetric(md, {}, [](std::string s) {
metric = ToMetric(md, {}, {}, [](std::string s) {
std::replace(s.begin(), s.end(), 't', 'T');
return "custom.googleapis.com/" + std::move(s);
});
Expand All @@ -266,7 +267,7 @@ TEST(ToMetric, BadLabelNames) {
opentelemetry::sdk::metrics::PointAttributes attributes = {
{"99", "dropped"}, {"a key-with.bad/characters", "value"}};

auto metric = ToMetric({}, attributes, PrefixWithWorkload);
auto metric = ToMetric({}, attributes, {}, PrefixWithWorkload);

EXPECT_THAT(metric.labels(),
UnorderedElementsAre(Pair("a_key_with_bad_characters", "value")));
Expand All @@ -276,6 +277,53 @@ TEST(ToMetric, BadLabelNames) {
Contains(AllOf(HasSubstr("Dropping metric label"), HasSubstr("99"))));
}

TEST(ToMetric, IncludesServiceLabelsFromResource) {
opentelemetry::sdk::metrics::MetricData md;
md.instrument_descriptor.name_ = "test";

opentelemetry::sdk::resource::ResourceAttributes resource_attributes = {
{"unused", "unused"},
{sc::kServiceName, "test-name"},
{sc::kServiceNamespace, "test-namespace"},
{sc::kServiceInstanceId, "test-instance"},
};
auto resource =
opentelemetry::sdk::resource::Resource::Create(resource_attributes);

auto metric = ToMetric(md, {}, &resource, PrefixWithWorkload);
EXPECT_THAT(
metric.labels(),
UnorderedElementsAre(Pair("service_name", "test-name"),
Pair("service_namespace", "test-namespace"),
Pair("service_instance_id", "test-instance")));
}

TEST(ToMetric, PointAttributesOverServiceResourceAttributes) {
opentelemetry::sdk::metrics::MetricData md;
md.instrument_descriptor.name_ = "test";

opentelemetry::sdk::metrics::PointAttributes point_attributes = {
{"service_name", "point-name"},
{"service_namespace", "point-namespace"},
{"service_instance_id", "point-instance"},
};

opentelemetry::sdk::resource::ResourceAttributes resource_attributes = {
{sc::kServiceName, "resource-name"},
{sc::kServiceNamespace, "resource-namespace"},
{sc::kServiceInstanceId, "resource-instance"},
};
auto resource =
opentelemetry::sdk::resource::Resource::Create(resource_attributes);

auto metric = ToMetric(md, point_attributes, &resource, PrefixWithWorkload);
EXPECT_THAT(
metric.labels(),
UnorderedElementsAre(Pair("service_name", "point-name"),
Pair("service_namespace", "point-namespace"),
Pair("service_instance_id", "point-instance")));
}

TEST(SumPointData, Simple) {
auto const start = std::chrono::system_clock::now();
auto const end = start + std::chrono::seconds(5);
Expand Down Expand Up @@ -532,6 +580,7 @@ TEST(ToTimeSeries, Sum) {

opentelemetry::sdk::metrics::ResourceMetrics rm;
rm.scope_metric_data_.push_back(std::move(sm));
rm.resource_ = nullptr;

auto tss = ToTimeSeries(rm, PrefixWithWorkload);
EXPECT_THAT(tss, ElementsAre(SumTimeSeries(), SumTimeSeries()));
Expand All @@ -556,6 +605,7 @@ TEST(ToTimeSeries, Gauge) {

opentelemetry::sdk::metrics::ResourceMetrics rm;
rm.scope_metric_data_.push_back(std::move(sm));
rm.resource_ = nullptr;

auto tss = ToTimeSeries(rm, PrefixWithWorkload);
EXPECT_THAT(tss, ElementsAre(GaugeTimeSeries(), GaugeTimeSeries()));
Expand All @@ -580,6 +630,7 @@ TEST(ToTimeSeries, Histogram) {

opentelemetry::sdk::metrics::ResourceMetrics rm;
rm.scope_metric_data_.push_back(std::move(sm));
rm.resource_ = nullptr;

auto tss = ToTimeSeries(rm, PrefixWithWorkload);
EXPECT_THAT(tss, ElementsAre(HistogramTimeSeries(), HistogramTimeSeries()));
Expand All @@ -604,6 +655,7 @@ TEST(ToTimeSeries, DropIgnored) {

opentelemetry::sdk::metrics::ResourceMetrics rm;
rm.scope_metric_data_.push_back(std::move(sm));
rm.resource_ = nullptr;

auto tss = ToTimeSeries(rm, PrefixWithWorkload);
EXPECT_THAT(tss, IsEmpty());
Expand Down Expand Up @@ -634,6 +686,7 @@ TEST(ToTimeSeries, Combined) {

opentelemetry::sdk::metrics::ResourceMetrics rm;
rm.scope_metric_data_.push_back(std::move(sm));
rm.resource_ = nullptr;

auto tss = ToTimeSeries(
rm, [](std::string const& s) { return "custom.googleapis.com/" + s; });
Expand Down
Loading