Skip to content
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

Jump to bottom

Update docs for skywalking tracer #14210

Merged
merged 3 commits into from
Dec 1, 2020
Merged

Update docs for skywalking tracer #14210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1a9a25
update docs for skywalking tracer
Nov 23, 2020
1b610e8
Merge branch 'master' of https://github.com/envoyproxy/envoy into sky…
Nov 30, 2020
36b61d6
fix grammer error
Dec 1, 2020
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
10 changes: 10 additions & 0 deletions docs/root/configuration/http/http_conn_man/headers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 the SkyWalking tracer and is used to establish the relationship between
the tracing spans of downstream and Envoy. See more on SkyWalking tracing
`here <https://github.com/apache/skywalking/blob/v8.1.0/docs/en/protocols/Skywalking-Cross-Process-Propagation-Headers-Protocol-v3.md>`__.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just missing a couple of 'the' articles:

for the SkyWalking tracer
between the tracing spans


.. _config_http_conn_man_headers_custom_request_headers:

Custom request/response headers
Expand Down
8 changes: 6 additions & 2 deletions docs/root/intro/arch_overview/observability/tracing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://lightstep.com/>`_,
`Zipkin <https://zipkin.io/>`_ or any Zipkin compatible backends (e.g. `Jaeger <https://github.com/jaegertracing/>`_), and
`Datadog <https://datadoghq.com>`_.
`Zipkin <https://zipkin.io/>`_ or any Zipkin compatible backends (e.g. `Jaeger <https://github.com/jaegertracing/>`_),
`Datadog <https://datadoghq.com>`_ and `SkyWalking <http://skywalking.apache.org/>`_.
- External tracers which come as a third party plugin, like `Instana <https://www.instana.com/blog/monitoring-envoy-proxy-microservices/>`_.

Support for other tracing providers would not be difficult to add.
Expand Down Expand Up @@ -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
Expand Down