ferruzzi commented on code in PR #37948: URL: https://github.com/apache/airflow/pull/37948#discussion_r1526555009
########## airflow/traces/otel_tracer.py: ########## @@ -0,0 +1,316 @@ +# +# 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.dates import datetime_to_nano +from airflow.utils.net import get_hostname + +log = logging.getLogger(__name__) + +_NEXT_ID = create_key("next_id") + + +class OtelTrace: + """ + Handle 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, tag_string: str | None = None): + self.span_exporter = span_exporter + self.span_processor = BatchSpanProcessor(self.span_exporter) + self.tag_string = tag_string + self.otel_service = conf.get("traces", "otel_service") + + def get_tracer( + 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}) + if trace_id or span_id: + # in case where trace_id or span_id was given + tracer_provider = TracerProvider( + resource=resource, id_generator=AirflowOtelIdGenerator(span_id=span_id, trace_id=trace_id) + ) + else: + tracer_provider = TracerProvider(resource=resource) + tracer_provider.add_span_processor(self.span_processor) + tracer = tracer_provider.get_tracer(component) + """ + Tracer will produce 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 + tracer = self.get_tracer(component=component, trace_id=trace_id, span_id=span_id) + + attributes = parse_tracestate(self.tag_string) if self.tag_string else {} + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + if start_time is not None: + start_time = datetime_to_nano(start_time) + + 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=attributes, links=_links, start_time=start_time + ) + else: + span = tracer.start_as_current_span( + span_name, attributes=attributes, 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, as_int=True)) + span_id = int(gen_dag_span_id(dag_run=dagrun, as_int=True)) + + if conf is not None: + traceparent = conf.get(TRACEPARENT) + tracestate = conf.get(TRACESTATE) + + tracer = self.get_tracer(component=component, span_id=span_id, trace_id=trace_id) + + if self.tag_string and tracestate: + tag_string = self.tag_string + "," + tracestate + else: + tag_string = self.tag_string or tracestate + + if span_name is None: + span_name = dagrun.dag_id + + if links is not None: + _links = gen_links_from_kv_list(links) + else: + _links = [] + + _links.append( + Link( + context=trace.get_current_span().get_span_context(), + attributes={"meta.annotation_type": "link", "from": "parenttrace"}, + ) + ) + + if traceparent is not None: + # add the trace parent as the link + _links.append(gen_link_from_traceparent(traceparent)) + + 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=datetime_to_nano(dagrun.queued_at), + attributes=parse_tracestate(tag_string), + ) + 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, as_int=True)) + span_id = int(gen_span_id(ti=ti, as_int=True)) Review Comment: Right. So even though we are casting it to an int before returning, the typechecking sees the return hints and thinks it could be either one. hmmmmmmmmmm Leave this comment open for me, I'll see if I can get some clever ideas over the weekend. -- 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]
