Skip to content

Commit d9a8c70

Browse files
Manvi2402xrmx
andauthored
Fix BatchLogRecordProcessor default schedule_delay_millis to 1000ms per OTel spec (#4998)
* Fix BatchLogRecordProcessor default schedule_delay_millis to 1000ms per OTel spec * Update OTEL_BLRP_SCHEDULE_DELAY docstring default to 1000ms and fix CHANGELOG * Apply suggestion from @xrmx * Update CHANGELOG wording to 'may be' for export frequency * Apply suggestion from @xrmx --------- Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
1 parent bdb17b2 commit d9a8c70

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212

1313
## Unreleased
1414

15+
- Fix `BatchLogRecordProcessor` default `schedule_delay_millis` from 5000ms to 1000ms to comply with the OTel specification. Note: logs may be exported 5x more frequently by default (e.g. for users who don't explicitly set the `OTEL_BLRP_SCHEDULE_DELAY` env var).
16+
([#4998](https://github.com/open-telemetry/opentelemetry-python/pull/4998))
1517
- `opentelemetry-sdk`: Add `process` resource detector support to declarative file configuration via `detection_development.detectors[].process`
1618
([#5001](https://github.com/open-telemetry/opentelemetry-python/pull/5001))
1719
- `opentelemetry-sdk`: Add shared `_parse_headers` helper for declarative config OTLP exporters

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
OtelComponentTypeValues,
5353
)
5454

55-
_DEFAULT_SCHEDULE_DELAY_MILLIS = 5000
55+
_DEFAULT_SCHEDULE_DELAY_MILLIS = 1000
5656
_DEFAULT_MAX_EXPORT_BATCH_SIZE = 512
5757
_DEFAULT_EXPORT_TIMEOUT_MILLIS = 30000
5858
_DEFAULT_MAX_QUEUE_SIZE = 2048

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
.. envvar:: OTEL_BLRP_SCHEDULE_DELAY
8080
8181
The :envvar:`OTEL_BLRP_SCHEDULE_DELAY` represents the delay interval between two consecutive exports of the BatchLogRecordProcessor.
82-
Default: 5000
82+
Default: 1000
8383
"""
8484

8585
OTEL_BLRP_EXPORT_TIMEOUT = "OTEL_BLRP_EXPORT_TIMEOUT"

opentelemetry-sdk/tests/logs/test_export.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ def test_args_defaults(self):
582582
log_record_processor._batch_processor._max_queue_size, 2048
583583
)
584584
self.assertEqual(
585-
log_record_processor._batch_processor._schedule_delay, 5
585+
log_record_processor._batch_processor._schedule_delay, 1
586586
)
587587
self.assertEqual(
588588
log_record_processor._batch_processor._max_export_batch_size, 512
@@ -613,7 +613,7 @@ def test_args_env_var_value_error(self):
613613
log_record_processor._batch_processor._max_queue_size, 2048
614614
)
615615
self.assertEqual(
616-
log_record_processor._batch_processor._schedule_delay, 5
616+
log_record_processor._batch_processor._schedule_delay, 1
617617
)
618618
self.assertEqual(
619619
log_record_processor._batch_processor._max_export_batch_size, 512
@@ -639,7 +639,7 @@ def test_args_none_defaults(self):
639639
log_record_processor._batch_processor._max_queue_size, 2048
640640
)
641641
self.assertEqual(
642-
log_record_processor._batch_processor._schedule_delay, 5
642+
log_record_processor._batch_processor._schedule_delay, 1
643643
)
644644
self.assertEqual(
645645
log_record_processor._batch_processor._max_export_batch_size, 512

0 commit comments

Comments
 (0)