Sqlcommenter integration into SQLAlchemy

instrumentation/opentelemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/__init__.py

@@ -105,7 +105,7 @@ def _instrument(self, **kwargs):
         if kwargs.get("engine") is not None:
             return EngineTracer(
                 _get_tracer(kwargs.get("engine"), tracer_provider),
-                kwargs.get("engine"),
+                kwargs.get("engine"), kwargs.get("enable_commenter", False)
             )
         return None
 

instrumentation/opentelemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/engine.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 import os
 
+import opentelemetry.trace
 from sqlalchemy.event import listen  # pylint: disable=no-name-in-module
 
 from opentelemetry import trace
@@ -70,12 +71,13 @@ def _wrap_create_engine_internal(func, module, args, kwargs):
 
 
 class EngineTracer:
-    def __init__(self, tracer, engine):
+    def __init__(self, tracer, engine, enable_commenter):
         self.tracer = tracer
         self.engine = engine
         self.vendor = _normalize_vendor(engine.name)
+        self.enable_commenter = enable_commenter
 
-        listen(engine, "before_cursor_execute", self._before_cur_exec)
+        listen(engine, "before_cursor_execute", self._before_cur_exec, retval=True)
         listen(engine, "after_cursor_execute", _after_cur_exec)
         listen(engine, "handle_error", _handle_error)
 
@@ -115,6 +117,13 @@ def _before_cur_exec(
                     span.set_attribute(key, value)
 
         context._otel_span = span
+        if self.enable_commenter:
+            _version = '00'
+            _span_id = opentelemetry.trace.format_span_id(span.context.span_id)
+            _trace_id = opentelemetry.trace.format_trace_id(span.context.trace_id)
+            _flags = str(opentelemetry.trace.TraceFlags.SAMPLED)
+            statement = statement + "/*traceparent=" + _version + '-' + _trace_id + '-' + _span_id + '-' + _flags + "*/"
+        return statement, params
 
 
 # pylint: disable=unused-argument

instrumentation/opentelemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.28b1"
+__version__ = "0.28b2"