Class: Datadog::Profiling::HttpTransport

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/profiling/http_transport.rb,
ext/datadog_profiling_native_extension/http_transport.c

Overview

Used to report profiling data to Datadog. Methods prefixed with native are implemented in ‘http_transport.c`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(agent_settings:, site:, api_key:, upload_timeout_seconds:) ⇒ HttpTransport

Returns a new instance of HttpTransport.

Raises:

  • (ArgumentError) 


13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/datadog/profiling/http_transport.rb', line 13

def initialize(agent_settings:, site:, api_key:, upload_timeout_seconds:)
  @upload_timeout_milliseconds = (upload_timeout_seconds * 1_000).to_i

  validate_agent_settings(agent_settings)

  @exporter_configuration =
    if agentless?(site, api_key)
      [:agentless, site, api_key].freeze
    else
      [:agent, base_url_from(agent_settings)].freeze
    end

  status, result = validate_exporter(exporter_configuration)

  raise(ArgumentError, "Failed to initialize transport: #{result}") if status == :error
end

Instance Attribute Details

#exporter_configuration ⇒ Object (readonly)

Returns the value of attribute exporter_configuration.



11
12
13
 
# File 'lib/datadog/profiling/http_transport.rb', line 11

def exporter_configuration
  @exporter_configuration
end

Class Method Details

._native_do_export ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'ext/datadog_profiling_native_extension/http_transport.c', line 28

static VALUE _native_do_export(
  VALUE self,
  VALUE exporter_configuration,
  VALUE upload_timeout_milliseconds,
  VALUE start_timespec_seconds,
  VALUE start_timespec_nanoseconds,
  VALUE finish_timespec_seconds,
  VALUE finish_timespec_nanoseconds,
  VALUE pprof_file_name,
  VALUE pprof_data,
  VALUE code_provenance_file_name,
  VALUE code_provenance_data,
  VALUE tags_as_array,
  VALUE internal_metadata_json,
  VALUE info_json
);

._native_validate_exporter ⇒ Object 



25
 
# File 'ext/datadog_profiling_native_extension/http_transport.c', line 25

static VALUE _native_validate_exporter(VALUE self, VALUE exporter_configuration);

Instance Method Details

#export(flush) ⇒ Object 



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
70
71
72
73
74
 
# File 'lib/datadog/profiling/http_transport.rb', line 30

def export(flush)
  status, result = do_export(
    exporter_configuration: exporter_configuration,
    upload_timeout_milliseconds: @upload_timeout_milliseconds,

    # why "timespec"?
    # libdatadog represents time using POSIX's struct timespec, see
    # https://www.gnu.org/software/libc/manual/html_node/Time-Types.html
    # aka it represents the seconds part separate from the nanoseconds part
    start_timespec_seconds: flush.start.tv_sec,
    start_timespec_nanoseconds: flush.start.tv_nsec,
    finish_timespec_seconds: flush.finish.tv_sec,
    finish_timespec_nanoseconds: flush.finish.tv_nsec,

    pprof_file_name: flush.pprof_file_name,
    pprof_data: flush.pprof_data,
    code_provenance_file_name: flush.code_provenance_file_name,
    code_provenance_data: flush.code_provenance_data,

    tags_as_array: flush.tags_as_array,
    internal_metadata_json: flush.internal_metadata_json,

    info_json: flush.info_json
  )

  if status == :ok
    if (200..299).cover?(result)
      Datadog.logger.debug("Successfully reported profiling data")
      true
    else
      Datadog.logger.error(
        "Failed to report profiling data (#{config_without_api_key}): " \
        "server returned unexpected HTTP #{result} status code"
      )
      Datadog::Core::Telemetry::Logger.error(
        "Failed to report profiling data: unexpected HTTP #{result} status code"
      )
      false
    end
  else
    Datadog.logger.error("Failed to report profiling data (#{config_without_api_key}): #{result}")
    Datadog::Core::Telemetry::Logger.error("Failed to report profiling data")
    false
  end
end