Skip to content

opentelemetry-sdk: add validation for export_timeout_millis <= 0 #5693

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

Closed
dajiaohuang wants to merge 2 commits into from
Closed

opentelemetry-sdk: add validation for export_timeout_millis <= 0 #5693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15e3999
opentelemetry-sdk: add validation for export_timeout_millis <= 0
dajiaohuang Sep 25, 2026
5e025eb
Add changelog fragment
dajiaohuang Sep 25, 2026
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
1 change: 1 addition & 0 deletions .changelog/5693.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`opentelemetry-sdk`: add validation for export_timeout_millis <= 0 in BatchSpanProcessor, BatchLogRecordProcessor, and PeriodicExportingMetricReader
7 changes: 5 additions & 2 deletions opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ def __init__(
if export_timeout_millis is None:
export_timeout_millis = BatchLogRecordProcessor._default_export_timeout_millis()

BatchLogRecordProcessor._validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size)
BatchLogRecordProcessor._validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size, export_timeout_millis)
# Initializes BatchProcessor
self._batch_processor = BatchProcessor(
exporter,
Expand Down Expand Up @@ -378,7 +378,7 @@ def _default_export_timeout_millis():
return _DEFAULT_EXPORT_TIMEOUT_MILLIS

@staticmethod
def _validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size):
def _validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size, export_timeout_millis):
if max_queue_size <= 0:
raise ValueError("max_queue_size must be a positive integer.")

Expand All @@ -388,5 +388,8 @@ def _validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_
if max_export_batch_size <= 0:
raise ValueError("max_export_batch_size must be a positive integer.")

if export_timeout_millis <= 0:
raise ValueError("export_timeout_millis must be positive.")

if max_export_batch_size > max_queue_size:
raise ValueError("max_export_batch_size must be less than or equal to max_queue_size.")
17 changes: 11 additions & 6 deletions opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/export/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,17 @@ def __init__(
self._shutdown_event = Event()
self._shutdown_once = Once()
self._daemon_thread = None
if self._export_interval_millis > 0 and self._export_interval_millis < math.inf:
if self._export_interval_millis <= 0:
raise ValueError(
f"interval value {self._export_interval_millis} is invalid \
and needs to be larger than zero."
)
if self._export_timeout_millis <= 0:
raise ValueError(
f"timeout value {self._export_timeout_millis} is invalid \
and needs to be larger than zero."
)
if self._export_interval_millis < math.inf:
self._daemon_thread = Thread(
name="OtelPeriodicExportingMetricReader",
target=self._ticker,
Expand All @@ -475,11 +485,6 @@ def _after_in_child() -> None:
at_fork()

os.register_at_fork(after_in_child=_after_in_child)
elif self._export_interval_millis <= 0:
raise ValueError(
f"interval value {self._export_interval_millis} is invalid \
and needs to be larger than zero."
)

def _at_fork_reinit(self):
self._daemon_thread = Thread(
Expand Down
7 changes: 5 additions & 2 deletions opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ def __init__(
if export_timeout_millis is None:
export_timeout_millis = BatchSpanProcessor._default_export_timeout_millis()

BatchSpanProcessor._validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size)
BatchSpanProcessor._validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size, export_timeout_millis)

self._batch_processor = BatchProcessor(
span_exporter,
Expand Down Expand Up @@ -274,7 +274,7 @@ def _default_export_timeout_millis():
return _DEFAULT_EXPORT_TIMEOUT_MILLIS

@staticmethod
def _validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size):
def _validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_size, export_timeout_millis):
if max_queue_size <= 0:
raise ValueError("max_queue_size must be a positive integer.")

Expand All @@ -284,6 +284,9 @@ def _validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_
if max_export_batch_size <= 0:
raise ValueError("max_export_batch_size must be a positive integer.")

if export_timeout_millis <= 0:
raise ValueError("export_timeout_millis must be positive.")

if max_export_batch_size > max_queue_size:
raise ValueError("max_export_batch_size must be less than or equal to max_queue_size.")

Expand Down