ferruzzi commented on code in PR #37948: URL: https://github.com/apache/airflow/pull/37948#discussion_r1518275660
########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" Review Comment: ```suggestion """Start a span; if service_name is not given, otel_service is used.""" ``` ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" + if component is None: + component = self.otel_service + + trace_id = self.get_current_span().get_span_context().trace_id + if span_id is not None: Review Comment: Pretty sure you can simplify all these "if foo is not None:" statements to just "if foo:" ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" + if component is None: + component = self.otel_service Review Comment: Why not default this in the signature? ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): Review Comment: Your class getters might maybe be a little easier in use if you use the @property decorator instead of making them helper methods? Maybe? ``` @property def current_span(self): return trace.get_current_span() ``` If you did this with all your helpers then `self.get_current_span().get_span_context().trace_id` turns into `self.current_span.span_context().trace_id` Feel free to ignore this on though. Up to you. ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" + if component is None: + component = self.otel_service + + trace_id = self.get_current_span().get_span_context().trace_id + if span_id is not None: + tracer = self.get_tracer_with_id(component=component, trace_id=trace_id, span_id=span_id) + else: + tracer = self.get_tracer(component) + + kvs = {} + if self.tags is not None: + kvs = parse_tracestate(self.tags) + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + if start_time is not None: + start_time = int(start_time.timestamp() * 1000000000) + + if parent_sc is not None: + ctx = trace.set_span_in_context(NonRecordingSpan(parent_sc)) + span = tracer.start_as_current_span( + span_name, context=ctx, attributes=kvs, links=_links, start_time=start_time + ) + else: + span = tracer.start_as_current_span( + span_name, attributes=kvs, links=_links, start_time=start_time + ) + return span + + def start_span_from_dagrun( + self, dagrun, span_name: str | None = None, component: str = "dagrun", links=None + ): + """Produce a span from dag run.""" + # check if dagrun has configs + conf = dagrun.conf + trace_id = int(gen_trace_id(dag_run=dagrun), 16) + span_id = int(gen_dag_span_id(dag_run=dagrun), 16) + + if conf is not None: + traceparent = conf.get(TRACEPARENT) + tracestate = conf.get(TRACESTATE) + + tracer = self.get_tracer_with_id(component=component, span_id=span_id, trace_id=trace_id) + + kvstr = None Review Comment: Maybe rename `kvstr` to `tag_string` or something more explicit? ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( Review Comment: Seems like get_tracer and get_tracer_with_id are so similar they might be one method? Maybe not though. Seems like the only real difference is whether there is an id_generator passed into TracerProvider, so it may work as one method if you just add something like ``` if trace_id or span_id: id_generator = AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) else: id_generator = None tracer_provider = TracerProvider(resource=resource, id_generator=id_generator) ``` ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" + if component is None: + component = self.otel_service + + trace_id = self.get_current_span().get_span_context().trace_id + if span_id is not None: + tracer = self.get_tracer_with_id(component=component, trace_id=trace_id, span_id=span_id) + else: + tracer = self.get_tracer(component) + + kvs = {} + if self.tags is not None: + kvs = parse_tracestate(self.tags) Review Comment: Alternatively, these are simple ternaries and could either be written as: ```kvs = parse_tracestate(self.tags) if self.tags else {}``` or ```kvs = {} if self.tags is None else parse_tracestate(self.tags)``` ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any Review Comment: ```suggestion Tracer will produce a Single ID value if value is provided. Note that this is one-time only, so any ``` ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" + if component is None: + component = self.otel_service + + trace_id = self.get_current_span().get_span_context().trace_id + if span_id is not None: + tracer = self.get_tracer_with_id(component=component, trace_id=trace_id, span_id=span_id) + else: + tracer = self.get_tracer(component) + + kvs = {} + if self.tags is not None: + kvs = parse_tracestate(self.tags) + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + if start_time is not None: + start_time = int(start_time.timestamp() * 1000000000) + + if parent_sc is not None: + ctx = trace.set_span_in_context(NonRecordingSpan(parent_sc)) + span = tracer.start_as_current_span( + span_name, context=ctx, attributes=kvs, links=_links, start_time=start_time + ) + else: + span = tracer.start_as_current_span( + span_name, attributes=kvs, links=_links, start_time=start_time + ) + return span + + def start_span_from_dagrun( + self, dagrun, span_name: str | None = None, component: str = "dagrun", links=None + ): + """Produce a span from dag run.""" + # check if dagrun has configs + conf = dagrun.conf + trace_id = int(gen_trace_id(dag_run=dagrun), 16) + span_id = int(gen_dag_span_id(dag_run=dagrun), 16) + + if conf is not None: + traceparent = conf.get(TRACEPARENT) + tracestate = conf.get(TRACESTATE) + + tracer = self.get_tracer_with_id(component=component, span_id=span_id, trace_id=trace_id) + + kvstr = None + # merge attributes from tags and tracestate + if self.tags is not None: + kvstr = self.tags + if tracestate is not None: + if kvstr is None: + kvstr = tracestate + else: + kvstr = kvstr + "," + tracestate + kvs = parse_tracestate(kvstr) + + if span_name is None: + span_name = dagrun.dag_id + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + a_link = Link( + context=trace.get_current_span().get_span_context(), + attributes={"meta.annotation_type": "link", "from": "parenttrace"}, + ) + _links.append(a_link) Review Comment: I'd just combine this, I don't see a reason to expand this ```suggestion _links.append( Link( context=trace.get_current_span().get_span_context(), attributes={"meta.annotation_type": "link", "from": "parenttrace"}, ) ) ``` ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" + if component is None: + component = self.otel_service + + trace_id = self.get_current_span().get_span_context().trace_id + if span_id is not None: + tracer = self.get_tracer_with_id(component=component, trace_id=trace_id, span_id=span_id) + else: + tracer = self.get_tracer(component) + + kvs = {} + if self.tags is not None: + kvs = parse_tracestate(self.tags) + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + if start_time is not None: + start_time = int(start_time.timestamp() * 1000000000) + + if parent_sc is not None: + ctx = trace.set_span_in_context(NonRecordingSpan(parent_sc)) + span = tracer.start_as_current_span( + span_name, context=ctx, attributes=kvs, links=_links, start_time=start_time + ) + else: + span = tracer.start_as_current_span( + span_name, attributes=kvs, links=_links, start_time=start_time + ) + return span + + def start_span_from_dagrun( + self, dagrun, span_name: str | None = None, component: str = "dagrun", links=None + ): + """Produce a span from dag run.""" + # check if dagrun has configs + conf = dagrun.conf + trace_id = int(gen_trace_id(dag_run=dagrun), 16) + span_id = int(gen_dag_span_id(dag_run=dagrun), 16) + + if conf is not None: + traceparent = conf.get(TRACEPARENT) + tracestate = conf.get(TRACESTATE) + + tracer = self.get_tracer_with_id(component=component, span_id=span_id, trace_id=trace_id) + + kvstr = None + # merge attributes from tags and tracestate + if self.tags is not None: + kvstr = self.tags + if tracestate is not None: + if kvstr is None: + kvstr = tracestate + else: + kvstr = kvstr + "," + tracestate + kvs = parse_tracestate(kvstr) + + if span_name is None: + span_name = dagrun.dag_id + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + a_link = Link( + context=trace.get_current_span().get_span_context(), + attributes={"meta.annotation_type": "link", "from": "parenttrace"}, + ) + _links.append(a_link) + + if traceparent is not None: + # add the trace parent as linkages + tp_link = gen_link_from_traceparent(traceparent) + _links.append(tp_link) Review Comment: Similar: ```suggestion if traceparent: _links.append(gen_link_from_traceparent(traceparent)) ``` ########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,333 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import logging +import random + +from opentelemetry import trace +from opentelemetry.context import create_key +from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter +from opentelemetry.sdk.resources import HOST_NAME, SERVICE_NAME, Resource +from opentelemetry.sdk.trace import Span, Tracer as OpenTelemetryTracer, TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter +from opentelemetry.sdk.trace.id_generator import IdGenerator +from opentelemetry.trace import Link, NonRecordingSpan, SpanContext, TraceFlags, Tracer +from opentelemetry.trace.span import INVALID_SPAN_ID, INVALID_TRACE_ID + +from airflow.configuration import conf +from airflow.traces import ( + TRACEPARENT, + TRACESTATE, +) +from airflow.traces.utils import ( + gen_dag_span_id, + gen_span_id, + gen_trace_id, + parse_traceparent, + parse_tracestate, +) +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + OpenTelemetry Tracing Class. + + Handles all tracing requirements such as getting the tracer, and starting a new span. + When OTEL is enabled, the Trace class will be replaced by this class. + """ + + def __init__(self, span_exporter: ConsoleSpanExporter | OTLPSpanExporter, tags=None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tags = tags + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer(self, component: str) -> OpenTelemetryTracer | Tracer: + """Get tracer from a given component.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider(resource=resource) + # span_processor = BatchSpanProcessor(self.span_exporter) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + return tracer + + def get_tracer_with_id( + self, component: str, trace_id: int | None = None, span_id: int | None = None + ) -> OpenTelemetryTracer | Tracer: + """Tracer that will use special AirflowOtelIdGenerator to control producing certain span and trace id.""" + resource = Resource(attributes={HOST_NAME: get_hostname(), SERVICE_NAME: self.otel_service}) + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + # span_processor = BatchSpanProcessor(self.span_exporter, schedule_delay_millis=1) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will product a Single ID value if value is provided. Note that this is one-time only, so any + subsequent call will produce the normal random ids. + """ + return tracer + + def get_current_span(self): + return trace.get_current_span() + + def use_span(self, span: Span): + return trace.use_span(span=span) + + def start_span( + self, + span_name: str, + component: str | None = None, + parent_sc: SpanContext | None = None, + span_id=None, + links=None, + start_time=None, + ): + """Start a span. if service_name is not given, otel_service is used.""" + if component is None: + component = self.otel_service + + trace_id = self.get_current_span().get_span_context().trace_id + if span_id is not None: + tracer = self.get_tracer_with_id(component=component, trace_id=trace_id, span_id=span_id) + else: + tracer = self.get_tracer(component) + + kvs = {} + if self.tags is not None: + kvs = parse_tracestate(self.tags) + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + if start_time is not None: + start_time = int(start_time.timestamp() * 1000000000) + + if parent_sc is not None: + ctx = trace.set_span_in_context(NonRecordingSpan(parent_sc)) + span = tracer.start_as_current_span( + span_name, context=ctx, attributes=kvs, links=_links, start_time=start_time + ) + else: + span = tracer.start_as_current_span( + span_name, attributes=kvs, links=_links, start_time=start_time + ) + return span + + def start_span_from_dagrun( + self, dagrun, span_name: str | None = None, component: str = "dagrun", links=None + ): + """Produce a span from dag run.""" + # check if dagrun has configs + conf = dagrun.conf + trace_id = int(gen_trace_id(dag_run=dagrun), 16) + span_id = int(gen_dag_span_id(dag_run=dagrun), 16) + + if conf is not None: + traceparent = conf.get(TRACEPARENT) + tracestate = conf.get(TRACESTATE) + + tracer = self.get_tracer_with_id(component=component, span_id=span_id, trace_id=trace_id) + + kvstr = None + # merge attributes from tags and tracestate + if self.tags is not None: + kvstr = self.tags + if tracestate is not None: + if kvstr is None: + kvstr = tracestate + else: + kvstr = kvstr + "," + tracestate + kvs = parse_tracestate(kvstr) + + if span_name is None: + span_name = dagrun.dag_id + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + a_link = Link( + context=trace.get_current_span().get_span_context(), + attributes={"meta.annotation_type": "link", "from": "parenttrace"}, + ) + _links.append(a_link) + + if traceparent is not None: + # add the trace parent as linkages + tp_link = gen_link_from_traceparent(traceparent) + _links.append(tp_link) + + span_ctx = SpanContext( + trace_id=INVALID_TRACE_ID, span_id=INVALID_SPAN_ID, is_remote=True, trace_flags=TraceFlags(0x01) + ) + ctx = trace.set_span_in_context(NonRecordingSpan(span_ctx)) + span = tracer.start_as_current_span( + name=span_name, + context=ctx, + links=_links, + start_time=int(dagrun.queued_at.timestamp() * 1000000000), + attributes=kvs, + ) + return span + + def start_span_from_taskinstance( + self, + ti, + span_name: str | None = None, + component: str = "taskinstance", + child: bool = False, + links=None, + ): + """ + Create and start span from given task instance. + + Essentially the span represents the ti itself if child == True, it will create a 'child' span under the given span. + """ + dagrun = ti.dag_run + trace_id = int(gen_trace_id(dag_run=dagrun), 16) + span_id = int(gen_span_id(ti=ti), 16) + if span_name is None: + span_name = ti.task_id + + if child is False: + parent_id = int(gen_dag_span_id(dag_run=dagrun), 16) + else: + parent_id = span_id + + span_ctx = SpanContext( + trace_id=trace_id, span_id=parent_id, is_remote=True, trace_flags=TraceFlags(0x01) + ) + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + a_link = Link( + context=trace.get_current_span().get_span_context(), + attributes={"meta.annotation_type": "link", "from": "parenttrace"}, + ) + _links.append(a_link) + + if child is False: + tracer = self.get_tracer_with_id(component=component, span_id=span_id, trace_id=trace_id) + else: + tracer = self.get_tracer(component=component) + + ctx = trace.set_span_in_context(NonRecordingSpan(span_ctx)) + span = tracer.start_as_current_span( + name=span_name, context=ctx, start_time=int(ti.queued_dttm.timestamp() * 1000000000), links=_links + ) + return span + + +def gen_context(trace_id: int, span_id: int): + """Generate a remote span context for given trace and span id.""" + span_ctx = SpanContext(trace_id=trace_id, span_id=span_id, is_remote=True, trace_flags=TraceFlags(0x01)) + return span_ctx + + +def gen_links_from_kv_list(kv_list): + """Convert list of kv dic of trace_id and span_id and generate list of SpanContext.""" + result = [] + for a in kv_list: + trace_id = a["trace_id"] # string of hexa + span_id = a["span_id"] # string of hexa + span_ctx = gen_context(trace_id, span_id) + a_link = Link( + context=span_ctx, + attributes={"meta.annotation_type": "link"}, + ) + result.append(a_link) + return result + + +def gen_link_from_traceparent(traceparent: str): + """Generate Link object from provided traceparent string.""" + if traceparent is not None: + trace_ctx = parse_traceparent(traceparent) + trace_id = trace_ctx["trace_id"] + span_id = trace_ctx["parent_id"] + span_ctx = gen_context(int(trace_id, 16), int(span_id, 16)) + a_link = Link(context=span_ctx, attributes={"meta.annotation_type": "link", "from": "traceparent"}) + return a_link + return None Review Comment: This may be a personal preference thing, but I was taught to put your escape hatch early, so this method would be: ```suggestion def gen_link_from_traceparent(traceparent: str): """Generate Link object from provided traceparent string.""" if traceparent is None: return None trace_ctx = parse_traceparent(traceparent) trace_id = trace_ctx["trace_id"] span_id = trace_ctx["parent_id"] span_ctx = gen_context(int(trace_id, 16), int(span_id, 16)) return Link(context=span_ctx, attributes={"meta.annotation_type": "link", "from": "traceparent"}) ``` instead of indenting the whole method -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
