Add timeout millis param to export.

Author: DylanRussell

exporter/opentelemetry-exporter-otlp-proto-grpc/tests/test_otlp_trace_exporter.py

@@ -16,7 +16,7 @@
 
 import os
 from unittest import TestCase
-from unittest.mock import Mock, PropertyMock, patch, ANY
+from unittest.mock import ANY, Mock, PropertyMock, patch
 
 from grpc import ChannelCredentials, Compression
 

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

@@ -67,11 +67,14 @@ class LogExporter(abc.ABC):
     """
 
     @abc.abstractmethod
-    def export(self, batch: Sequence[LogData]):
+    def export(
+        self, batch: Sequence[LogData], timeout_millis: Optional[int] = None
+    ):
         """Exports a batch of logs.
 
         Args:
-            batch: The list of `LogData` objects to be exported
+            batch: The list of `LogData` objects to be exported.
+            timeout_millis: Optional milliseconds until Export should timeout if it hasn't succeded.
 
         Returns:
             The result of the export
@@ -84,6 +87,13 @@ def shutdown(self):
         Called when the SDK is shut down.
         """
 
+    @abc.abstractmethod
+    def force_flush(self, timeout_millis: int = 30000) -> bool:
+        """Hint to ensure that the export of any spans the exporter has received
+        prior to the call to ForceFlush SHOULD be completed as soon as possible, preferably
+        before returning from this method.
+        """
+
 
 class ConsoleLogExporter(LogExporter):
     """Implementation of :class:`LogExporter` that prints log records to the
@@ -102,6 +112,7 @@ def __init__(
         self.out = out
         self.formatter = formatter
 
+    # pylint: disable=arguments-differ
     def export(self, batch: Sequence[LogData]):
         for data in batch:
             self.out.write(self.formatter(data.log_record))

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

@@ -40,6 +40,7 @@ def get_finished_logs(self) -> typing.Tuple[LogData, ...]:
         with self._lock:
             return tuple(self._logs)
 
+    # pylint: disable=arguments-differ
     def export(self, batch: typing.Sequence[LogData]) -> LogExportResult:
         if self._stopped:
             return LogExportResult.FAILURE

opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 from __future__ import annotations
 
+import abc
 import collections
 import logging
 import os
@@ -56,7 +57,7 @@ class SpanExportResult(Enum):
     FAILURE = 1
 
 
-class SpanExporter:
+class SpanExporter(abc.ABC):
     """Interface for exporting spans.
 
     Interface to be implemented by services that want to export spans recorded
@@ -66,24 +67,30 @@ class SpanExporter:
     `SimpleSpanProcessor` or a `BatchSpanProcessor`.
     """
 
+    @abc.abstractmethod
     def export(
-        self, spans: typing.Sequence[ReadableSpan]
+        self,
+        spans: typing.Sequence[ReadableSpan],
+        timeout_millis: typing.Optional[int] = None,
     ) -> "SpanExportResult":
         """Exports a batch of telemetry data.
 
         Args:
             spans: The list of `opentelemetry.trace.Span` objects to be exported
+            timeout_millis: Optional milliseconds until Export should timeout if it hasn't succeded.
 
         Returns:
             The result of the export
         """
 
+    @abc.abstractmethod
     def shutdown(self) -> None:
         """Shuts down the exporter.
 
         Called when the SDK is shut down.
         """
 
+    @abc.abstractmethod
     def force_flush(self, timeout_millis: int = 30000) -> bool:
         """Hint to ensure that the export of any spans the exporter has received
         prior to the call to ForceFlush SHOULD be completed as soon as possible, preferably