tracing: apply tracer provider configuration defined as part of `http…

…_connection_manager` filter (#10405) Signed-off-by: Yaroslav Skopets <yaroslav@tetrate.io>
envoyproxy · Apr 10, 2020 · 449be5e · 449be5e
1 parent 8e8209f
commit 449be5e
Show file tree

Hide file tree

Showing 36 changed files with 389 additions and 251 deletions.
diff --git a/api/envoy/config/bootstrap/v2/bootstrap.proto b/api/envoy/config/bootstrap/v2/bootstrap.proto
@@ -117,8 +117,11 @@ message Bootstrap {
   // Optional watchdog configuration.
   Watchdog watchdog = 8;
 
-  // Configuration for an external tracing provider. If not specified, no
-  // tracing will be performed.
+  // Configuration for an external tracing provider.
+  //
+  // .. attention::
+  //  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
+  //  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`.
   trace.v2.Tracing tracing = 9;
 
   // Configuration for the runtime configuration provider (deprecated). If not

diff --git a/api/envoy/config/bootstrap/v3/bootstrap.proto b/api/envoy/config/bootstrap/v3/bootstrap.proto
@@ -129,9 +129,12 @@ message Bootstrap {
   // Optional watchdog configuration.
   Watchdog watchdog = 8;
 
-  // Configuration for an external tracing provider. If not specified, no
-  // tracing will be performed.
-  trace.v3.Tracing tracing = 9;
+  // Configuration for an external tracing provider.
+  //
+  // .. attention::
+  //  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
+  //  <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`.
+  trace.v3.Tracing tracing = 9 [deprecated = true];
 
   // Configuration for the runtime configuration provider. If not
   // specified, a “null” provider will be used which will result in all defaults

diff --git a/api/envoy/config/bootstrap/v4alpha/BUILD b/api/envoy/config/bootstrap/v4alpha/BUILD
@@ -13,7 +13,6 @@ api_proto_package(
         "//envoy/config/listener/v3:pkg",
         "//envoy/config/metrics/v3:pkg",
         "//envoy/config/overload/v3:pkg",
-        "//envoy/config/trace/v4alpha:pkg",
         "//envoy/extensions/transport_sockets/tls/v4alpha:pkg",
         "@com_github_cncf_udpa//udpa/annotations:pkg",
     ],

diff --git a/api/envoy/config/bootstrap/v4alpha/bootstrap.proto b/api/envoy/config/bootstrap/v4alpha/bootstrap.proto
@@ -11,7 +11,6 @@ import "envoy/config/core/v4alpha/socket_option.proto";
 import "envoy/config/listener/v3/listener.proto";
 import "envoy/config/metrics/v3/stats.proto";
 import "envoy/config/overload/v3/overload.proto";
-import "envoy/config/trace/v4alpha/trace.proto";
 import "envoy/extensions/transport_sockets/tls/v4alpha/cert.proto";
 
 import "google/protobuf/duration.proto";
@@ -85,9 +84,9 @@ message Bootstrap {
     core.v4alpha.ApiConfigSource ads_config = 3;
   }
 
-  reserved 10, 11;
+  reserved 10, 11, 9;
 
-  reserved "runtime";
+  reserved "runtime", "tracing";
 
   // Node identity to present to the management server and for instance
   // identification purposes (e.g. in generated headers).
@@ -129,10 +128,6 @@ message Bootstrap {
   // Optional watchdog configuration.
   Watchdog watchdog = 8;
 
-  // Configuration for an external tracing provider. If not specified, no
-  // tracing will be performed.
-  trace.v4alpha.Tracing tracing = 9;
-
   // Configuration for the runtime configuration provider. If not
   // specified, a “null” provider will be used which will result in all defaults
   // being used.

diff --git a/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto b/api/envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto
@@ -161,9 +161,15 @@ message HttpConnectionManager {
     repeated type.tracing.v2.CustomTag custom_tags = 8;
 
     // Configuration for an external tracing provider.
-    // If not specified, Envoy will fall back to using tracing provider configuration
-    // from the bootstrap config.
-    // [#not-implemented-hide:]
+    // If not specified, no tracing will be performed.
+    //
+    // .. attention::
+    //   Please be aware that *envoy.tracers.opencensus* provider can only be configured once
+    //   in Envoy lifetime.
+    //   Any attempts to reconfigure it or to use different configurations for different HCM filters
+    //   will be rejected.
+    //   Such a constraint is inherent to OpenCensus itself. It cannot be overcome without changes
+    //   on OpenCensus side.
     trace.v2.Tracing.Http provider = 9;
   }
 

diff --git a/api/envoy/config/trace/v2/trace.proto b/api/envoy/config/trace/v2/trace.proto
@@ -22,12 +22,22 @@ option (udpa.annotations.file_status).package_version_status = FROZEN;
 // [#protodoc-title: Tracing]
 // Tracing :ref:`architecture overview <arch_overview_tracing>`.
 
-// The tracing configuration specifies global
-// settings for the HTTP tracer used by Envoy. The configuration is defined by
-// the :ref:`Bootstrap <envoy_api_msg_config.bootstrap.v2.Bootstrap>` :ref:`tracing
-// <envoy_api_field_config.bootstrap.v2.Bootstrap.tracing>` field. Envoy may support other tracers
-// in the future, but right now the HTTP tracer is the only one supported.
+// The tracing configuration specifies settings for an HTTP tracer provider used by Envoy.
+//
+// Envoy may support other tracers in the future, but right now the HTTP tracer is the only one
+// supported.
+//
+// .. attention::
+//
+//   Use of this message type has been deprecated in favor of direct use of
+//   :ref:`Tracing.Http <envoy_api_msg_config.trace.v2.Tracing.Http>`.
 message Tracing {
+  // Configuration for an HTTP tracer provider used by Envoy.
+  //
+  // The configuration is defined by the
+  // :ref:`HttpConnectionManager.Tracing <envoy_api_msg_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing>`
+  // :ref:`provider <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`
+  // field.
   message Http {
     // The name of the HTTP trace driver to instantiate. The name must match a
     // supported HTTP trace driver. Built-in trace drivers:

diff --git a/api/envoy/config/trace/v3/trace.proto b/api/envoy/config/trace/v3/trace.proto
@@ -23,14 +23,24 @@ option (udpa.annotations.file_status).package_version_status = ACTIVE;
 // [#protodoc-title: Tracing]
 // Tracing :ref:`architecture overview <arch_overview_tracing>`.
 
-// The tracing configuration specifies global
-// settings for the HTTP tracer used by Envoy. The configuration is defined by
-// the :ref:`Bootstrap <envoy_api_msg_config.bootstrap.v3.Bootstrap>` :ref:`tracing
-// <envoy_api_field_config.bootstrap.v3.Bootstrap.tracing>` field. Envoy may support other tracers
-// in the future, but right now the HTTP tracer is the only one supported.
+// The tracing configuration specifies settings for an HTTP tracer provider used by Envoy.
+//
+// Envoy may support other tracers in the future, but right now the HTTP tracer is the only one
+// supported.
+//
+// .. attention::
+//
+//   Use of this message type has been deprecated in favor of direct use of
+//   :ref:`Tracing.Http <envoy_api_msg_config.trace.v3.Tracing.Http>`.
 message Tracing {
   option (udpa.annotations.versioning).previous_message_type = "envoy.config.trace.v2.Tracing";
 
+  // Configuration for an HTTP tracer provider used by Envoy.
+  //
+  // The configuration is defined by the
+  // :ref:`HttpConnectionManager.Tracing <envoy_api_msg_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing>`
+  // :ref:`provider <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`
+  // field.
   message Http {
     option (udpa.annotations.versioning).previous_message_type =
         "envoy.config.trace.v2.Tracing.Http";

diff --git a/api/envoy/config/trace/v4alpha/trace.proto b/api/envoy/config/trace/v4alpha/trace.proto
@@ -23,14 +23,24 @@ option (udpa.annotations.file_status).package_version_status = NEXT_MAJOR_VERSIO
 // [#protodoc-title: Tracing]
 // Tracing :ref:`architecture overview <arch_overview_tracing>`.
 
-// The tracing configuration specifies global
-// settings for the HTTP tracer used by Envoy. The configuration is defined by
-// the :ref:`Bootstrap <envoy_api_msg_config.bootstrap.v4alpha.Bootstrap>` :ref:`tracing
-// <envoy_api_field_config.bootstrap.v4alpha.Bootstrap.tracing>` field. Envoy may support other tracers
-// in the future, but right now the HTTP tracer is the only one supported.
+// The tracing configuration specifies settings for an HTTP tracer provider used by Envoy.
+//
+// Envoy may support other tracers in the future, but right now the HTTP tracer is the only one
+// supported.
+//
+// .. attention::
+//
+//   Use of this message type has been deprecated in favor of direct use of
+//   :ref:`Tracing.Http <envoy_api_msg_config.trace.v4alpha.Tracing.Http>`.
 message Tracing {
   option (udpa.annotations.versioning).previous_message_type = "envoy.config.trace.v3.Tracing";
 
+  // Configuration for an HTTP tracer provider used by Envoy.
+  //
+  // The configuration is defined by the
+  // :ref:`HttpConnectionManager.Tracing <envoy_api_msg_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.Tracing>`
+  // :ref:`provider <envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.HttpConnectionManager.Tracing.provider>`
+  // field.
   message Http {
     option (udpa.annotations.versioning).previous_message_type =
         "envoy.config.trace.v3.Tracing.Http";

diff --git a/...envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto b/...envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto
@@ -148,9 +148,15 @@ message HttpConnectionManager {
     repeated type.tracing.v3.CustomTag custom_tags = 8;
 
     // Configuration for an external tracing provider.
-    // If not specified, Envoy will fall back to using tracing provider configuration
-    // from the bootstrap config.
-    // [#not-implemented-hide:]
+    // If not specified, no tracing will be performed.
+    //
+    // .. attention::
+    //   Please be aware that *envoy.tracers.opencensus* provider can only be configured once
+    //   in Envoy lifetime.
+    //   Any attempts to reconfigure it or to use different configurations for different HCM filters
+    //   will be rejected.
+    //   Such a constraint is inherent to OpenCensus itself. It cannot be overcome without changes
+    //   on OpenCensus side.
     config.trace.v3.Tracing.Http provider = 9;
   }
 

diff --git a/.../extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto b/.../extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto
@@ -148,9 +148,15 @@ message HttpConnectionManager {
     repeated type.tracing.v3.CustomTag custom_tags = 8;
 
     // Configuration for an external tracing provider.
-    // If not specified, Envoy will fall back to using tracing provider configuration
-    // from the bootstrap config.
-    // [#not-implemented-hide:]
+    // If not specified, no tracing will be performed.
+    //
+    // .. attention::
+    //   Please be aware that *envoy.tracers.opencensus* provider can only be configured once
+    //   in Envoy lifetime.
+    //   Any attempts to reconfigure it or to use different configurations for different HCM filters
+    //   will be rejected.
+    //   Such a constraint is inherent to OpenCensus itself. It cannot be overcome without changes
+    //   on OpenCensus side.
     config.trace.v4alpha.Tracing.Http provider = 9;
   }
 

diff --git a/configs/envoy_double_proxy_v2.template.yaml b/configs/envoy_double_proxy_v2.template.yaml
@@ -60,6 +60,12 @@
           typed_config: {}
         tracing:
           operation_name: INGRESS
+          provider:
+            name: envoy.tracers.lightstep
+            typed_config:
+              "@type": type.googleapis.com/envoy.config.trace.v2.LightstepConfig
+              access_token_file: "/etc/envoy/lightstep_access_token"
+              collector_cluster: lightstep_saas
         common_http_protocol_options:
           idle_timeout: 840s
         access_log:
@@ -177,13 +183,6 @@ stats_sinks:
   typed_config:
     "@type": type.googleapis.com/envoy.config.metrics.v2.StatsdSink
     tcp_cluster_name: statsd
-tracing:
-  http:
-    name: envoy.tracers.lightstep
-    typed_config:
-      "@type": type.googleapis.com/envoy.config.trace.v2.LightstepConfig
-      access_token_file: "/etc/envoy/lightstep_access_token"
-      collector_cluster: lightstep_saas
 layered_runtime:
   layers:
     - name: root

diff --git a/configs/envoy_front_proxy_v2.template.yaml b/configs/envoy_front_proxy_v2.template.yaml
@@ -70,6 +70,12 @@
         add_user_agent: true
         tracing:
           operation_name: INGRESS
+          provider:
+            name: envoy.tracers.lightstep
+            typed_config:
+              "@type": type.googleapis.com/envoy.config.trace.v2.LightstepConfig
+              collector_cluster: lightstep_saas
+              access_token_file: "/etc/envoy/lightstep_access_token"
         common_http_protocol_options:
           idle_timeout: 840s
         access_log:
@@ -155,13 +161,6 @@ cluster_manager:
   outlier_detection:
     event_log_path: /var/log/envoy/outlier_events.log
 flags_path: /etc/envoy/flags
-tracing:
-  http:
-    name: envoy.tracers.lightstep
-    typed_config:
-      "@type": type.googleapis.com/envoy.config.trace.v2.LightstepConfig
-      collector_cluster: lightstep_saas
-      access_token_file: "/etc/envoy/lightstep_access_token"
 layered_runtime:
   layers:
     - name: root

diff --git a/configs/envoy_service_to_service_v2.template.yaml b/configs/envoy_service_to_service_v2.template.yaml
@@ -551,13 +551,6 @@ stats_sinks:
       "@type": type.googleapis.com/envoy.config.metrics.v2.StatsdSink
       tcp_cluster_name: statsd
 watchdog: {}
-tracing:
-  http:
-    name: envoy.tracers.lightstep
-    typed_config:
-      "@type": type.googleapis.com/envoy.config.trace.v2.LightstepConfig
-      access_token_file: "/etc/envoy/lightstep_access_token"
-      collector_cluster: lightstep_saas
 layered_runtime:
   layers:
     - name: root

diff --git a/docs/root/version_history/current.rst b/docs/root/version_history/current.rst
@@ -6,7 +6,12 @@ Changes
 
 * http: fixed a bug where the upgrade header was not cleared on responses to non-upgrade requests.
   Can be reverted temporarily by setting runtime feature `envoy.reloadable_features.fix_upgrade_response` to false.
+* tracing: tracing configuration has been made fully dynamic and every HTTP connection manager
+  can now have a separate :ref:`tracing provider <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`.
 
 Deprecated
 ----------
 
+* Tracing provider configuration as part of :ref:`bootstrap config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.tracing>`
+  has been deprecated in favor of configuration as part of :ref:`HTTP connection manager
+  <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`.
diff --git a/examples/jaeger-native-tracing/front-envoy-jaeger.yaml b/examples/jaeger-native-tracing/front-envoy-jaeger.yaml
@@ -11,6 +11,26 @@ static_resources:
         typed_config:
           "@type": type.googleapis.com/envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager
           generate_request_id: true
+          tracing:
+            provider:
+              name: envoy.tracers.dynamic_ot
+              typed_config:
+                "@type": type.googleapis.com/envoy.config.trace.v2.DynamicOtConfig
+                library: /usr/local/lib/libjaegertracing_plugin.so
+                config:
+                  service_name: front-proxy
+                  sampler:
+                    type: const
+                    param: 1
+                  reporter:
+                    localAgentHostPort: jaeger:6831
+                  headers:
+                    jaegerDebugHeader: jaeger-debug-id
+                    jaegerBaggageHeader: jaeger-baggage
+                    traceBaggageHeaderPrefix: uberctx-
+                  baggage_restrictions:
+                    denyBaggageOnInitializationFailure: false
+                    hostPort: ""
           codec_type: auto
           stat_prefix: ingress_http
           route_config:
@@ -45,26 +65,6 @@ static_resources:
               socket_address:
                 address: service1
                 port_value: 80
-tracing:
-  http:
-    name: envoy.tracers.dynamic_ot
-    typed_config:
-      "@type": type.googleapis.com/envoy.config.trace.v2.DynamicOtConfig
-      library: /usr/local/lib/libjaegertracing_plugin.so
-      config:
-        service_name: front-proxy
-        sampler:
-          type: const
-          param: 1
-        reporter:
-          localAgentHostPort: jaeger:6831
-        headers:
-          jaegerDebugHeader: jaeger-debug-id
-          jaegerBaggageHeader: jaeger-baggage
-          traceBaggageHeaderPrefix: uberctx-
-        baggage_restrictions:
-          denyBaggageOnInitializationFailure: false
-          hostPort: ""
 admin:
   access_log_path: "/dev/null"
   address: