Module: Datadog::Tracing::Contrib::HTTP::Instrumentation::InstanceMethods

Includes:
Datadog::Tracing::Contrib::HttpAnnotationHelper
Defined in:
lib/datadog/tracing/contrib/http/instrumentation.rb

Overview

InstanceMethods - implementing instrumentation

Instance Method Summary collapse

Methods included from Datadog::Tracing::Contrib::HttpAnnotationHelper

#service_name

Instance Method Details

#annotate_span_with_error!(span, error) ⇒ Object 



115
116
117
 
# File 'lib/datadog/tracing/contrib/http/instrumentation.rb', line 115

def annotate_span_with_error!(span, error)
  span.set_error(error)
end

#annotate_span_with_request!(span, request, request_options) ⇒ Object 



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
 
# File 'lib/datadog/tracing/contrib/http/instrumentation.rb', line 58

def annotate_span_with_request!(span, request, request_options)
  if request_options[:peer_service]
    span.set_tag(
      Tracing::Metadata::Ext::TAG_PEER_SERVICE,
      request_options[:peer_service]
    )
  end

  # Tag original global service name if not used
  if span.service != Datadog.configuration.service
    span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
  end

  span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)

  span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
  span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
  span.set_tag(
    Tracing::Metadata::Ext::HTTP::TAG_URL,
    Contrib::Utils::Quantization::HTTP.url(request.path, { query: { exclude: :all } })
  )
  span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, request.method)

  host, port = host_and_port(request)
  span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host)
  span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port.to_s)

  span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)

  # Set analytics sample rate
  set_analytics_sample_rate(span, request_options)

  span.set_tags(
    Datadog.configuration.tracing.header_tags.request_tags(request)
  )

  Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
rescue StandardError => e
  Datadog.logger.error("error preparing span from http request: #{e}")
  Datadog::Core::Telemetry::Logger.report(e)
end

#annotate_span_with_response!(span, response, request_options) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/datadog/tracing/contrib/http/instrumentation.rb', line 100

def annotate_span_with_response!(span, response, request_options)
  return unless response && response.code

  span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response.code)

  span.set_error(response) if request_options[:error_status_codes].include? response.code.to_i

  span.set_tags(
    Datadog.configuration.tracing.header_tags.response_tags(response)
  )
rescue StandardError => e
  Datadog.logger.error("error preparing span from http response: #{e}")
  Datadog::Core::Telemetry::Logger.report(e)
end

#request(req, body = nil, &block) ⇒ Object

:yield: response



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
 
# File 'lib/datadog/tracing/contrib/http/instrumentation.rb', line 26

def request(req, body = nil, &block)
  host, = host_and_port(req)
  request_options = datadog_configuration(host)
  client_config = Datadog.configuration_for(self)

  return super(req, body, &block) if Contrib::HTTP.should_skip_tracing?(req)

  Tracing.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span, trace|
    span.service = service_name(host, request_options, client_config)
    span.type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
    span.resource = req.method

    if Datadog::AppSec::Utils::TraceOperation.appsec_standalone_reject?(trace)
      trace.sampling_priority = Tracing::Sampling::Ext::Priority::AUTO_REJECT
    end

    if Tracing.enabled? && !Contrib::HTTP.should_skip_distributed_tracing?(client_config)
      Contrib::HTTP.inject(trace, req)
    end

    # Add additional request specific tags to the span.
    annotate_span_with_request!(span, req, request_options)

    response = super(req, body, &block)

    # Add additional response specific tags to the span.
    annotate_span_with_response!(span, response, request_options)

    response
  end
end

#set_analytics_sample_rate(span, request_options) ⇒ Object 



119
120
121
122
123
 
# File 'lib/datadog/tracing/contrib/http/instrumentation.rb', line 119

def set_analytics_sample_rate(span, request_options)
  return unless analytics_enabled?(request_options)

  Contrib::Analytics.set_sample_rate(span, analytics_sample_rate(request_options))
end