sdk: shut down span processors automatically

examples/trace/client.py

@@ -39,4 +39,3 @@
 tracer.add_span_processor(span_processor)
 
 response = requests.get(url="http://127.0.0.1:5000/")
-span_processor.shutdown()

examples/trace/server.py

@@ -52,4 +52,3 @@ def hello():
 
 if __name__ == "__main__":
     app.run(debug=True)
-    span_processor.shutdown()

ext/opentelemetry-ext-azure-monitor/examples/client.py

@@ -27,4 +27,3 @@
 tracer.add_span_processor(span_processor)
 
 response = requests.get(url="http://127.0.0.1:5000/")
-span_processor.shutdown()

ext/opentelemetry-ext-azure-monitor/examples/server.py

@@ -41,4 +41,3 @@ def hello():
 
 if __name__ == "__main__":
     app.run(debug=True)
-    span_processor.shutdown()

ext/opentelemetry-ext-jaeger/README.rst

@@ -54,10 +54,6 @@ gRPC is still not supported by this implementation.
     with tracer.start_as_current_span('foo'):
         print('Hello world!')
 
-    # shutdown the span processor
-    # TODO: this has to be improved so user doesn't need to call it manually
-    span_processor.shutdown()
-
 The `examples <./examples>`_ folder contains more elaborated examples.
 
 References

ext/opentelemetry-ext-jaeger/examples/jaeger_exporter_example.py

@@ -45,7 +45,3 @@
         time.sleep(0.2)
 
     time.sleep(0.1)
-
-# shutdown the span processor
-# TODO: this has to be improved so user doesn't need to call it manually
-span_processor.shutdown()

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

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 
+import atexit
 import logging
 import random
 import threading
@@ -320,19 +321,24 @@ class Tracer(trace_api.Tracer):
 
     Args:
         name: The name of the tracer.
+        shutdown_on_exit: Register an atexit hook to shutdown the tracer when
+        the application exits.
     """
 
     def __init__(
         self,
         name: str = "",
         sampler: sampling.Sampler = trace_api.sampling.ALWAYS_ON,
+        shutdown_on_exit: bool = True,
     ) -> None:
         slot_name = "current_span"
         if name:
             slot_name = "{}.current_span".format(name)
         self._current_span_slot = Context.register_slot(slot_name)
         self._active_span_processor = MultiSpanProcessor()
         self.sampler = sampler
+        if shutdown_on_exit:
+            self._atexit_handler = atexit.register(self.shutdown)
 
     def get_current_span(self):
         """See `opentelemetry.trace.Tracer.get_current_span`."""
@@ -454,5 +460,11 @@ def add_span_processor(self, span_processor: SpanProcessor) -> None:
         # thread safe
         self._active_span_processor.add_span_processor(span_processor)
 
+    def shutdown(self):
+        """Shutdown the span processors added to the tracer."""
+        self._active_span_processor.shutdown()
+        if hasattr(self, "_atexit_handler"):
+            atexit.unregister(self._atexit_handler)
+
 
 tracer = Tracer()