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.



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

def ci_recorder
  @ci_recorder
end

Instance Method Details

#activate_ci!(settings) ⇒ Object 



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

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

  if settings.ci.agentless_mode_enabled
    check_dd_site(settings)
    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)
  else
    settings.ci.experimental_test_suite_level_visibility_enabled = false
  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::Partial.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
end

#build_agentless_transport(settings) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/datadog/ci/configuration/components.rb', line 81

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),
      serializers_factory: serializers_factory(settings),
      dd_env: settings.env
    )
  end
end

#build_evp_proxy_transport(settings, agent_settings) ⇒ Object 



107
108
109
110
111
112
113
114
115
 
# File 'lib/datadog/ci/configuration/components.rb', line 107

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),
    serializers_factory: serializers_factory(settings),
    dd_env: settings.env
  )
end

#can_use_evp_proxy?(settings, agent_settings) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
78
79
 
# File 'lib/datadog/ci/configuration/components.rb', line 75

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

#check_dd_site(settings) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/datadog/ci/configuration/components.rb', line 125

def check_dd_site(settings)
  return if settings.site.nil?
  return if Ext::Settings::DD_SITE_ALLOWLIST.include?(settings.site)

  Datadog.logger.warn(
    "CI VISIBILITY CONFIGURATION " \
    "Agentless mode was enabled but DD_SITE is not set to one of the following: #{Ext::Settings::DD_SITE_ALLOWLIST.join(", ")}. " \
    "Please make sure to set valid site in DD_SITE environment variable"
  )
end

#initialize(settings) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/datadog/ci/configuration/components.rb', line 22

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

  @ci_recorder = TestVisibility::Recorder.new(
    enabled: settings.ci.enabled,
    test_suite_level_visibility_enabled: settings.ci.experimental_test_suite_level_visibility_enabled
  )

  # Initialize normally
  super
end

#serializers_factory(settings) ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/datadog/ci/configuration/components.rb', line 117

def serializers_factory(settings)
  if settings.ci.experimental_test_suite_level_visibility_enabled
    Datadog::CI::TestVisibility::Serializers::Factories::TestSuiteLevel
  else
    Datadog::CI::TestVisibility::Serializers::Factories::TestLevel
  end
end