From b1a9a25b04cca615820a73e74a80705c24d50900 Mon Sep 17 00:00:00 2001 From: wbpcode Date: Mon, 23 Nov 2020 17:24:25 +0800 Subject: [PATCH 1/2] update docs for skywalking tracer Signed-off-by: wbpcode --- docs/root/configuration/http/http_conn_man/headers.rst | 10 ++++++++++ .../root/intro/arch_overview/observability/tracing.rst | 8 ++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/root/configuration/http/http_conn_man/headers.rst b/docs/root/configuration/http/http_conn_man/headers.rst index e95b6479d8bb..63d77d3fe45b 100644 --- a/docs/root/configuration/http/http_conn_man/headers.rst +++ b/docs/root/configuration/http/http_conn_man/headers.rst @@ -460,6 +460,16 @@ The integer value indicates the sampling decision that has been made for this tr A value of 0 indicates that the trace should not be collected, and a value of 1 requests that spans are sampled and reported. +.. _config_http_conn_man_headers_sw8: + +sw8 +---------- + +The *sw8* HTTP header is used by the SkyWalking tracer in Envoy. It contains the key +tracing context for SkyWalking tracer and is used to establish the relationship between +tracing spans of downstream and Envoy. See more on SkyWalking tracing +`here `__. + .. _config_http_conn_man_headers_custom_request_headers: Custom request/response headers diff --git a/docs/root/intro/arch_overview/observability/tracing.rst b/docs/root/intro/arch_overview/observability/tracing.rst index 958b003a5d9a..bfddeb924a02 100644 --- a/docs/root/intro/arch_overview/observability/tracing.rst +++ b/docs/root/intro/arch_overview/observability/tracing.rst @@ -19,8 +19,8 @@ sources of latency. Envoy supports three features related to system wide tracing providers, that are divided into two subgroups: - External tracers which are part of the Envoy code base, like `LightStep `_, - `Zipkin `_ or any Zipkin compatible backends (e.g. `Jaeger `_), and - `Datadog `_. + `Zipkin `_ or any Zipkin compatible backends (e.g. `Jaeger `_), + `Datadog `_ and `SkyWalking `_. - External tracers which come as a third party plugin, like `Instana `_. Support for other tracing providers would not be difficult to add. @@ -82,6 +82,10 @@ Alternatively the trace context can be manually propagated by the service: :ref:`config_http_conn_man_headers_x-datadog-parent-id`, :ref:`config_http_conn_man_headers_x-datadog-sampling-priority`). +* When using the SkyWalking tracer, Envoy relies on the service to propagate the + SkyWalking-specific HTTP headers ( + :ref:`config_http_conn_man_headers_sw8`). + What data each trace contains ----------------------------- An end-to-end trace is comprised of one or more spans. A From 36b61d65fae5891115a3af80cc8f1e1009718158 Mon Sep 17 00:00:00 2001 From: wbpcode Date: Tue, 1 Dec 2020 02:10:32 +0000 Subject: [PATCH 2/2] fix grammer error Signed-off-by: wbpcode --- docs/root/configuration/http/http_conn_man/headers.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/root/configuration/http/http_conn_man/headers.rst b/docs/root/configuration/http/http_conn_man/headers.rst index 63d77d3fe45b..fa3993706b6a 100644 --- a/docs/root/configuration/http/http_conn_man/headers.rst +++ b/docs/root/configuration/http/http_conn_man/headers.rst @@ -466,8 +466,8 @@ sw8 ---------- The *sw8* HTTP header is used by the SkyWalking tracer in Envoy. It contains the key -tracing context for SkyWalking tracer and is used to establish the relationship between -tracing spans of downstream and Envoy. See more on SkyWalking tracing +tracing context for the SkyWalking tracer and is used to establish the relationship between +the tracing spans of downstream and Envoy. See more on SkyWalking tracing `here `__. .. _config_http_conn_man_headers_custom_request_headers: