Datadog CI Visibility for Ruby

Datadog's Ruby Library for instrumenting your test and continuous integration pipeline. Learn more on our official website and check out our documentation for this library.

[!IMPORTANT] The datadog-ci gem is currently a component of ddtrace and should not be used without it.

We expect this to change in the future.

Installation

Add to your Gemfile.

gem "ddtrace"

Usage

RSpec

To activate RSpec integration, add this to the spec_helper.rb file:

require 'rspec'
require 'datadog/ci'

# Only activates test instrumentation on CI
if ENV["DD_ENV"] == "ci"
  Datadog.configure do |c|
    # Configures the tracer to ensure results delivery
    c.ci.enabled = true

    # The name of the service or library under test
    c.service = 'my-ruby-app'

    # Enables the RSpec instrumentation
    c.ci.instrument :rspec, **options
  end
end

options are the following keyword arguments:

Key	Description	Default
`enabled`	Defines whether RSpec tests should be traced. Useful for temporarily disabling tracing. `true` or `false`	`true`
`service_name`	Service name used for `rspec` instrumentation.	`'rspec'`
`operation_name`	DEPRECATED, to be removed in 1.0 Operation name used for `rspec` instrumentation (has no effect in agentless mode or when using newer agent versions).	`'rspec.example'`

Minitest

The Minitest integration will trace all executions of tests when using minitest test framework.

To activate your integration, use the Datadog.configure method:

require 'minitest'
require 'datadog/ci'

# Only activates test instrumentation on CI
if ENV["DD_ENV"] == "ci"
# Configure default Minitest integration
  Datadog.configure do |c|
    # Configures the tracer to ensure results delivery
    c.ci.enabled = true

    # The name of the service or library under test
    c.service = 'my-ruby-app'

    c.ci.instrument :minitest, **options
  end
end

options are the following keyword arguments:

Key	Description	Default
`enabled`	Defines whether Minitest tests should be traced. Useful for temporarily disabling tracing. `true` or `false`	`true`
`service_name`	Service name used for `minitest` instrumentation.	`'minitest'`
`operation_name`	DEPRECATED, to be removed in 1.0 Operation name used for `minitest` instrumentation (has no effect in agentless mode or when using newer agent versions).	`'minitest.test'`

Cucumber

Activate Cucumber integration with configuration

require 'cucumber'
require 'datadog/ci'

# Only activates test instrumentation on CI
if ENV["DD_ENV"] == "ci"
  Datadog.configure do |c|
    # Configures the tracer to ensure results delivery
    c.ci.enabled = true

    # The name of the service or library under test
    c.service = 'my-ruby-app'

    # Enables the Cucumber instrumentation
    c.ci.instrument :cucumber, **options
  end
end

options are the following keyword arguments:

Key	Description	Default
`enabled`	Defines whether Cucumber tests should be traced. Useful for temporarily disabling tracing. `true` or `false`	`true`
`service_name`	Service name used for `cucumber` instrumentation.	`'cucumber'`
`operation_name`	DEPRECATED, to be removed in 1.0 Operation name used for `cucumber` instrumentation (has no effect in agentless mode or when using newer agent versions).	`'cucumber.test'`

Agentless mode

If you are using a cloud CI provider without access to the underlying worker nodes, such as GitHub Actions or CircleCI, configure the library to use the Agentless mode. For this, set the following environment variables: DD_CIVISIBILITY_AGENTLESS_ENABLED=true (Required) and DD_API_KEY=your_secret_api_key (Required).

Additionally, configure which Datadog site you want to send data to: DD_SITE=your.datadoghq.com (datadoghq.com by default).

Agentless mode can also be enabled via Datadog.configure (but don't forget to set DD_API_KEY environment variable):

Datadog.configure { |c| c.ci.agentless_mode_enabled = true }

Additional configuration

Add tracing instrumentations

It can be useful to have rich tracing information about your tests that includes time spent performing database operations or other external calls like here:

Test trace with redis instrumented

In order to achieve this you can configure ddtrace instrumentations in your configure block:

Datadog.configure do |c|
  #  ... ci configs and instrumentation here ...
  c.tracing.instrument :redis
  c.tracing.instrument :pg
end

...or enable auto instrumentation in your test_helper/spec_helper:

require "ddtrace/auto_instrument"

Note: in CI mode these traces are going to be submitted to CI Visibility, they will not show up in Datadog APM.

For the full list of available instrumentations see ddtrace documentation

WebMock

WebMock is a popular Ruby library that stubs HTTP requests when running tests. By default it fails when used together with datadog-ci as traces are being sent to Datadog via HTTP calls.

In order to allow HTTP connections for Datadog backend you would need to configure Webmock accordingly.

# when using agentless mode
# note to use the correct datadog site (e.g. datadoghq.eu, etc)
WebMock.disable_net_connect!(:allow => /datadoghq.com/)

# when using agent
WebMock.disable_net_connect!(:allow_localhost => true)

# or for more granular setting set your agent URL
WebMock.disable_net_connect!(:allow => "localhost:8126")

VCR

VCR is another popular testing library for HTTP interactions.

It requires additional configuration to correctly work with datadog-ci:

VCR.configure do |config|
  # ... your usual configuration here ...

  # when using agent
  config.ignore_hosts "127.0.0.1", "localhost"

  # when using agentless mode
  # note to use the correct datadog site (e.g. datadoghq.eu, etc)
  config.ignore_hosts "citestcycle-intake.datadoghq.com", "api.datadoghq.com"
end

Disabling startup logs

Startup logs produce a report of tracing state when the application is initially configured. These logs are activated by default in test mode, if you don't want them you can disable this via diagnostics.startup_logs.enabled = false or DD_TRACE_STARTUP_LOGS=0.

Datadog.configure { |c| c.diagnostics.startup_logs.enabled = false }

Enabling debug mode

Switching the library into debug mode will produce verbose, detailed logs about tracing activity, including any suppressed errors. This output can be helpful in identifying errors, confirming trace output, or catching HTTP transport issues.

You can enable this via diagnostics.debug = true or DD_TRACE_DEBUG=1.

Datadog.configure { |c| c.diagnostics.debug = true }

Contributing

See development guide, static typing guide and contributing guidelines.

Code of Conduct

Everyone interacting in the Datadog::CI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.