Module: Datadog::Contrib::Grape::Endpoint

Defined in:
lib/ddtrace/contrib/grape/endpoint.rb

Overview

rubocop:disable Metrics/ModuleLength Endpoint module includes a list of subscribers to create traces when a Grape endpoint is hit

Constant Summary collapse

KEY_RUN = 
'datadog_grape_endpoint_run'.freeze
KEY_RENDER = 
'datadog_grape_endpoint_render'.freeze

Class Method Summary collapse

Class Method Details

.endpoint_render(name, start, finish, id, payload) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/ddtrace/contrib/grape/endpoint.rb', line 118

def endpoint_render(name, start, finish, id, payload)
  return unless Thread.current[KEY_RENDER]
  Thread.current[KEY_RENDER] = false

  return unless enabled?

  span = tracer.active_span
  return unless span

  # catch thrown exceptions
  begin
    span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
  ensure
    span.start_time = start
    span.finish(finish)
  end
rescue StandardError => e
  Datadog::Tracer.log.error(e.message)
end

.endpoint_run(name, start, finish, id, payload) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ddtrace/contrib/grape/endpoint.rb', line 52

def endpoint_run(name, start, finish, id, payload)
  return unless Thread.current[KEY_RUN]
  Thread.current[KEY_RUN] = false

  return unless enabled?

  span = tracer.active_span
  return unless span

  begin
    # collect endpoint details
    api = payload[:endpoint].options[:for]
    # If the API inherits from Grape::API in version >= 1.2.0
    # then the API will be an instance and the name must be derived from the base.
    # See https://github.com/ruby-grape/grape/issues/1825
    api_view = if defined?(::Grape::API::Instance) && api <= ::Grape::API::Instance
                 api.base.to_s
               else
                 api.to_s
               end

    path = payload[:endpoint].options[:path].join('/')
    resource = "#{api_view}##{path}"
    span.resource = resource

    # set the request span resource if it's a `rack.request` span
    request_span = payload[:env][Datadog::Contrib::Rack::Ext::RACK_ENV_REQUEST_SPAN]
    if !request_span.nil? && request_span.name == Datadog::Contrib::Rack::Ext::SPAN_REQUEST
      request_span.resource = resource
    end

    # Set analytics sample rate
    if analytics_enabled?
      Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
    end

    # catch thrown exceptions
    span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?

    # override the current span with this notification values
    span.set_tag(Ext::TAG_ROUTE_ENDPOINT, api_view) unless api_view.nil?
    span.set_tag(Ext::TAG_ROUTE_PATH, path)
  ensure
    span.start_time = start
    span.finish(finish)
  end
rescue StandardError => e
  Datadog::Tracer.log.error(e.message)
end

.endpoint_run_filters(name, start, finish, id, payload) ⇒ Object 



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
 
# File 'lib/ddtrace/contrib/grape/endpoint.rb', line 138

def endpoint_run_filters(name, start, finish, id, payload)
  return unless enabled?

  # safe-guard to prevent submitting empty filters
  zero_length = (finish - start).zero?
  filters = payload[:filters]
  type = payload[:type]
  return if (!filters || filters.empty?) || !type || zero_length

  span = tracer.trace(
    Ext::SPAN_ENDPOINT_RUN_FILTERS,
    service: service_name,
    span_type: Datadog::Ext::HTTP::TYPE_INBOUND
  )

  begin
    # Set analytics sample rate
    if analytics_enabled?
      Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
    end

    # catch thrown exceptions
    span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
    span.set_tag(Ext::TAG_FILTER_TYPE, type.to_s)
  ensure
    span.start_time = start
    span.finish(finish)
  end
rescue StandardError => e
  Datadog::Tracer.log.error(e.message)
end

.endpoint_start_process ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ddtrace/contrib/grape/endpoint.rb', line 36

def endpoint_start_process(*)
  return if Thread.current[KEY_RUN]
  return unless enabled?

  # Store the beginning of a trace
  tracer.trace(
    Ext::SPAN_ENDPOINT_RUN,
    service: service_name,
    span_type: Datadog::Ext::HTTP::TYPE_INBOUND
  )

  Thread.current[KEY_RUN] = true
rescue StandardError => e
  Datadog::Tracer.log.error(e.message)
end

.endpoint_start_render ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/ddtrace/contrib/grape/endpoint.rb', line 102

def endpoint_start_render(*)
  return if Thread.current[KEY_RENDER]
  return unless enabled?

  # Store the beginning of a trace
  tracer.trace(
    Ext::SPAN_ENDPOINT_RENDER,
    service: service_name,
    span_type: Datadog::Ext::HTTP::TEMPLATE
  )

  Thread.current[KEY_RENDER] = true
rescue StandardError => e
  Datadog::Tracer.log.error(e.message)
end

.subscribe ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/ddtrace/contrib/grape/endpoint.rb', line 17

def subscribe
  # subscribe when a Grape endpoint is hit
  ::ActiveSupport::Notifications.subscribe('endpoint_run.grape.start_process') do |*args|
    endpoint_start_process(*args)
  end
  ::ActiveSupport::Notifications.subscribe('endpoint_run.grape') do |*args|
    endpoint_run(*args)
  end
  ::ActiveSupport::Notifications.subscribe('endpoint_render.grape.start_render') do |*args|
    endpoint_start_render(*args)
  end
  ::ActiveSupport::Notifications.subscribe('endpoint_render.grape') do |*args|
    endpoint_render(*args)
  end
  ::ActiveSupport::Notifications.subscribe('endpoint_run_filters.grape') do |*args|
    endpoint_run_filters(*args)
  end
end