diff --git a/CHANGELOG.md b/CHANGELOG.md index a285d2f7613..c449241dcf7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -91,6 +91,8 @@ release. ([#2768](https://github.com/open-telemetry/opentelemetry-specification/pull/2768)). - Add the signal-specific OTEL_EXPORTER_OTLP_LOGS_* environment variables ([#2782](https://github.com/open-telemetry/opentelemetry-specification/pull/2782)). +- Add environment variables for configuring the `BatchLogRecordProcessor`. + ([#2785](https://github.com/open-telemetry/opentelemetry-specification/pull/2785)) ### Resource diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md index 757d9c2ccb9..efc74d4488a 100644 --- a/spec-compliance-matrix.md +++ b/spec-compliance-matrix.md @@ -273,6 +273,7 @@ Note: Support for environment variables is optional. |OTEL_LOG_LEVEL | - | - | + | [-][py1059] | + | - | - | | - | - | - | |OTEL_PROPAGATORS | - | + | | + | + | + | - | - | - | - | - | |OTEL_BSP_* | + | + | | + | + | + | - | + | - | - | - | +|OTEL_BLRP_* | | | | | | | | | | | | |OTEL_EXPORTER_OTLP_* | + | + | | + | + | + | - | + | + | + | - | |OTEL_EXPORTER_JAEGER_* | + | + | | + | + | - | - | | - | + | - | |OTEL_EXPORTER_ZIPKIN_* | - | + | | + | + | - | - | - | - | + | - | diff --git a/specification/sdk-environment-variables.md b/specification/sdk-environment-variables.md index ac185d766c6..d1428d24f3d 100644 --- a/specification/sdk-environment-variables.md +++ b/specification/sdk-environment-variables.md @@ -92,12 +92,23 @@ Depending on the value of `OTEL_TRACES_SAMPLER`, `OTEL_TRACES_SAMPLER_ARG` may b **Status**: [Stable](document-status.md) -| Name | Description | Default | Notes | -| ------------------------------ | ---------------------------------------------- | ------- | ----------------------------------------------------- | -| OTEL_BSP_SCHEDULE_DELAY | Delay interval between two consecutive exports | 5000 | | -| OTEL_BSP_EXPORT_TIMEOUT | Maximum allowed time to export data | 30000 | | -| OTEL_BSP_MAX_QUEUE_SIZE | Maximum queue size | 2048 | | -| OTEL_BSP_MAX_EXPORT_BATCH_SIZE | Maximum batch size | 512 | Must be less than or equal to OTEL_BSP_MAX_QUEUE_SIZE | +| Name | Description | Default | Notes | +| ------------------------------ | ---------------------------------------------------------------- | ------- | ----------------------------------------------------- | +| OTEL_BSP_SCHEDULE_DELAY | Delay interval (in milliseconds) between two consecutive exports | 5000 | | +| OTEL_BSP_EXPORT_TIMEOUT | Maximum allowed time (in milliseconds) to export data | 30000 | | +| OTEL_BSP_MAX_QUEUE_SIZE | Maximum queue size | 2048 | | +| OTEL_BSP_MAX_EXPORT_BATCH_SIZE | Maximum batch size | 512 | Must be less than or equal to OTEL_BSP_MAX_QUEUE_SIZE | + +## Batch LogRecord Processor + +**Status**: [Experimental](document-status.md) + +| Name | Description | Default | Notes | +| ------------------------------- | ---------------------------------------------------------------- | ------- | ------------------------------------------------------ | +| OTEL_BLRP_SCHEDULE_DELAY | Delay interval (in milliseconds) between two consecutive exports | 5000 | | +| OTEL_BLRP_EXPORT_TIMEOUT | Maximum allowed time (in milliseconds) to export data | 30000 | | +| OTEL_BLRP_MAX_QUEUE_SIZE | Maximum queue size | 2048 | | +| OTEL_BLRP_MAX_EXPORT_BATCH_SIZE | Maximum batch size | 512 | Must be less than or equal to OTEL_BLRP_MAX_QUEUE_SIZE | ## Attribute Limits @@ -153,21 +164,21 @@ SDKs have good reasons to choose other as the default Environment variables specific for the `http/thrift.binary` transport protocol: -| Name | Description | Default | -|-------------------------------|------------------------------------------------------------------|-------------------------------------| -| OTEL_EXPORTER_JAEGER_ENDPOINT | Full URL of the [Jaeger HTTP endpoint][jaeger_collector] | `http://localhost:14268/api/traces` | -| OTEL_EXPORTER_JAEGER_TIMEOUT | Maximum time the Jaeger exporter will wait for each batch export | 10s | -| OTEL_EXPORTER_JAEGER_USER | Username to be used for HTTP basic authentication | | -| OTEL_EXPORTER_JAEGER_PASSWORD | Password to be used for HTTP basic authentication | | +| Name | Description | Default | +|-------------------------------|------------------------------------------------------------------------------------|-------------------------------------| +| OTEL_EXPORTER_JAEGER_ENDPOINT | Full URL of the [Jaeger HTTP endpoint][jaeger_collector] | `http://localhost:14268/api/traces` | +| OTEL_EXPORTER_JAEGER_TIMEOUT | Maximum time (in milliseconds) the Jaeger exporter will wait for each batch export | 10000 | +| OTEL_EXPORTER_JAEGER_USER | Username to be used for HTTP basic authentication | | +| OTEL_EXPORTER_JAEGER_PASSWORD | Password to be used for HTTP basic authentication | | Environment variables specific for the `grpc` transport protocol: -| Name | Description | Default | -|-------------------------------|------------------------------------------------------------------|--------------------------| -| OTEL_EXPORTER_JAEGER_ENDPOINT | URL of the [Jaeger gRPC endpoint][jaeger_collector] | `http://localhost:14250` | -| OTEL_EXPORTER_JAEGER_TIMEOUT | Maximum time the Jaeger exporter will wait for each batch export | 10s | -| OTEL_EXPORTER_JAEGER_USER | Username to be used for HTTP basic authentication | | -| OTEL_EXPORTER_JAEGER_PASSWORD | Password to be used for HTTP basic authentication | | +| Name | Description | Default | +|-------------------------------|------------------------------------------------------------------------------------|--------------------------| +| OTEL_EXPORTER_JAEGER_ENDPOINT | URL of the [Jaeger gRPC endpoint][jaeger_collector] | `http://localhost:14250` | +| OTEL_EXPORTER_JAEGER_TIMEOUT | Maximum time (in milliseconds) the Jaeger exporter will wait for each batch export | 10000 | +| OTEL_EXPORTER_JAEGER_USER | Username to be used for HTTP basic authentication | | +| OTEL_EXPORTER_JAEGER_PASSWORD | Password to be used for HTTP basic authentication | | Environment variables specific for the `udp/thrift.compact` transport protocol: @@ -190,10 +201,10 @@ Environment variables specific for the `udp/thrift.binary` transport protocol: **Status**: [Stable](document-status.md) -| Name | Description | Default | -| ----------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------ | -| OTEL_EXPORTER_ZIPKIN_ENDPOINT | Endpoint for Zipkin traces | "http://localhost:9411/api/v2/spans" | -| OTEL_EXPORTER_ZIPKIN_TIMEOUT | Maximum time the Zipkin exporter will wait for each batch export | 10s | +| Name | Description | Default | +| ----------------------------- | ---------------------------------------------------------------------------------- |------------------------------------- | +| OTEL_EXPORTER_ZIPKIN_ENDPOINT | Endpoint for Zipkin traces | `http://localhost:9411/api/v2/spans` | +| OTEL_EXPORTER_ZIPKIN_TIMEOUT | Maximum time (in milliseconds) the Zipkin exporter will wait for each batch export | 10000 | Additionally, the following environment variables are reserved for future usage in Zipkin Exporter configuration: