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

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

Overview

Adds CI behavior to Datadog trace components

Instance Method Summary collapse

Instance Method Details

#activate_ci!(settings) ⇒ Object 



19
20
21
22
23
24
25
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
57
58
59
60
61
62
 
# File 'lib/datadog/ci/configuration/components.rb', line 19

def activate_ci!(settings)
  agentless_transport = nil

  if settings.ci.agentless_mode_enabled
    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
      return
    else
      agentless_transport = build_agentless_transport(settings)
    end
  end

  # Deactivate telemetry
  settings.telemetry.enabled = false

  # Deactivate remote configuration
  settings.remote.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 agentless_transport
    writer_options[:transport] = agentless_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 



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/datadog/ci/configuration/components.rb', line 64

def build_agentless_transport(settings)
  dd_site = settings.site || "datadoghq.com"
  agentless_url = settings.ci.agentless_url ||
    "https://#{Ext::Transport::TEST_VISIBILITY_INTAKE_HOST_PREFIX}.#{dd_site}:443"

  Datadog::CI::TestVisibility::Transport.new(
    api_key: settings.api_key,
    url: agentless_url,
    env: settings.env
  )
end

#initialize(settings) ⇒ Object 



11
12
13
14
15
16
17
 
# File 'lib/datadog/ci/configuration/components.rb', line 11

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

  # Initialize normally
  super
end