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

Add batch log record processor environment variable configs #2785

Merged
merged 9 commits into from
Sep 23, 2022
Merged

Add batch log record processor environment variable configs #2785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1d1ddfa
Add OTLP_BLRP_* environment variables
alanwest Sep 9, 2022
8e42a2e
s/BURP/BLRP excuse me :grimacing:
alanwest Sep 9, 2022
62b0b6b
Fix alignment
alanwest Sep 9, 2022
af5e993
Update changelog
alanwest Sep 9, 2022
3783316
Update feature matrix
alanwest Sep 9, 2022
aa2f2e5
Merge branch 'main' into alanwest/blrp
alanwest Sep 15, 2022
2da9809
Merge branch 'main' into alanwest/blrp
alanwest Sep 23, 2022
5564d23
Merge branch 'alanwest/blrp' of github.com:alanwest/opentelemetry-spe…
alanwest Sep 23, 2022
9780655
in milliseconds
alanwest Sep 23, 2022
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: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions spec-compliance-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_* | - | + | | + | + | - | - | - | - | + | - |
Expand Down
55 changes: 33 additions & 22 deletions specification/sdk-environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:

Expand All @@ -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 | <!-- markdown-link-check-disable --> "http://localhost:9411/api/v2/spans"<!-- markdown-link-check-enable --> |
| 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:
Expand Down