robotframework-tracer 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

robotframework_tracer/attributes.py

@@ -43,18 +43,18 @@ class AttributeExtractor:
         }
         if data.source:
             attrs[RFAttributes.SUITE_SOURCE] = str(data.source)
-        
+
         # Extract suite metadata
-        if hasattr(data, 'metadata') and data.metadata:
+        if hasattr(data, "metadata") and data.metadata:
             for key, value in data.metadata.items():
                 attrs[f"{RFAttributes.SUITE_METADATA}.{key}"] = str(value)
-        
+
         # Add timing information
-        if hasattr(result, 'starttime') and result.starttime:
+        if hasattr(result, "starttime") and result.starttime:
             attrs[RFAttributes.START_TIME] = result.starttime
-        if hasattr(result, 'endtime') and result.endtime:
+        if hasattr(result, "endtime") and result.endtime:
             attrs[RFAttributes.END_TIME] = result.endtime
-            
+
         return attrs
 
     @staticmethod
@@ -66,25 +66,25 @@ class AttributeExtractor:
         }
         if data.tags:
             attrs[RFAttributes.TEST_TAGS] = list(data.tags)
-        
+
         # Add test template if available
-        if hasattr(data, 'template') and data.template:
+        if hasattr(data, "template") and data.template:
             attrs[RFAttributes.TEST_TEMPLATE] = str(data.template)
-        
+
         # Add test timeout if available
-        if hasattr(data, 'timeout') and data.timeout:
+        if hasattr(data, "timeout") and data.timeout:
             attrs[RFAttributes.TEST_TIMEOUT] = str(data.timeout)
-        
+
         # Add timing information
-        if hasattr(result, 'starttime') and result.starttime:
+        if hasattr(result, "starttime") and result.starttime:
             attrs[RFAttributes.START_TIME] = result.starttime
-        if hasattr(result, 'endtime') and result.endtime:
+        if hasattr(result, "endtime") and result.endtime:
             attrs[RFAttributes.END_TIME] = result.endtime
-        
+
         # Add message if available
-        if hasattr(result, 'message') and result.message:
+        if hasattr(result, "message") and result.message:
             attrs[RFAttributes.MESSAGE] = result.message
-            
+
         return attrs
 
     @staticmethod
@@ -95,11 +95,13 @@ class AttributeExtractor:
             RFAttributes.KEYWORD_TYPE: data.type,
         }
         # Try to get library name (may not always be available)
-        if hasattr(data, 'libname') and data.libname:
+        if hasattr(data, "libname") and data.libname:
             attrs[RFAttributes.KEYWORD_LIBRARY] = data.libname
-        elif hasattr(data, 'owner') and data.owner:
-            attrs[RFAttributes.KEYWORD_LIBRARY] = data.owner.name if hasattr(data.owner, 'name') else str(data.owner)
-        
+        elif hasattr(data, "owner") and data.owner:
+            attrs[RFAttributes.KEYWORD_LIBRARY] = (
+                data.owner.name if hasattr(data.owner, "name") else str(data.owner)
+            )
+
         if data.args:
             args_str = ", ".join(str(arg)[:max_arg_length] for arg in data.args[:10])
             if len(args_str) > max_arg_length:

robotframework_tracer/config.py

@@ -8,9 +8,7 @@ class TracerConfig:
         self.endpoint = self._get_config(
             "endpoint", kwargs, "OTEL_EXPORTER_OTLP_ENDPOINT", "http://localhost:4318/v1/traces"
         )
-        self.service_name = self._get_config(
-            "service_name", kwargs, "OTEL_SERVICE_NAME", "rf"
-        )
+        self.service_name = self._get_config("service_name", kwargs, "OTEL_SERVICE_NAME", "rf")
         self.protocol = self._get_config("protocol", kwargs, "RF_TRACER_PROTOCOL", "http")
         self.capture_arguments = self._get_bool_config(
             "capture_arguments", kwargs, "RF_TRACER_CAPTURE_ARGUMENTS", True

robotframework_tracer/listener.py

@@ -5,6 +5,7 @@ from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from opentelemetry.sdk.trace.sampling import TraceIdRatioBased, ParentBased
 from opentelemetry.semconv.resource import ResourceAttributes
+from opentelemetry.propagate import inject
 import platform
 import sys
 import robot
@@ -12,9 +13,20 @@ import robot
 from .config import TracerConfig
 from .span_builder import SpanBuilder
 
+# Try to import Robot Framework BuiltIn library for variable setting
+try:
+    from robot.libraries.BuiltIn import BuiltIn
+
+    BUILTIN_AVAILABLE = True
+except ImportError:
+    BUILTIN_AVAILABLE = False
+
 # Try to import gRPC exporter (optional dependency)
 try:
-    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter as GRPCExporter
+    from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
+        OTLPSpanExporter as GRPCExporter,
+    )
+
     GRPC_AVAILABLE = True
 except ImportError:
     GRPC_AVAILABLE = False
@@ -25,9 +37,19 @@ class TracingListener:
 
     ROBOT_LISTENER_API_VERSION = 3
 
-    def __init__(self, endpoint=None, service_name=None, protocol=None, 
-                 capture_arguments=None, max_arg_length=None, capture_logs=None, 
-                 sample_rate=None, span_prefix_style=None, log_level=None, max_log_length=None):
+    def __init__(
+        self,
+        endpoint=None,
+        service_name=None,
+        protocol=None,
+        capture_arguments=None,
+        max_arg_length=None,
+        capture_logs=None,
+        sample_rate=None,
+        span_prefix_style=None,
+        log_level=None,
+        max_log_length=None,
+    ):
         """Initialize the tracing listener.
 
         Args:
@@ -45,26 +67,26 @@ class TracingListener:
         # Build kwargs dict from provided arguments
         kwargs = {}
         if endpoint is not None:
-            kwargs['endpoint'] = endpoint
+            kwargs["endpoint"] = endpoint
         if service_name is not None:
-            kwargs['service_name'] = service_name
+            kwargs["service_name"] = service_name
         if protocol is not None:
-            kwargs['protocol'] = protocol
+            kwargs["protocol"] = protocol
         if capture_arguments is not None:
-            kwargs['capture_arguments'] = capture_arguments
+            kwargs["capture_arguments"] = capture_arguments
         if max_arg_length is not None:
-            kwargs['max_arg_length'] = max_arg_length
+            kwargs["max_arg_length"] = max_arg_length
         if capture_logs is not None:
-            kwargs['capture_logs'] = capture_logs
+            kwargs["capture_logs"] = capture_logs
         if sample_rate is not None:
-            kwargs['sample_rate'] = sample_rate
+            kwargs["sample_rate"] = sample_rate
         if span_prefix_style is not None:
-            kwargs['span_prefix_style'] = span_prefix_style
+            kwargs["span_prefix_style"] = span_prefix_style
         if log_level is not None:
-            kwargs['log_level'] = log_level
+            kwargs["log_level"] = log_level
         if max_log_length is not None:
-            kwargs['max_log_length'] = max_log_length
-            
+            kwargs["max_log_length"] = max_log_length
+
         self.config = TracerConfig(**kwargs)
 
         # Initialize OpenTelemetry with automatic resource detection
@@ -80,25 +102,27 @@ class TracingListener:
             ResourceAttributes.OS_VERSION: platform.release(),
         }
         resource = Resource.create(resource_attrs)
-        
+
         # Configure sampling only if sample_rate < 1.0
         if self.config.sample_rate < 1.0:
             sampler = ParentBased(root=TraceIdRatioBased(self.config.sample_rate))
             provider = TracerProvider(resource=resource, sampler=sampler)
         else:
             provider = TracerProvider(resource=resource)
-        
+
         # Select exporter based on protocol
         if self.config.protocol == "grpc":
             if not GRPC_AVAILABLE:
-                print("Warning: gRPC exporter not available. Install with: pip install opentelemetry-exporter-otlp-proto-grpc")
+                print(
+                    "Warning: gRPC exporter not available. Install with: pip install opentelemetry-exporter-otlp-proto-grpc"
+                )
                 print("Falling back to HTTP exporter")
                 exporter = HTTPExporter(endpoint=self.config.endpoint)
             else:
                 exporter = GRPCExporter(endpoint=self.config.endpoint)
         else:
             exporter = HTTPExporter(endpoint=self.config.endpoint)
-        
+
         processor = BatchSpanProcessor(exporter)
         provider.add_span_processor(processor)
         trace.set_tracer_provider(provider)
@@ -106,10 +130,56 @@ class TracingListener:
         self.tracer = trace.get_tracer(__name__)
         self.span_stack = []
 
+    def _set_trace_context_variables(self):
+        """Set Robot Framework variables with current trace context."""
+        if not BUILTIN_AVAILABLE:
+            return
+
+        try:
+            # Get current trace context
+            headers = {}
+            inject(headers)  # Injects traceparent, tracestate headers
+
+            # Get current span info
+            current_span = trace.get_current_span()
+            trace_id = None
+            span_id = None
+
+            if current_span.is_recording():
+                span_context = current_span.get_span_context()
+                trace_id = format(span_context.trace_id, "032x")
+                span_id = format(span_context.span_id, "016x")
+
+            # Set RF variables for different protocols
+            builtin = BuiltIn()
+
+            # HTTP headers (for REST APIs, web services)
+            builtin.set_test_variable("${TRACE_HEADERS}", headers)
+
+            # Individual trace components (for custom protocols like Diameter)
+            if trace_id:
+                builtin.set_test_variable("${TRACE_ID}", trace_id)
+            if span_id:
+                builtin.set_test_variable("${SPAN_ID}", span_id)
+
+            # W3C traceparent format (for manual header construction)
+            if headers.get("traceparent"):
+                builtin.set_test_variable("${TRACEPARENT}", headers["traceparent"])
+
+            # Tracestate (for vendor-specific data)
+            if headers.get("tracestate"):
+                builtin.set_test_variable("${TRACESTATE}", headers["tracestate"])
+
+        except Exception as e:
+            # Silently ignore errors to avoid breaking tests
+            pass
+
     def start_suite(self, data, result):
         """Create root span for suite."""
         try:
-            span = SpanBuilder.create_suite_span(self.tracer, data, result, self.config.span_prefix_style)
+            span = SpanBuilder.create_suite_span(
+                self.tracer, data, result, self.config.span_prefix_style
+            )
             self.span_stack.append(span)
         except Exception as e:
             print(f"TracingListener error in start_suite: {e}")
@@ -130,8 +200,15 @@ class TracingListener:
             parent_context = (
                 trace.set_span_in_context(self.span_stack[-1]) if self.span_stack else None
             )
-            span = SpanBuilder.create_test_span(self.tracer, data, result, parent_context, self.config.span_prefix_style)
+            span = SpanBuilder.create_test_span(
+                self.tracer, data, result, parent_context, self.config.span_prefix_style
+            )
             self.span_stack.append(span)
+
+            # Set trace context variables within the span context
+            with trace.use_span(span):
+                self._set_trace_context_variables()
+
         except Exception as e:
             print(f"TracingListener error in start_test: {e}")
 
@@ -157,10 +234,15 @@ class TracingListener:
                 trace.set_span_in_context(self.span_stack[-1]) if self.span_stack else None
             )
             span = SpanBuilder.create_keyword_span(
-                self.tracer, data, result, parent_context, self.config.max_arg_length, self.config.span_prefix_style
+                self.tracer,
+                data,
+                result,
+                parent_context,
+                self.config.max_arg_length,
+                self.config.span_prefix_style,
             )
             self.span_stack.append(span)
-            
+
             # Add event for setup/teardown start
             if data.type in ("SETUP", "TEARDOWN"):
                 span.add_event(f"{data.type.lower()}.start", {"keyword": data.name})
@@ -172,14 +254,13 @@ class TracingListener:
         try:
             if self.span_stack:
                 span = self.span_stack.pop()
-                
+
                 # Add event for setup/teardown end
                 if data.type in ("SETUP", "TEARDOWN"):
-                    span.add_event(f"{data.type.lower()}.end", {
-                        "keyword": data.name,
-                        "status": result.status
-                    })
-                
+                    span.add_event(
+                        f"{data.type.lower()}.end", {"keyword": data.name, "status": result.status}
+                    )
+
                 SpanBuilder.set_span_status(span, result)
                 if result.status == "FAIL":
                     SpanBuilder.add_error_event(span, result)
@@ -202,31 +283,31 @@ class TracingListener:
         try:
             if not self.config.capture_logs or not self.span_stack:
                 return
-            
+
             # Filter by log level
             log_levels = {"TRACE": 0, "DEBUG": 1, "INFO": 2, "WARN": 3, "ERROR": 4, "FAIL": 5}
             min_level = log_levels.get(self.config.log_level, 2)
             msg_level = log_levels.get(message.level, 2)
-            
+
             if msg_level < min_level:
                 return
-            
+
             # Get current span
             current_span = self.span_stack[-1]
-            
+
             # Limit message length
             log_text = message.message
             if len(log_text) > self.config.max_log_length:
-                log_text = log_text[:self.config.max_log_length] + "..."
-            
+                log_text = log_text[: self.config.max_log_length] + "..."
+
             # Add log as span event (convert timestamp to string)
             event_attrs = {
                 "message": log_text,
                 "level": message.level,
             }
-            if hasattr(message, 'timestamp') and message.timestamp:
+            if hasattr(message, "timestamp") and message.timestamp:
                 event_attrs["timestamp"] = str(message.timestamp)
-            
+
             current_span.add_event(f"log.{message.level.lower()}", event_attrs)
         except RecursionError:
             # Avoid infinite recursion if logging causes more logs

robotframework_tracer/span_builder.py

@@ -43,16 +43,16 @@ class SpanBuilder:
         """Create root span for test suite."""
         attrs = AttributeExtractor.from_suite(data, result)
         name = SpanBuilder._add_prefix(data.name, "SUITE", prefix_style)
-        
+
         # Create context with baggage
         ctx = baggage.set_baggage("rf.suite.id", result.id)
         ctx = baggage.set_baggage("rf.version", robot.version.get_version(), ctx)
-        
+
         # Add suite metadata to baggage (limit to avoid too much data)
-        if hasattr(data, 'metadata') and data.metadata:
+        if hasattr(data, "metadata") and data.metadata:
             for key, value in list(data.metadata.items())[:5]:  # Limit to 5 metadata items
                 ctx = baggage.set_baggage(f"rf.suite.metadata.{key}", str(value), ctx)
-        
+
         span = tracer.start_span(name, context=ctx, kind=trace.SpanKind.INTERNAL, attributes=attrs)
         return span
 
@@ -67,10 +67,12 @@ class SpanBuilder:
         return span
 
     @staticmethod
-    def create_keyword_span(tracer, data, result, parent_context, max_arg_length=200, prefix_style="none"):
+    def create_keyword_span(
+        tracer, data, result, parent_context, max_arg_length=200, prefix_style="none"
+    ):
         """Create child span for keyword."""
         attrs = AttributeExtractor.from_keyword(data, result, max_arg_length)
-        
+
         # Build keyword name with arguments (like RF test step line)
         kw_name = data.name
         if data.args:
@@ -80,16 +82,16 @@ class SpanBuilder:
             if len(args_str) > 100:
                 args_str = args_str[:100] + "..."
             kw_name = f"{data.name} {args_str}"
-        
+
         # Determine span type for prefix
         if data.type in ("SETUP", "TEARDOWN"):
             span_type = data.type
         else:
             span_type = "KEYWORD"
-        
+
         # Add prefix based on style
         kw_name = SpanBuilder._add_prefix(kw_name, span_type, prefix_style)
-        
+
         span = tracer.start_span(
             kw_name, context=parent_context, kind=trace.SpanKind.INTERNAL, attributes=attrs
         )
@@ -115,14 +117,14 @@ class SpanBuilder:
                 "message": result.message,
                 "rf.status": "FAIL",
             }
-            
+
             # Try to extract exception type if available
-            if hasattr(result, 'error') and result.error:
+            if hasattr(result, "error") and result.error:
                 event_attrs["exception.type"] = type(result.error).__name__
                 event_attrs["exception.message"] = str(result.error)
-            
+
             # Add timestamp
-            if hasattr(result, 'endtime') and result.endtime:
+            if hasattr(result, "endtime") and result.endtime:
                 event_attrs["timestamp"] = result.endtime
-            
+
             span.add_event("test.failed", event_attrs)

robotframework_tracer/version.py

@@ -1 +1 @@
-__version__ = "0.1.1"
+__version__ = "0.2.1"

{robotframework_tracer-0.1.0.dist-info → robotframework_tracer-0.2.1.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: robotframework-tracer
-Version: 0.1.0
+Version: 0.2.1
 Summary: OpenTelemetry distributed tracing for Robot Framework
 Author: Robot Framework Tracer Contributors
 License: Apache-2.0
-Project-URL: Homepage, https://github.com/yourusername/robotframework-tracer
-Project-URL: Documentation, https://github.com/yourusername/robotframework-tracer/blob/main/README.md
-Project-URL: Repository, https://github.com/yourusername/robotframework-tracer
-Project-URL: Issues, https://github.com/yourusername/robotframework-tracer/issues
+Project-URL: Homepage, https://github.com/tridentsx/robotframework-tracer
+Project-URL: Documentation, https://github.com/tridentsx/robotframework-tracer/blob/main/README.md
+Project-URL: Repository, https://github.com/tridentsx/robotframework-tracer
+Project-URL: Issues, https://github.com/tridentsx/robotframework-tracer/issues
 Keywords: robotframework,testing,tracing,opentelemetry,observability
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -49,6 +49,7 @@ This enables you to:
 - **Analyze performance** and identify slow keywords or tests
 - **Correlate tests with application traces** in distributed systems
 - **Monitor test execution** across CI/CD pipelines
+- **Propagate trace context** to your System Under Test (SUT)
 
 ![Robot Framework Trace Visualization](docs/robotframework-trace.jpg)
 
@@ -114,6 +115,33 @@ robot --listener robotframework_tracer.TracingListener tests/
 
 Open http://localhost:16686 in your browser to see your test traces in Jaeger UI.
 
+## Trace Context Propagation
+
+The tracer automatically makes trace context available as Robot Framework variables for propagating to your System Under Test:
+
+```robot
+*** Test Cases ***
+Test API With Distributed Tracing
+    # HTTP headers automatically include trace context
+    ${response}=    POST    http://my-sut/api
+    ...    json={"data": "test"}
+    ...    headers=${TRACE_HEADERS}
+    
+    # For custom protocols, use individual components
+    ${diameter_msg}=    Create Diameter Request
+    ...    trace_id=${TRACE_ID}
+    ...    span_id=${SPAN_ID}
+```
+
+**Available variables:**
+- `${TRACE_HEADERS}` - HTTP headers dictionary
+- `${TRACE_ID}` - 32-character hex trace ID  
+- `${SPAN_ID}` - 16-character hex span ID
+- `${TRACEPARENT}` - W3C traceparent header
+- `${TRACESTATE}` - W3C tracestate header
+
+See [docs/trace-propagation.md](docs/trace-propagation.md) for complete examples.
+
 ## Configuration
 
 ### Basic usage
@@ -236,7 +264,7 @@ Apache License 2.0 - See [docs/LICENSE](docs/LICENSE) for details.
 
 ## Status
 
-**Current Version:** v0.1.0  
-**Status:** Production-ready MVP
+**Current Version:** v0.2.0  
+**Status:** Production-ready with trace propagation
 
 Core functionality is complete and tested. See [docs/CHANGELOG.md](docs/CHANGELOG.md) for version history and [docs/IMPLEMENTATION_PLAN.md](docs/IMPLEMENTATION_PLAN.md) for the development roadmap.

robotframework_tracer-0.2.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+robotframework_tracer/__init__.py,sha256=cZh3xnNaYhRisrqqWH5Gdt4zsgpbh1mUALJiUtGNG8M,204
+robotframework_tracer/attributes.py,sha256=_pDHYBJs4QLrnR3Sms7_QyM9IGYHSjZekr-8fkAosBo,3806
+robotframework_tracer/config.py,sha256=4Dis_UlhSaXkO4ln2VeAMIyvFBy_BD3Og9lI9MWXpnA,2530
+robotframework_tracer/listener.py,sha256=WTrK7cNa5hfrru8BpPiu8GCQVzyITtctudFyNAdoPfA,11940
+robotframework_tracer/span_builder.py,sha256=BT6D-fnfwvjGhQihfrg0-BGcZ3EJnEN_bjaTwDHPIqg,4836
+robotframework_tracer/version.py,sha256=HfjVOrpTnmZ-xVFCYSVmX50EXaBQeJteUHG-PD6iQs8,22
+robotframework_tracer-0.2.1.dist-info/METADATA,sha256=_BlwNqM8YeoIGI3V_PuUImCyH3IetyndNXtSJm4yZjA,8617
+robotframework_tracer-0.2.1.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+robotframework_tracer-0.2.1.dist-info/top_level.txt,sha256=G1sMKH-8SM_CdJe0Wm6wa_rg1uo62jfhft_UfaxZ05I,22
+robotframework_tracer-0.2.1.dist-info/RECORD,,

robotframework_tracer-0.1.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-robotframework_tracer/__init__.py,sha256=cZh3xnNaYhRisrqqWH5Gdt4zsgpbh1mUALJiUtGNG8M,204
-robotframework_tracer/attributes.py,sha256=7lpqy-7maQma01tfG3TzUNLIseQPzARCuYPFiy1K3ao,3854
-robotframework_tracer/config.py,sha256=qCckfLNvwRUrJ8EolG47zJDmZG-9175V7_1gR4ypNZc,2552
-robotframework_tracer/listener.py,sha256=8FMv2BTFo3Q471dFVCoS0YfLrHkeBSPsH6EKG75ccqQ,9795
-robotframework_tracer/span_builder.py,sha256=NKo0AOS-ZxYY_Z6Oypfbg33CAt2EKt6016Vh8woDtfo,4914
-robotframework_tracer/version.py,sha256=rnObPjuBcEStqSO0S6gsdS_ot8ITOQjVj_-P1LUUYpg,22
-robotframework_tracer-0.1.0.dist-info/METADATA,sha256=C60xEMX1xrxLxefDlGggCCzbwd1Nbt_mJI5mXQdyLOY,7654
-robotframework_tracer-0.1.0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
-robotframework_tracer-0.1.0.dist-info/top_level.txt,sha256=G1sMKH-8SM_CdJe0Wm6wa_rg1uo62jfhft_UfaxZ05I,22
-robotframework_tracer-0.1.0.dist-info/RECORD,,