Skip to content

fix(sdk): add validation for export_timeout_millis <= 0 in BatchSpanP… #5650

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

Open
Dotify71 wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −2
Open

fix(sdk): add validation for export_timeout_millis <= 0 in BatchSpanP… #5650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/5648.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
17 changes: 15 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,12 @@ 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 +279,12 @@ 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=None,
):
if max_queue_size <= 0:
raise ValueError("max_queue_size must be a positive integer.")

Expand All @@ -287,6 +297,9 @@ def _validate_arguments(max_queue_size, schedule_delay_millis, max_export_batch_
if max_export_batch_size > max_queue_size:
raise ValueError("max_export_batch_size must be less than or equal to max_queue_size.")

if export_timeout_millis is not None and export_timeout_millis <= 0:
raise ValueError("export_timeout_millis must be positive.")


class ConsoleSpanExporter(SpanExporter):
"""Implementation of :class:`SpanExporter` that prints spans to the
Expand Down
10 changes: 10 additions & 0 deletions opentelemetry-sdk/tests/trace/export/test_export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,16 @@ def test_args_env_var(self):
self.assertEqual(batch_span_processor._batch_processor._export_timeout_millis, 4)
batch_span_processor.shutdown()

def test_invalid_export_timeout_millis(self):
with self.assertRaises(ValueError):
export.BatchSpanProcessor(
MySpanExporter(destination=[]), export_timeout_millis=0
)
with self.assertRaises(ValueError):
export.BatchSpanProcessor(
MySpanExporter(destination=[]), export_timeout_millis=-500
)

def test_args_env_var_defaults(self):
batch_span_processor = export.BatchSpanProcessor(MySpanExporter(destination=[]))

Expand Down
Loading