opentelemetrytracer: Dynatrace sampler: Use http_service in configura… (

envoyproxy#33034) * opentelemetrytracer: Dynatrace sampler: Use http_service in configuration. (#22) * change dynatrace sampler config to use http_service Signed-off-by: thomas.ebner <[email protected]> Signed-off-by: Thomas Ebner <[email protected]> Co-authored-by: Joao Grassi <[email protected]> * modify protobuf doc Signed-off-by: thomas.ebner <[email protected]> * remove empty line in proto file Signed-off-by: thomas.ebner <[email protected]> * added empty line in proto file Signed-off-by: thomas.ebner <[email protected]> * try to fix "Error in "code-block" directive" Signed-off-by: thomas.ebner <[email protected]> * fix "Error in "code-block" directive" Signed-off-by: thomas.ebner <[email protected]> * change proto documentation again Signed-off-by: thomas.ebner <[email protected]> * review feedback: keep unused values marked as deprecated. Add a new field. Signed-off-by: thomas.ebner <[email protected]> * Revert "review feedback: keep unused values marked as deprecated. Add a new" This reverts commit cec4b0f. Signed-off-by: thomas.ebner <[email protected]> --------- Signed-off-by: thomas.ebner <[email protected]> Signed-off-by: Thomas Ebner <[email protected]> Co-authored-by: Joao Grassi <[email protected]>
alyssawilk · Apr 29, 2024 · 9e68010 · 9e68010
1 parent 9341473
commit 9e68010
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 40 deletions.
diff --git a/api/envoy/extensions/tracers/opentelemetry/samplers/v3/dynatrace_sampler.proto b/api/envoy/extensions/tracers/opentelemetry/samplers/v3/dynatrace_sampler.proto
@@ -2,7 +2,7 @@ syntax = "proto3";
 
 package envoy.extensions.tracers.opentelemetry.samplers.v3;
 
-import "envoy/config/core/v3/http_uri.proto";
+import "envoy/config/core/v3/http_service.proto";
 
 import "udpa/annotations/status.proto";
 
@@ -13,10 +13,9 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/tra
 option (udpa.annotations.file_status).package_version_status = ACTIVE;
 
 // [#protodoc-title: Dynatrace Sampler config]
+
 // Configuration for the Dynatrace Sampler extension.
 // [#extension: envoy.tracers.opentelemetry.samplers.dynatrace]
-
-// [#next-free-field: 6]
 message DynatraceSamplerConfig {
   // The Dynatrace tenant.
   //
@@ -28,19 +27,21 @@ message DynatraceSamplerConfig {
   // The value can be obtained from the Envoy deployment page in Dynatrace.
   int32 cluster_id = 2;
 
-  // The HTTP URI to fetch the sampler configuration (root spans per minute). For example:
+  // The HTTP service to fetch the sampler configuration from the Dynatrace API (root spans per minute). For example:
   //
   // .. code-block:: yaml
   //
-  //    http_uri:
-  //      uri: <tenant>.dev.dynatracelabs.com/api/v2/samplingConfiguration
-  //      cluster: dynatrace
-  //      timeout: 10s
+  //    http_service:
+  //      http_uri:
+  //        cluster: dynatrace
+  //        uri: <tenant>.dev.dynatracelabs.com/api/v2/samplingConfiguration
+  //        timeout: 10s
+  //      request_headers_to_add:
+  //      - header:
+  //          key : "authorization"
+  //          value: "Api-Token dt..."
   //
-  config.core.v3.HttpUri http_uri = 3;
-
-  // The access token to fetch the sampling configuration from the Dynatrace API
-  string token = 4;
+  config.core.v3.HttpService http_service = 3;
 
   // Default number of root spans per minute, used when the value can't be obtained from the Dynatrace API.
   //
@@ -49,5 +50,5 @@ message DynatraceSamplerConfig {
   // - ``root_spans_per_minute`` is unset
   // - ``root_spans_per_minute`` is set to 0
   //
-  uint32 root_spans_per_minute = 5;
+  uint32 root_spans_per_minute = 4;
 }
diff --git a/source/extensions/tracers/opentelemetry/samplers/dynatrace/BUILD b/source/extensions/tracers/opentelemetry/samplers/dynatrace/BUILD
@@ -41,6 +41,7 @@ envoy_cc_library(
         "//source/common/config:datasource_lib",
         "//source/extensions/tracers/opentelemetry:opentelemetry_tracer_lib",
         "//source/extensions/tracers/opentelemetry/samplers:sampler_lib",
+        "@envoy_api//envoy/config/core/v3:pkg_cc_proto",
         "@envoy_api//envoy/extensions/tracers/opentelemetry/samplers/v3:pkg_cc_proto",
     ],
 )
diff --git a/source/extensions/tracers/opentelemetry/samplers/dynatrace/sampler_config_provider.cc b/source/extensions/tracers/opentelemetry/samplers/dynatrace/sampler_config_provider.cc
@@ -35,9 +35,12 @@ SamplerConfigProviderImpl::SamplerConfigProviderImpl(
     Server::Configuration::TracerFactoryContext& context,
     const envoy::extensions::tracers::opentelemetry::samplers::v3::DynatraceSamplerConfig& config)
     : cluster_manager_(context.serverFactoryContext().clusterManager()),
-      http_uri_(config.http_uri()),
-      authorization_header_value_(absl::StrCat("Api-Token ", config.token())),
-      sampler_config_(config.root_spans_per_minute()) {
+      http_uri_(config.http_service().http_uri()), sampler_config_(config.root_spans_per_minute()) {
+
+  for (const auto& header_value_option : config.http_service().request_headers_to_add()) {
+    parsed_headers_to_add_.push_back({Http::LowerCaseString(header_value_option.header().key()),
+                                      header_value_option.header().value()});
+  }
 
   timer_ = context.serverFactoryContext().mainThreadDispatcher().createTimer([this]() -> void {
     const auto thread_local_cluster = cluster_manager_.getThreadLocalCluster(http_uri_.cluster());
@@ -47,8 +50,9 @@ SamplerConfigProviderImpl::SamplerConfigProviderImpl(
     } else {
       Http::RequestMessagePtr message = Http::Utility::prepareHeaders(http_uri_);
       message->headers().setReferenceMethod(Http::Headers::get().MethodValues.Get);
-      message->headers().setReference(Http::CustomHeaders::get().Authorization,
-                                      authorization_header_value_);
+      for (const auto& header_pair : parsed_headers_to_add_) {
+        message->headers().setReference(header_pair.first, header_pair.second);
+      }
       active_request_ = thread_local_cluster->httpAsyncClient().send(
           std::move(message), *this,
           Http::AsyncClient::RequestOptions().setTimeout(std::chrono::milliseconds(

diff --git a/source/extensions/tracers/opentelemetry/samplers/dynatrace/sampler_config_provider.h b/source/extensions/tracers/opentelemetry/samplers/dynatrace/sampler_config_provider.h
@@ -4,6 +4,8 @@
 #include <utility>
 #include <vector>
 
+#include "envoy/config/core/v3/http_service.pb.h"
+#include "envoy/config/core/v3/http_uri.pb.h"
 #include "envoy/extensions/tracers/opentelemetry/samplers/v3/dynatrace_sampler.pb.h"
 #include "envoy/http/async_client.h"
 #include "envoy/http/message.h"
@@ -65,7 +67,7 @@ class SamplerConfigProviderImpl : public SamplerConfigProvider,
   Event::TimerPtr timer_;
   Upstream::ClusterManager& cluster_manager_;
   envoy::config::core::v3::HttpUri http_uri_;
-  const std::string authorization_header_value_;
+  std::vector<std::pair<const Http::LowerCaseString, const std::string>> parsed_headers_to_add_;
   Http::AsyncClient::Request* active_request_{};
   SamplerConfig sampler_config_;
 };

diff --git a/test/extensions/tracers/opentelemetry/samplers/dynatrace/sampler_config_provider_test.cc b/test/extensions/tracers/opentelemetry/samplers/dynatrace/sampler_config_provider_test.cc
@@ -31,11 +31,15 @@ class SamplerConfigProviderTest : public testing::Test {
     const std::string yaml_string = R"EOF(
           tenant: "abc12345"
           cluster_id: -1743916452
-          token: "tokenval"
-          http_uri:
-            cluster: "cluster_name"
-            uri: "https://testhost.com/api/v2/samplingConfiguration"
-            timeout: 0.250s
+          http_service:
+            http_uri:
+              cluster: "cluster_name"
+              uri: "https://testhost.com/api/v2/samplingConfiguration"
+              timeout: 0.250s
+            request_headers_to_add:
+            - header:
+                key: "authorization"
+                value: "Api-Token tokenval"
           root_spans_per_minute: 1000
     )EOF";
     TestUtility::loadFromYaml(yaml_string, proto_config_);
@@ -58,7 +62,6 @@ class SamplerConfigProviderTest : public testing::Test {
 };
 
 MATCHER_P(MessageMatcher, unusedArg, "") {
-  // prefix 'Api-Token' should be added to 'tokenval' set via SamplerConfigProvider constructor
   return (arg->headers()
               .get(Http::CustomHeaders::get().Authorization)[0]
               ->value()
@@ -206,11 +209,11 @@ TEST_F(SamplerConfigProviderTest, TestValueConfigured) {
   const std::string yaml_string = R"EOF(
           tenant: "abc12345"
           cluster_id: -1743916452
-          token: "tokenval"
-          http_uri:
-            cluster: "cluster_name"
-            uri: "https://testhost.com/otlp/v1/traces"
-            timeout: 0.250s
+          http_service:
+            http_uri:
+              cluster: "cluster_name"
+              uri: "https://testhost.com/otlp/v1/traces"
+              timeout: 0.250s
           root_spans_per_minute: 3456
     )EOF";
 
@@ -226,11 +229,11 @@ TEST_F(SamplerConfigProviderTest, TestNoValueConfigured) {
   const std::string yaml_string = R"EOF(
           tenant: "abc12345"
           cluster_id: -1743916452
-          token: "tokenval"
-          http_uri:
-            cluster: "cluster_name"
-            uri: "https://testhost.com/otlp/v1/traces"
-            timeout: 500s
+          http_service:
+            http_uri:
+              cluster: "cluster_name"
+              uri: "https://testhost.com/otlp/v1/traces"
+              timeout: 500s
     )EOF";
 
   envoy::extensions::tracers::opentelemetry::samplers::v3::DynatraceSamplerConfig proto_config;
@@ -246,11 +249,11 @@ TEST_F(SamplerConfigProviderTest, TestValueZeroConfigured) {
   const std::string yaml_string = R"EOF(
           tenant: "abc12345"
           cluster_id: -1743916452
-          token: "tokenval"
-          http_uri:
-            cluster: "cluster_name"
-            uri: "https://testhost.com/otlp/v1/traces"
-            timeout: 0.250s
+          http_service:
+            http_uri:
+              cluster: "cluster_name"
+              uri: "https://testhost.com/otlp/v1/traces"
+              timeout: 0.250s
           root_spans_per_minute: 0
     )EOF";