Skip to content

deep.api.plugin.otel

Provide plugin for Deep to connect to OTEL.

OTelPlugin

Bases: ResourceProvider, SnapshotDecorator, SpanProcessor

Deep Otel plugin.

Provide span and trace information to the snapshot.

Source code in deep/api/plugin/otel.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
class OTelPlugin(ResourceProvider, SnapshotDecorator, SpanProcessor):
    """
    Deep Otel plugin.

    Provide span and trace information to the snapshot.
    """

    def create_span(self, name: str, context_id: str, tracepoint_id: str) -> Optional['Span']:
        """
        Create and return a new span.

        :param name: the name of the span to create
        :param context_id: the id of the context
        :param tracepoint_id: the id of thr tracepoint
        :return: the created span
        """
        span = trace.get_tracer("deep").start_as_current_span(name,
                                                              end_on_exit=False,
                                                              attributes={'dynamic': 'deep',
                                                                          'context': context_id,
                                                                          "tracepoint": tracepoint_id
                                                                          },
                                                              )
        if span:
            # noinspection PyUnresolvedReferences
            # this is a generator contextlib._GeneratorContextManager
            current = span.__enter__()
            if isinstance(current, _Span):
                return _OtelSpan(current)
        return None

    def current_span(self) -> Optional['Span']:
        """
        Get the current span from the underlying provider.

        :return: the current span
        """
        span = self.__get_span()
        if span:
            return _OtelSpan(span)
        return None

    def resource(self) -> Optional[Resource]:
        """
        Provide resource.

        :return: the provided resource
        """
        provider = trace.get_tracer_provider()
        if isinstance(provider, TracerProvider):
            # noinspection PyUnresolvedReferences
            resource = provider.resource
            attributes = dict(resource.attributes)
            return Resource(attributes=attributes)
        return None

    def decorate(self, snapshot_id: str, context: ActionContext) -> Optional[BoundedAttributes]:
        """
        Decorate a snapshot with additional data.

        :param snapshot_id: the id of the collected snapshot
        :param context: the action context for this action

        :return: the additional attributes to attach
        """
        span = self.current_span()
        if span is not None:
            span.add_event(context.location_action.location.name,
                           attributes={"snapshot": snapshot_id,
                                       "tracepoint": context.location_action.id,
                                       "context": context.trigger_context.id})
            return BoundedAttributes(attributes={
                "span_name": span.name,
                "trace_id": span.trace_id,
                "span_id": span.span_id
            })
        return None

    @staticmethod
    def __get_span() -> Optional[_Span]:
        span = trace.get_current_span()
        if isinstance(span, _Span):
            return span
        return None

create_span(name, context_id, tracepoint_id)

Create and return a new span.

:param name: the name of the span to create :param context_id: the id of the context :param tracepoint_id: the id of thr tracepoint :return: the created span

Source code in deep/api/plugin/otel.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def create_span(self, name: str, context_id: str, tracepoint_id: str) -> Optional['Span']:
    """
    Create and return a new span.

    :param name: the name of the span to create
    :param context_id: the id of the context
    :param tracepoint_id: the id of thr tracepoint
    :return: the created span
    """
    span = trace.get_tracer("deep").start_as_current_span(name,
                                                          end_on_exit=False,
                                                          attributes={'dynamic': 'deep',
                                                                      'context': context_id,
                                                                      "tracepoint": tracepoint_id
                                                                      },
                                                          )
    if span:
        # noinspection PyUnresolvedReferences
        # this is a generator contextlib._GeneratorContextManager
        current = span.__enter__()
        if isinstance(current, _Span):
            return _OtelSpan(current)
    return None

current_span()

Get the current span from the underlying provider.

:return: the current span

Source code in deep/api/plugin/otel.py 
128
129
130
131
132
133
134
135
136
137
def current_span(self) -> Optional['Span']:
    """
    Get the current span from the underlying provider.

    :return: the current span
    """
    span = self.__get_span()
    if span:
        return _OtelSpan(span)
    return None

decorate(snapshot_id, context)

Decorate a snapshot with additional data.

:param snapshot_id: the id of the collected snapshot :param context: the action context for this action

:return: the additional attributes to attach

Source code in deep/api/plugin/otel.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def decorate(self, snapshot_id: str, context: ActionContext) -> Optional[BoundedAttributes]:
    """
    Decorate a snapshot with additional data.

    :param snapshot_id: the id of the collected snapshot
    :param context: the action context for this action

    :return: the additional attributes to attach
    """
    span = self.current_span()
    if span is not None:
        span.add_event(context.location_action.location.name,
                       attributes={"snapshot": snapshot_id,
                                   "tracepoint": context.location_action.id,
                                   "context": context.trigger_context.id})
        return BoundedAttributes(attributes={
            "span_name": span.name,
            "trace_id": span.trace_id,
            "span_id": span.span_id
        })
    return None

resource()

Provide resource.

:return: the provided resource

Source code in deep/api/plugin/otel.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
def resource(self) -> Optional[Resource]:
    """
    Provide resource.

    :return: the provided resource
    """
    provider = trace.get_tracer_provider()
    if isinstance(provider, TracerProvider):
        # noinspection PyUnresolvedReferences
        resource = provider.resource
        attributes = dict(resource.attributes)
        return Resource(attributes=attributes)
    return None