Skip to content

Commit 91c8542

Browse files
committed
docs: document useElasticTraceparentHeader config var (#3316)
Closes: #2469
1 parent fc3cd22 commit 91c8542

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/configuration.asciidoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1436,3 +1436,20 @@ require('elastic-apm-node').start({
14361436
The URL path patterns for which the APM agent will capture the request body of outgoing requests to Elasticsearch made with the `@elastic/elasticsearch` module (or the legacy `elasticsearch` module). The default setting captures the body for https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html[Elasticsearch REST APIs] making a search.
14371437

14381438
The captured request body (if any) is stored on the `span.db.statement` field. Captured request bodies are truncated to a maximum length defined by <<long-field-max-length>>.
1439+
1440+
1441+
[[use-elastic-traceparent-header]]
1442+
==== `useElasticTraceparentHeader`
1443+
1444+
* *Type:* Boolean
1445+
* *Default:* `true`
1446+
* *Env:* `ELASTIC_APM_USE_ELASTIC_TRACEPARENT_HEADER`
1447+
1448+
To enable {apm-guide-ref}/apm-distributed-tracing.html[distributed tracing], the agent
1449+
adds trace context headers to outgoing requests (like HTTP requests, etc.).
1450+
These headers (`traceparent` and `tracestate`) are defined in the
1451+
https://www.w3.org/TR/trace-context-1/[W3C Trace Context] specification.
1452+
1453+
When this setting is `true`, the agent will also add the header `elastic-apm-traceparent`
1454+
for backwards compatibility with older versions of Elastic APM agents. (In the
1455+
next major version of this APM agent, this setting will default to false.)

0 commit comments

Comments
 (0)