Update OpenTelemetry bootstrapping logic to use opentelemetry_log_traces flag instead of service_debug, and document the new configuration option. (#117)

Author: vrslev

README.md

@@ -378,7 +378,7 @@ Parameters description:
 
 ### [OpenTelemetry](https://opentelemetry.io/)
 
-To bootstrap OpenTelemetry, you must provide `opentelemetry_endpoint` or set `service_debug` to `True`. In debug mode traces are sent to the console.
+To bootstrap OpenTelemetry, you must provide `opentelemetry_endpoint` or set `opentelemetry_log_traces` to `True`.
 
 However, additional parameters can also be supplied if needed.
 
@@ -413,6 +413,7 @@ Parameters description:
 - `opentelemetry_container_name` - will be passed to the `Resource`.
 - `opentelemetry_instrumentors` - a list of extra instrumentors.
 - `opentelemetry_exclude_urls` - list of ignored urls.
+- `opentelemetry_log_traces` - traces will be logged to stdout.
 
 These settings are subsequently passed to [opentelemetry](https://opentelemetry.io/), finalizing your Opentelemetry integration.
 

microbootstrap/instruments/opentelemetry_instrument.py

@@ -66,6 +66,7 @@ class OpentelemetryConfig(BaseInstrumentConfig):
             for one_package_to_exclude in os.environ.get(OTEL_PYTHON_DISABLED_INSTRUMENTATIONS, "").split(",")
         ]
     )
+    opentelemetry_log_traces: bool = False
 
 
 @typing.runtime_checkable
@@ -138,7 +139,7 @@ def bootstrap(self) -> None:
         if self.instrument_config.pyroscope_endpoint and pyroscope:
             self.tracer_provider.add_span_processor(PyroscopeSpanProcessor())
 
-        if self.instrument_config.service_debug:
+        if self.instrument_config.opentelemetry_log_traces:
             self.tracer_provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter(formatter=_format_span)))
         if self.instrument_config.opentelemetry_endpoint:
             self.tracer_provider.add_span_processor(