@@ -9,7 +9,7 @@ cSpell:ignore: ottrace
99{{% alert title="Note" %}}
1010
1111Support for environment variables is optional. For detailed information on which
12- environment variables each language implementation supports, please consult the
12+ environment variables each language implementation supports, see the
1313[ Implementation Compliance Matrix] ( https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md#environment-variables ) .
1414
1515{{% /alert %}}
@@ -19,63 +19,70 @@ environment variables each language implementation supports, please consult the
1919Sets the value of the [ ` service.name ` ] ( /docs/specs/semconv/resource/#service )
2020resource attribute.
2121
22- ** Default value:** ` " unknown_service" `
22+ ** Default value:** ` unknown_service `
2323
2424If ` service.name ` is also provided in ` OTEL_RESOURCE_ATTRIBUTES ` , then
2525` OTEL_SERVICE_NAME ` takes precedence.
2626
2727** Example:**
2828
29- ` export OTEL_SERVICE_NAME="your-service-name" `
29+ ``` sh
30+ export OTEL_SERVICE_NAME=" your-service-name"
31+ ```
3032
3133## ` OTEL_RESOURCE_ATTRIBUTES `
3234
33- Key-value pairs to be used as resource attributes. See
34- [ Resource SDK] ( /docs/specs/otel/resource/sdk#specifying-resource-information-via-an-environment-variable )
35- for more details.
36-
37- ** Default value:** Empty.
35+ Key-value pairs to be used as resource attributes.
3836
39- See
40- [ Resource semantic conventions] ( /docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value )
41- for semantic conventions to follow for common resource types.
37+ ** Default value:** empty
4238
4339** Example:**
4440
45- ` export OTEL_RESOURCE_ATTRIBUTES="key1=value1,key2=value2" `
41+ ``` sh
42+ export OTEL_RESOURCE_ATTRIBUTES=" key1=value1,key2=value2"
43+ ```
44+
45+ ** References:**
46+
47+ - [ Resource SDK] ( /docs/specs/otel/resource/sdk#specifying-resource-information-via-an-environment-variable )
48+ - [ Resource semantic conventions] ( /docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value )
49+ for common resource type semantic conventions
4650
4751## ` OTEL_TRACES_SAMPLER `
4852
4953Specifies the Sampler used to sample traces by the SDK.
5054
51- ** Default value:** ` " parentbased_always_on" `
55+ ** Default value:** ` parentbased_always_on `
5256
5357** Example:**
5458
55- ` export OTEL_TRACES_SAMPLER="traceidratio" `
59+ ``` sh
60+ export OTEL_TRACES_SAMPLER=" traceidratio"
61+ ```
5662
5763Accepted values for ` OTEL_TRACES_SAMPLER ` are:
5864
59- - ` "always_on" ` : ` AlwaysOnSampler `
60- - ` "always_off" ` : ` AlwaysOffSampler `
61- - ` "traceidratio" ` : ` TraceIdRatioBased `
62- - ` "parentbased_always_on" ` : ` ParentBased(root=AlwaysOnSampler) `
63- - ` "parentbased_always_off" ` : ` ParentBased(root=AlwaysOffSampler) `
64- - ` "parentbased_traceidratio" ` : ` ParentBased(root=TraceIdRatioBased) `
65- - ` "parentbased_jaeger_remote" ` : ` ParentBased(root=JaegerRemoteSampler) `
66- - ` "jaeger_remote" ` : ` JaegerRemoteSampler `
67- - ` "xray" ` :
68- [ AWS X-Ray Centralized Sampling] ( https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.html )
69- (_ third party_ )
65+ - ` always_on ` : ` AlwaysOnSampler `
66+ - ` always_off ` : ` AlwaysOffSampler `
67+ - ` traceidratio ` : ` TraceIdRatioBased `
68+ - ` parentbased_always_on ` : ` ParentBased(root=AlwaysOnSampler) `
69+ - ` parentbased_always_off ` : ` ParentBased(root=AlwaysOffSampler) `
70+ - ` parentbased_traceidratio ` : ` ParentBased(root=TraceIdRatioBased) `
71+ - ` parentbased_jaeger_remote ` : ` ParentBased(root=JaegerRemoteSampler) `
72+ - ` jaeger_remote ` : ` JaegerRemoteSampler `
73+ - ` xray ` : [ AWS X-Ray Centralized Sampling] [ ] (_ third party_ )
74+
75+ [ AWS X-Ray Centralized Sampling] :
76+ https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.html
7077
7178## ` OTEL_TRACES_SAMPLER_ARG `
7279
73- Specifies arguments, if applicable, to the sampler defined in by
80+ Specifies arguments, if applicable, to the sampler defined by
7481` OTEL_TRACES_SAMPLER ` . The specified value will only be used if
7582` OTEL_TRACES_SAMPLER ` is set. Each Sampler type defines its own expected input,
7683if any. Invalid or unrecognized input is logged as an error.
7784
78- ** Default value:** Empty.
85+ ** Default value:** empty
7986
8087** Example:**
8188
@@ -93,7 +100,7 @@ be set as follows:
93100- For ` jaeger_remote ` and ` parentbased_jaeger_remote ` : The value is a comma
94101 separated list:
95102 - Example:
96- ` " endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25" `
103+ ` endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25 `
97104 - ` endpoint ` : the endpoint in form of ` scheme://host:port ` of gRPC server that
98105 serves the sampling strategy for the service
99106 ([ sampling.proto] ( https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/sampling.proto ) ).
@@ -109,82 +116,80 @@ be set as follows:
109116
110117Specifies Propagators to be used in a comma-separated list.
111118
112- ** Default value:** ` " tracecontext,baggage" `
119+ ** Default value:** ` tracecontext,baggage `
113120
114121** Example:**
115122
116123` export OTEL_PROPAGATORS="b3" `
117124
118125Accepted values for ` OTEL_PROPAGATORS ` are:
119126
120- - ` "tracecontext" ` : [ W3C Trace Context] ( https://www.w3.org/TR/trace-context/ )
121- - ` "baggage" ` : [ W3C Baggage] ( https://www.w3.org/TR/baggage/ )
122- - ` "b3" ` : [ B3 Single] ( /docs/specs/otel/context/api-propagators#configuration )
123- - ` "b3multi" ` :
124- [ B3 Multi] ( /docs/specs/otel/context/api-propagators#configuration )
125- - ` "jaeger" ` :
127+ - ` tracecontext ` : [ W3C Trace Context] ( https://www.w3.org/TR/trace-context/ )
128+ - ` baggage ` : [ W3C Baggage] ( https://www.w3.org/TR/baggage/ )
129+ - ` b3 ` : [ B3 Single] ( /docs/specs/otel/context/api-propagators#configuration )
130+ - ` b3multi ` : [ B3 Multi] ( /docs/specs/otel/context/api-propagators#configuration )
131+ - ` jaeger ` :
126132 [ Jaeger] ( https://www.jaegertracing.io/docs/1.21/client-libraries/#propagation-format )
127- - ` " xray" ` :
133+ - ` xray ` :
128134 [ AWS X-Ray] ( https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader )
129135 (_ third party_ )
130- - ` "ottrace" ` :
131- [ OT Trace] ( https://github.com/opentracing?q=basic&type=&language= ) (_ third
132- party_ )
133- - ` "none" ` : No automatically configured propagator.
136+ - ` ottrace ` : [ OT Trace] ( https://github.com/opentracing?q=basic&type=&language= )
137+ (_ third party_ )
138+ - ` none ` : No automatically configured propagator.
134139
135140## ` OTEL_TRACES_EXPORTER `
136141
137142Specifies which exporter is used for traces. Depending on the implementation it
138143may be a comma-separated list.
139144
140- ** Default value:** ` " otlp" `
145+ ** Default value:** ` otlp `
141146
142147** Example:**
143148
144149` export OTEL_TRACES_EXPORTER="jaeger" `
145150
146151Accepted values for are:
147152
148- - ` " otlp" ` : [ OTLP] [ ]
149- - ` " jaeger" ` : export in Jaeger data model
150- - ` " zipkin" ` : [ Zipkin] ( https://zipkin.io/zipkin-api/ )
151- - ` " console" ` : [ Standard Output] ( /docs/specs/otel/trace/sdk_exporters/stdout/ )
152- - ` " none" ` : No automatically configured exporter for traces.
153+ - ` otlp ` : [ OTLP] [ ]
154+ - ` jaeger ` : Export in Jaeger data model.
155+ - ` zipkin ` : [ Zipkin] ( https://zipkin.io/zipkin-api/ )
156+ - ` console ` : [ Standard Output] ( /docs/specs/otel/trace/sdk_exporters/stdout/ )
157+ - ` none ` : No automatically configured exporter for traces.
153158
154159## ` OTEL_METRICS_EXPORTER `
155160
156161Specifies which exporter is used for metrics. Depending on the implementation it
157162may be a comma-separated list.
158163
159- ** Default value:** ` " otlp" `
164+ ** Default value:** ` otlp `
160165
161166** Example:**
162167
163168` export OTEL_METRICS_EXPORTER="prometheus" `
164169
165170Accepted values for ` OTEL_METRICS_EXPORTER ` are:
166171
167- - ` " otlp" ` : [ OTLP] [ ]
168- - ` " prometheus" ` :
172+ - ` otlp ` : [ OTLP]
173+ - ` prometheus ` :
169174 [ Prometheus] ( https://github.com/prometheus/docs/blob/main/docs/instrumenting/exposition_formats.md )
170- - ` " console" ` : [ Standard Output] ( /docs/specs/otel/metrics/sdk_exporters/stdout/ )
171- - ` " none" ` : No automatically configured exporter for metrics.
175+ - ` console ` : [ Standard Output] ( /docs/specs/otel/metrics/sdk_exporters/stdout/ )
176+ - ` none ` : No automatically configured exporter for metrics.
172177
173178## ` OTEL_LOGS_EXPORTER `
174179
175180Specifies which exporter is used for logs. Depending on the implementation it
176181may be a comma-separated list.
177182
178- ** Default value:** ` " otlp" `
183+ ** Default value:** ` otlp `
179184
180185** Example:**
181186
182187` export OTEL_LOGS_EXPORTER="otlp" `
183188
184189Accepted values for ` OTEL_LOGS_EXPORTER ` are:
185190
186- - ` " otlp" ` : [ OTLP] [ ]
187- - ` " console" ` : [ Standard Output] ( /docs/specs/otel/logs/sdk_exporters/stdout/ )
188- - ` " none" ` : No automatically configured exporter for logs.
191+ - ` otlp ` : [ OTLP]
192+ - ` console ` : [ Standard Output] ( /docs/specs/otel/logs/sdk_exporters/stdout/ )
193+ - ` none ` : No automatically configured exporter for logs.
189194
190195[ otlp ] : /docs/specs/otlp/
0 commit comments