Chiebot-Mirror
/
grpc
mirror of https://github.com/grpc/grpc.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

[OTel] Add back server_selector that got deleted by a merge fiasco (#35532)

Browse Source 
It looks like this ended up getting deleted in https://github.com/grpc/grpc/pull/34350 probably when merging.

Also, the `Init` method in the otel test library is getting unwieldy. I'm going to send out a follow-up PR to convert this into a builder instead.

Closes #35532

COPYBARA_INTEGRATE_REVIEW=https://github.com/grpc/grpc/pull/35532 from yashykt:OTelPluginBuilderFix 372bf26338
PiperOrigin-RevId: 597846622
pull/35528/head
Yash Tibrewal 1 year ago committed by Copybara-Service
parent ddb26d6d3b
commit c5a8e5af64
6 changed files with 86 additions and 2 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      src/core/lib/channel/call_tracer.cc
  2. 3
      src/core/lib/channel/call_tracer.h
  3. 1
      src/cpp/ext/otel/otel_plugin.cc
  4. 68
      test/cpp/ext/otel/otel_plugin_test.cc
  5. 7
      test/cpp/ext/otel/otel_test_library.cc
  6. 4
      test/cpp/ext/otel/otel_test_library.h

5
src/core/lib/channel/call_tracer.cc
Unescape View File

@ -60,6 +60,11 @@ void ServerCallTracerFactory::RegisterGlobal(ServerCallTracerFactory* factory) {
g_server_call_tracer_factory_ = factory;
}
void ServerCallTracerFactory::TestOnlyReset() {
delete g_server_call_tracer_factory_;
g_server_call_tracer_factory_ = nullptr;
}
absl::string_view ServerCallTracerFactory::ChannelArgName() {
return kServerCallTracerFactoryChannelArgName;
}

3
src/core/lib/channel/call_tracer.h
Unescape View File

@ -201,6 +201,9 @@ class ServerCallTracerFactory {
// this for the lifetime of the process.
static void RegisterGlobal(ServerCallTracerFactory* factory);
// Deletes any previous registered ServerCallTracerFactory.
static void TestOnlyReset();
static absl::string_view ChannelArgName();
};

1
src/cpp/ext/otel/otel_plugin.cc
Unescape View File

@ -246,6 +246,7 @@ void OpenTelemetryPluginBuilderImpl::BuildAndRegisterGlobal() {
g_otel_plugin_state_->labels_injector = std::move(labels_injector_);
g_otel_plugin_state_->target_attribute_filter =
std::move(target_attribute_filter_);
g_otel_plugin_state_->server_selector = std::move(server_selector_);
g_otel_plugin_state_->generic_method_attribute_filter =
std::move(generic_method_attribute_filter_);
g_otel_plugin_state_->meter_provider = std::move(meter_provider);

68
test/cpp/ext/otel/otel_plugin_test.cc
Unescape View File

@ -358,6 +358,54 @@ TEST_F(OpenTelemetryPluginEnd2EndTest, TargetSelectorReturnsFalse) {
ASSERT_TRUE(data.empty());
}
// Test that a server selector returning true records metrics on the server.
TEST_F(OpenTelemetryPluginEnd2EndTest, ServerSelectorReturnsTrue) {
Init({grpc::OpenTelemetryPluginBuilder::
kServerCallDurationInstrumentName}, /*resource=*/
opentelemetry::sdk::resource::Resource::Create({}),
/*labels_injector=*/nullptr,
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
[](const grpc_core::ChannelArgs& /*channel_args*/) { return true; });
SendRPC();
const char* kMetricName = "grpc.server.call.duration";
auto data = ReadCurrentMetricsData(
[&](const absl::flat_hash_map<
std::string,
std::vector<opentelemetry::sdk::metrics::PointDataAttributes>>&
data) { return !data.contains(kMetricName); });
ASSERT_EQ(data[kMetricName].size(), 1);
const auto& server_attributes =
data[kMetricName][0].attributes.GetAttributes();
EXPECT_EQ(server_attributes.size(), 2);
EXPECT_EQ(absl::get<std::string>(server_attributes.at("grpc.method")),
kMethodName);
EXPECT_EQ(absl::get<std::string>(server_attributes.at("grpc.status")), "OK");
}
// Test that a server selector returning false does not record metrics on the
// server.
TEST_F(OpenTelemetryPluginEnd2EndTest, ServerSelectorReturnsFalse) {
Init({grpc::OpenTelemetryPluginBuilder::
kServerCallDurationInstrumentName}, /*resource=*/
opentelemetry::sdk::resource::Resource::Create({}),
/*labels_injector=*/nullptr,
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
[](const grpc_core::ChannelArgs& /*channel_args*/) { return false; });
SendRPC();
auto data = ReadCurrentMetricsData(
[&](const absl::flat_hash_map<
std::string,
std::vector<opentelemetry::sdk::metrics::PointDataAttributes>>&
/*data*/) { return false; });
ASSERT_TRUE(data.empty());
}
// Test that a target attribute filter returning true records metrics with the
// target as is on the channel.
TEST_F(OpenTelemetryPluginEnd2EndTest, TargetAttributeFilterReturnsTrue) {
@ -368,6 +416,8 @@ TEST_F(OpenTelemetryPluginEnd2EndTest, TargetAttributeFilterReturnsTrue) {
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/[](absl::string_view /*target*/) {
return true;
});
@ -407,6 +457,8 @@ TEST_F(OpenTelemetryPluginEnd2EndTest, TargetAttributeFilterReturnsFalse) {
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
[server_address = canonical_server_address_](
absl::string_view /*target*/) { return false; });
@ -475,6 +527,8 @@ TEST_F(OpenTelemetryPluginEnd2EndTest,
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/
@ -515,6 +569,8 @@ TEST_F(OpenTelemetryPluginEnd2EndTest,
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/
@ -583,6 +639,8 @@ TEST_F(OpenTelemetryPluginEnd2EndTest,
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/
@ -622,6 +680,8 @@ TEST_F(OpenTelemetryPluginEnd2EndTest,
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/
@ -757,6 +817,8 @@ TEST_F(OpenTelemetryPluginOptionEnd2EndTest, Basic) {
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/
@ -799,6 +861,8 @@ TEST_F(OpenTelemetryPluginOptionEnd2EndTest, ClientOnlyPluginOption) {
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/
@ -842,6 +906,8 @@ TEST_F(OpenTelemetryPluginOptionEnd2EndTest, ServerOnlyPluginOption) {
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/
@ -899,6 +965,8 @@ TEST_F(OpenTelemetryPluginOptionEnd2EndTest,
/*test_no_meter_provider=*/false,
/*labels_to_inject=*/{},
/*target_selector=*/absl::AnyInvocable<bool(absl::string_view) const>(),
/*server_selector=*/
absl::AnyInvocable<bool(const grpc_core::ChannelArgs&) const>(),
/*target_attribute_filter=*/
absl::AnyInvocable<bool(absl::string_view) const>(),
/*generic_method_attribute_filter=*/

7
test/cpp/ext/otel/otel_test_library.cc
Unescape View File

@ -90,6 +90,9 @@ void OpenTelemetryPluginEnd2EndTest::Init(
const std::map<std::string, std::string>& labels_to_inject,
absl::AnyInvocable<bool(absl::string_view /*target*/) const>
target_selector,
absl::AnyInvocable<bool(const grpc_core::ChannelArgs& /*channel_args*/)
const>
server_selector,
absl::AnyInvocable<bool(absl::string_view /*target*/) const>
target_attribute_filter,
absl::AnyInvocable<bool(absl::string_view /*generic_method*/) const>
@ -121,6 +124,7 @@ void OpenTelemetryPluginEnd2EndTest::Init(
}
ot_builder.SetLabelsInjector(std::move(labels_injector));
ot_builder.SetTargetSelector(std::move(target_selector));
ot_builder.SetServerSelector(std::move(server_selector));
ot_builder.SetTargetAttributeFilter(std::move(target_attribute_filter));
ot_builder.SetGenericMethodAttributeFilter(
std::move(generic_method_attribute_filter));
@ -160,8 +164,7 @@ void OpenTelemetryPluginEnd2EndTest::Init(
void OpenTelemetryPluginEnd2EndTest::TearDown() {
server_->Shutdown();
grpc_shutdown_blocking();
delete grpc_core::ServerCallTracerFactory::Get(grpc_core::ChannelArgs());
grpc_core::ServerCallTracerFactory::RegisterGlobal(nullptr);
grpc_core::ServerCallTracerFactory::TestOnlyReset();
}
void OpenTelemetryPluginEnd2EndTest::ResetStub(

4
test/cpp/ext/otel/otel_test_library.h
Unescape View File

@ -66,6 +66,10 @@ class OpenTelemetryPluginEnd2EndTest : public ::testing::Test {
const std::map<std::string, std::string>& labels_to_inject = {},
absl::AnyInvocable<bool(absl::string_view /*target*/) const>
target_selector = absl::AnyInvocable<bool(absl::string_view) const>(),
absl::AnyInvocable<bool(const grpc_core::ChannelArgs& /*channel_args*/)
const>
server_selector = absl::AnyInvocable<
bool(const grpc_core::ChannelArgs& /*channel_args*/) const>(),
absl::AnyInvocable<bool(absl::string_view /*target*/) const>
target_attribute_filter =
absl::AnyInvocable<bool(absl::string_view) const>(),

Write Preview
Loading…
Cancel
Save