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

docs: document W3C tracecontext header #645

Merged
merged 2 commits into from
Mar 11, 2020
Merged

docs: document W3C tracecontext header #645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f901d5e
docs: document W3C tracecontext header
hmdhk Feb 17, 2020
f06634b
rephrase compatibility section
jahtalab Mar 4, 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
2 changes: 1 addition & 1 deletion docs/configuration.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ Distributed tracing is enabled by default, however you can use this configuratio
* *Default:* `[]`

This option is an array of strings and determines which origins should be monitored as part of distributed tracing.
More specificly this option is consulted when the agent is about to add distributed tracing http header (`elastic-apm-traceparent`) to a request.
More specificly this option is consulted when the agent is about to add distributed tracing http header (`traceparent`) to a request.
Please note that each item in the array should be a valid url and at least include the origin part (other parts of the url are ignored).

[source,js]
Expand Down
31 changes: 27 additions & 4 deletions docs/distributed-tracing-guide.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var apm = initApm({
})
----

This effectively tells the agent to add the distributed tracing HTTP header (`elastic-apm-traceparent`)
This effectively tells the agent to add the distributed tracing HTTP header (`traceparent`)
to requests made to `https://api.example.com`.

Note that distributed tracing headers are only appended to API calls.
Expand All @@ -46,7 +46,7 @@ Specifically, `https://api.example.com` will receive an `OPTIONS` request with t

[source,header]
----
Access-Control-Request-Headers: elastic-apm-traceparent
Access-Control-Request-Headers: traceparent
Access-Control-Request-Method: [request-method]
Origin: [request-origin]
----
Expand All @@ -55,17 +55,40 @@ And should respond to it with these headers:

[source,header]
----
Access-Control-Allow-Headers: elastic-apm-traceparent
Access-Control-Allow-Headers: traceparent
Access-Control-Allow-Methods: [allowed-methods]
Access-Control-Allow-Origin: [request-origin]
----

NOTE: `Access-Control-Request-Headers` might include more headers than just `elastic-apm-traceparent`.
NOTE: `Access-Control-Request-Headers` might include more headers than just `traceparent`.
The response should include all headers if the server wishes to let the browser send the original request.

NOTE: To make sure all components in a distributed trace are included,
the sampling rate of backend agents might be affected by the sampling rate of the RUM agent.


[float]
[[backend-agent-compatibility]]
=== Backend Agent compatibility

Starting in version 5.0, the RUM Agent supports the official W3C tracecontext `traceparent` header,
instead of the previously used `elastic-apm-traceparent` header.
Use the table below to determine which versions of our backend agents also support the official W3C
tracecontext headers. Compatible agents use the official tracecontext spec to propagate traces and can
therefor be used with the RUM Agent version >=5.0 for distributed tracing.

[options="header"]
|====
|Agent |Agent Version
|**Go Agent**|>= `1.6`
|**Java Agent**|>= `1.14`
|**.NET Agent**|>= `1.3`
|**Node.js Agent**|>= `3.4`
|**Python Agent**|>= `5.4`
|**Ruby Agent**|>= `3.5`
|====


[float]
[[dynamic-html-doc]]
=== Dynamically-generated HTML
Expand Down