Module: Datadog::CI::Configuration::Components

Defined in:
lib/datadog/ci/configuration/components.rb

Overview

Adds CI behavior to Datadog trace components

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#ci_recorder ⇒ Object (readonly)

Returns the value of attribute ci_recorder.



17
18
19
 
# File 'lib/datadog/ci/configuration/components.rb', line 17

def ci_recorder
  @ci_recorder
end

Instance Method Details

#activate_ci!(settings) ⇒ Object 



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
 
# File 'lib/datadog/ci/configuration/components.rb', line 27

def activate_ci!(settings)
  test_visibility_transport = nil
  agent_settings = Datadog::Core::Configuration::AgentSettingsResolver.call(settings)

  if settings.ci.agentless_mode_enabled
    test_visibility_transport = build_agentless_transport(settings)
  elsif can_use_evp_proxy?(settings, agent_settings)
    test_visibility_transport = build_evp_proxy_transport(settings, agent_settings)
  end

  # Deactivate telemetry
  settings.telemetry.enabled = false

  # Deactivate remote configuration
  settings.remote.enabled = false

  # do not use 128-bit trace ids for CI visibility
  # they are used for OTEL compatibility in Datadog tracer
  settings.tracing.trace_id_128_bit_generation_enabled = false

  # Activate underlying tracing test mode
  settings.tracing.test_mode.enabled = true

  # Choose user defined TraceFlush or default to CI TraceFlush
  settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Finished.new

  writer_options = settings.ci.writer_options
  if test_visibility_transport
    writer_options[:transport] = test_visibility_transport
    writer_options[:shutdown_timeout] = 60

    settings.tracing.test_mode.async = true
  end

  settings.tracing.test_mode.writer_options = writer_options

  @ci_recorder = Recorder.new
end

#build_agentless_transport(settings) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/datadog/ci/configuration/components.rb', line 72

def build_agentless_transport(settings)
  if settings.api_key.nil?
    # agentless mode is requested but no API key is provided -
    # we cannot continue and log an error
    # Tests are running without CI visibility enabled

    Datadog.logger.error(
      "DATADOG CONFIGURATION - CI VISIBILITY - ATTENTION - " \
      "Agentless mode was enabled but DD_API_KEY is not set: CI visibility is disabled. " \
      "Please make sure to set valid api key in DD_API_KEY environment variable"
    )

    settings.ci.enabled = false

    nil
  else
    Datadog.logger.debug("CI visibility configured to use agentless transport")

    Datadog::CI::TestVisibility::Transport.new(
      api: Transport::Api::Builder.build_ci_test_cycle_api(settings),
      dd_env: settings.env
    )
  end
end

#build_evp_proxy_transport(settings, agent_settings) ⇒ Object 



97
98
99
100
101
102
103
104
 
# File 'lib/datadog/ci/configuration/components.rb', line 97

def build_evp_proxy_transport(settings, agent_settings)
  Datadog.logger.debug("CI visibility configured to use agent transport via EVP proxy")

  Datadog::CI::TestVisibility::Transport.new(
    api: Transport::Api::Builder.build_evp_proxy_api(agent_settings),
    dd_env: settings.env
  )
end

#can_use_evp_proxy?(settings, agent_settings) ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
69
70
 
# File 'lib/datadog/ci/configuration/components.rb', line 66

def can_use_evp_proxy?(settings, agent_settings)
  Datadog::Core::Remote::Negotiation.new(settings, agent_settings).endpoint?(
    Ext::Transport::EVP_PROXY_PATH_PREFIX
  )
end

#initialize(settings) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/datadog/ci/configuration/components.rb', line 19

def initialize(settings)
  # Activate CI mode if enabled
  activate_ci!(settings) if settings.ci.enabled

  # Initialize normally
  super
end