You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The main variables used to configure tracing in Pomerium are the following:
33
+
The following environment variables are supported in Pomerium:
34
34
35
35
| Name | Description | Type | Default |
36
36
| :-- | :-- | :-- | :-- |
37
-
|[`OTEL_TRACES_EXPORTER`](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#exporter-selection)| Trace exporter to be used. <br/> Valid values are `"otlp"` or `"none"`. |`string`|`"none"`|
38
-
|[`OTEL_EXPORTER_OTLP_ENDPOINT`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_endpoint) or <br/> [`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_traces_endpoint)| See [Endpoint Configuration](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#endpoint-configuration). |`string`||
39
-
|[`OTEL_EXPORTER_OTLP_PROTOCOL`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_protocol) or <br/> [`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_traces_protocol)| See [Protocol Configuration](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#protocol-configuration). <br/> Valid values are `"grpc"` or `"http/protobuf"`. <br/>If unset, Pomerium will attempt to determine the protocol based on the endpoint port number (the standard ports are 4317 for GRPC, 4318 for HTTP), otherwise it will default to `"http/protobuf"`. |`string`||
40
-
|[`OTEL_EXPORTER_OTLP_HEADERS`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_headers) or <br/> [`OTEL_EXPORTER_OTLP_TRACES_HEADERS`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_traces_headers)| See [Header Configuration](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#header-configuration). |`[]string`||
41
-
|[`OTEL_EXPORTER_OTLP_TIMEOUT`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_timeout) or <br/> [`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT`](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#otel_exporter_otlp_traces_timeout)| See [Timeout Configuration](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/#timeout-configuration). |`int64`|`10000` (ms) |
42
-
|[`OTEL_TRACES_SAMPLER_ARG`](https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_traces_sampler_arg)| Sampling probability, a number in the \[0..1\] range, e.g. `1.0` (sample all traces) or `0.25` (sample 25% of traces). |`float64`|`1.0`|
43
-
|[`OTEL_RESOURCE_ATTRIBUTES`](https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_resource_attributes)|Key-value pairs of additional resource attributes. |`[]string`||
44
-
|[`OTEL_BSP_SCHEDULE_DELAY`](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#batch-span-processor)| Interval in milliseconds at which pending spans (if any) are exported. Minimum 100 (ms). |`int32`|`5000` (ms) |
45
-
|[`OTEL_BSP_MAX_EXPORT_BATCH_SIZE`](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#batch-span-processor)| Number of pending spans needed to automatically trigger an export. Note that spans are still exported on a fixed interval, even if this limit is not reached. Minimum 1; maximum 2048. |`int32`|`512`|
|[`OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT`](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#attribute-limits)| Maximum allowed attribute value size. <br/> Increase this to prevent long URLs in span attributes from being truncated. |`int32`|`256`|
37
+
|[`OTEL_TRACES_EXPORTER`][env/otel_traces_exporter]| Trace exporter to be used. <br/> Valid values are `"otlp"` or `"none"`. |[Enum][topic/enum]|`"none"`|
38
+
|[`OTEL_EXPORTER_OTLP_ENDPOINT`][env/otel_exporter_otlp_endpoint] or <br/> [`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`][env/otel_exporter_otlp_traces_endpoint]| See [Endpoint Configuration][topic/exp-endpoint-cfg]. |[String][topic/string]||
39
+
|[`OTEL_EXPORTER_OTLP_PROTOCOL`][env/otel_exporter_otlp_protocol] or <br/> [`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL`][env/otel_exporter_otlp_traces_protocol]| See [Protocol Configuration][topic/exp-protocol-cfg]. <br/> Valid values are `"grpc"` or `"http/protobuf"`. <br/>If unset, Pomerium will attempt to determine the protocol based on the endpoint port number (the standard ports are 4317 for GRPC, 4318 for HTTP), otherwise it will default to `"http/protobuf"`. |[String][topic/string]||
40
+
|[`OTEL_EXPORTER_OTLP_HEADERS`][env/otel_exporter_otlp_headers] or <br/> [`OTEL_EXPORTER_OTLP_TRACES_HEADERS`][env/otel_exporter_otlp_traces_headers]|Comma-separated `key=value` pairs containing HTTP headers to add when exporting trace data. <br/>Example: <code>Authentication=Bearer xxx,Foo=Bar</code><br/>See [Header Configuration][topic/exp-header-cfg]. |[String][topic/string]||
41
+
|[`OTEL_EXPORTER_OTLP_TIMEOUT`][env/otel_exporter_otlp_timeout] or <br/> [`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT`][env/otel_exporter_otlp_traces_timeout]|Export request timeout duration in milliseconds.<br/> See [Timeout Configuration][topic/exp-timeout-cfg]. |[Duration][topic/duration]|`10000` (ms) |
42
+
|[`OTEL_TRACES_SAMPLER_ARG`][env/otel_traces_sampler_arg]| Sampling probability, a number in the \[0..1\] range.<br/> Examples: `1.0` (sample all traces), `0.25` (sample 25% of traces). |Float|`1.0`|
43
+
|[`OTEL_RESOURCE_ATTRIBUTES`][env/otel_resource_attributes]|Comma-separated `key=value` pairs of additional resource attributes. <br/> Example: `key1=value1,key2=value2`|[String][topic/string]||
44
+
|[`OTEL_BSP_SCHEDULE_DELAY`][env/otel_bsp_schedule_delay]| Interval in milliseconds at which pending spans (if any) are exported. Minimum 100 (ms). |[Duration][topic/duration]|`5000` (ms) |
45
+
|[`OTEL_BSP_MAX_EXPORT_BATCH_SIZE`][env/otel_bsp_max_export_batch_size]| Number of pending spans needed to automatically trigger an export. Note that spans are still exported on a fixed interval, even if this limit is not reached. Minimum 1.|[Integer][topic/integer]|`512`|
|[`OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT`][env/otel_attribute_value_length_limit]| Maximum allowed attribute value size. <br/> Increase this to prevent long URLs in span attributes from being truncated. |[Integer][topic/integer]|`256`|
48
48
49
49
### Config file
50
50
51
51
Tracing can also be configured using the Pomerium config file if desired. The field names in the config file are identical to the environment variable names, but in lowercase.
0 commit comments