Skip to content

fix(otel): Exporter creating Monitored Resource with task_id for Cloud Run #14923

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 16, 2025
Merged

fix(otel): Exporter creating Monitored Resource with task_id for Cloud Run #14923

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
579398c
fix(otel): Monitored Resource with task_id for Cloud Run
DouglasHeriot Jan 10, 2025
7f6e884
appease clang-tidy
dbolduc Jan 16, 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
13 changes: 7 additions & 6 deletions google/cloud/opentelemetry/internal/monitored_resource.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ struct AsStringVisitor {

struct OTelKeyMatch {
std::vector<std::string> otel_keys;
absl::optional<std::string> fallback = absl::nullopt;
// NOLINTNEXTLINE(readability-redundant-member-init)
std::string fallback = {};
};

class MonitoredResourceProvider {
Expand All @@ -72,8 +73,8 @@ class MonitoredResourceProvider {
[](auto const& key, auto const& attr) { return key == attr.first; });
if (found != oks.end()) {
mr.labels[kv.first] = AsString(attributes.at(*found));
} else if (kv.second.fallback) {
mr.labels[kv.first] = *kv.second.fallback;
} else {
mr.labels[kv.first] = kv.second.fallback;
}
}
return mr;
Expand Down Expand Up @@ -162,8 +163,8 @@ MonitoredResourceProvider GenericTask() {
{"location",
{{sc::kCloudAvailabilityZone, sc::kCloudRegion}, "global"}},
{"namespace", {{sc::kServiceNamespace}}},
{"job", {{sc::kServiceName}}},
{"task_id", {{sc::kServiceInstanceId}}},
{"job", {{sc::kServiceName, sc::kFaasName}}},
{"task_id", {{sc::kServiceInstanceId, sc::kFaasInstance}}},
});
}

Expand All @@ -174,7 +175,7 @@ MonitoredResourceProvider GenericNode() {
{"location",
{{sc::kCloudAvailabilityZone, sc::kCloudRegion}, "global"}},
{"namespace", {{sc::kServiceNamespace}}},
{"node_id", {{sc::kHostId}}},
{"node_id", {{sc::kHostId, sc::kHostName}}},
});
}

Expand Down
38 changes: 33 additions & 5 deletions google/cloud/opentelemetry/internal/monitored_resource_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,8 +283,11 @@ TEST(MonitoredResource, GenericTaskFaas) {

auto mr = ToMonitoredResource(attributes);
EXPECT_EQ(mr.type, "generic_task");
EXPECT_THAT(mr.labels,
UnorderedElementsAre(Pair("location", test.expected_location)));
EXPECT_THAT(mr.labels, UnorderedElementsAre(
Pair("location", test.expected_location),
// Verify fallback to empty string.
Pair("namespace", ""), Pair("job", "faas-name"),
Pair("task_id", "faas-instance")));
}
}

Expand Down Expand Up @@ -320,18 +323,18 @@ TEST(MonitoredResource, GenericTaskService) {
}

TEST(MonitoredResource, GenericNode) {
struct TestCase {
struct LocationTestCase {
absl::optional<std::string> zone;
absl::optional<std::string> region;
std::string expected_location;
};
auto tests = std::vector<TestCase>{
auto location_tests = std::vector<LocationTestCase>{
{"us-central1-a", "us-central1", "us-central1-a"},
{"us-central1-a", absl::nullopt, "us-central1-a"},
{absl::nullopt, "us-central1", "us-central1"},
{absl::nullopt, absl::nullopt, "global"},
};
for (auto const& test : tests) {
for (auto const& test : location_tests) {
auto attributes = opentelemetry::sdk::resource::ResourceAttributes{
{sc::kServiceNamespace, "test-namespace"},
{sc::kHostId, "test-instance"},
Expand All @@ -346,6 +349,31 @@ TEST(MonitoredResource, GenericNode) {
Pair("namespace", "test-namespace"),
Pair("node_id", "test-instance")));
}

struct NodeIDTestCase {
absl::optional<std::string> host_id;
std::string expected_node_id;
};
auto node_id_tests = std::vector<NodeIDTestCase>{
{"test-instance", "test-instance"},
{absl::nullopt, "test-name"},
};
for (auto const& test : node_id_tests) {
auto attributes = opentelemetry::sdk::resource::ResourceAttributes{
{sc::kCloudAvailabilityZone, "us-central1-a"},
{sc::kCloudRegion, "us-central1"},
{sc::kServiceNamespace, "test-namespace"},
{sc::kHostName, "test-name"},
};
if (test.host_id) attributes[sc::kHostId] = *test.host_id;

auto mr = ToMonitoredResource(attributes);
EXPECT_EQ(mr.type, "generic_node");
EXPECT_THAT(mr.labels,
UnorderedElementsAre(Pair("location", "us-central1-a"),
Pair("namespace", "test-namespace"),
Pair("node_id", test.expected_node_id)));
}
}

} // namespace
Expand Down
Loading