summaryrefslogtreecommitdiff
path: root/lib/gitlab/tracing/common.rb
blob: 3a08ede8138f7c75a454d3704bb6cbd4fcd7b5cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# frozen_string_literal: true

require 'opentracing'

module Gitlab
  module Tracing
    module Common
      def tracer
        OpenTracing.global_tracer
      end

      # Convience method for running a block with a span
      def in_tracing_span(operation_name:, tags:, child_of: nil)
        scope = tracer.start_active_span(
          operation_name,
          child_of: child_of,
          tags: tags
        )
        span = scope.span

        # Add correlation details to the span if we have them
        correlation_id = Gitlab::CorrelationId.current_id
        if correlation_id
          span.set_tag('correlation_id', correlation_id)
        end

        begin
          yield span
        rescue => e
          log_exception_on_span(span, e)
          raise e
        ensure
          scope.close
        end
      end

      def postnotify_span(operation_name, start_time, end_time, tags: nil, child_of: nil, exception: nil)
        span = OpenTracing.start_span(operation_name, start_time: start_time, tags: tags, child_of: child_of)

        log_exception_on_span(span, exception) if exception

        span.finish(end_time: end_time)
      end

      def log_exception_on_span(span, exception)
        span.set_tag('error', true)
        span.log_kv(kv_tags_for_exception(exception))
      end

      def kv_tags_for_exception(exception)
        case exception
        when Exception
          {
            'event':      'error',
            'error.kind': exception.class.to_s,
            'message':    Gitlab::UrlSanitizer.sanitize(exception.message),
            'stack':      exception.backtrace&.join("\n")
          }
        else
          {
            'event':        'error',
            'error.kind':   exception.class.to_s,
            'error.object': Gitlab::UrlSanitizer.sanitize(exception.to_s)
          }
        end
      end
    end
  end
end