Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove CI gem dependency #3288

Merged
merged 9 commits into from
Dec 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ promote-image:
script:
# This would install all dependencies
- .gitlab/prepare_pkg_directory.sh
- ruby pkg/install_ddtrace_deps.rb debase-ruby_core_source libdatadog libddwaf datadog-ci msgpack ffi ddtrace
- ruby pkg/install_ddtrace_deps.rb debase-ruby_core_source libdatadog libddwaf msgpack ffi ddtrace
artifacts:
paths:
- pkg
Expand Down
3 changes: 0 additions & 3 deletions ddtrace.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,5 @@ Gem::Specification.new do |spec|
# When updating the version here, please also update the version in `native_extension_helpers.rb` (and yes we have a test for it)
spec.add_dependency 'libdatadog', '~> 5.0.0.1.0'

# used for CI visibility product until the next major version
spec.add_dependency 'datadog-ci', '~> 0.5.0'

spec.extensions = ['ext/ddtrace_profiling_native_extension/extconf.rb', 'ext/ddtrace_profiling_loader/extconf.rb']
end
10 changes: 0 additions & 10 deletions docs/Compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,6 @@ For a list of available integrations, and their configuration options, refer to
| Stripe | `stripe` | `>= 5.15.0` | `>= 5.15.0` | [Link][47] | [Link](https://github.com/stripe/stripe-ruby) |
| Sucker Punch | `sucker_punch` | `>= 2.0` | `>= 2.0` | [Link][48] | [Link](https://github.com/brandonhilkert/sucker_punch) |

### CI visibility integrations

These are the available CI visibility integrations:

| Name | Key | Versions Supported: MRI | Versions Supported: JRuby | How to configure | Gem source |
|-----------|------------|-------------------------|---------------------------|---------------------|-----------------------------------------------------|
| Cucumber | `cucumber` | `>= 3.0` | `>= 1.7.16` | [Link][49] | [Link](https://github.com/cucumber/cucumber-ruby) |
| RSpec | `rspec` | `>= 3.0.0` | `>= 3.0.0` | [Link][50] | [Link](https://github.com/rspec/rspec) |

[1]: https://github.com/DataDog/dd-trace-rb
[2]: https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby#action-cable
Expand Down Expand Up @@ -165,6 +157,4 @@ These are the available CI visibility integrations:
[46]: https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby#sneakers
[47]: https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby#stripe
[48]: https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby#sucker-punch
[49]: https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby#cucumber
[50]: https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby#rspec

97 changes: 1 addition & 96 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,18 +333,7 @@ For a list of configuration options for the available integrations, refer to the

#### CI Visibility

For Datadog CI Visibility, library instrumentation can be activated and configured by using the following `Datadog.configure` API:

```ruby
Datadog.configure do |c|
# Activates and configures an integration
c.ci.instrument :integration_name, **options
end
```

`options` are keyword arguments for integration-specific configuration.

For a list of available integrations and their supported versions, see [Ruby CI Integration Compatibility][3]
Checkout [Datadog's Ruby Library for instrumenting your test and continuous integration pipeline](https://github.com/DataDog/datadog-ci-rb)

### Action Cable

Expand Down Expand Up @@ -602,41 +591,6 @@ Datadog::Tracing.trace('outer') do
end
```

### Cucumber

Cucumber integration will trace all executions of scenarios and steps when using `cucumber` framework.

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

```ruby
require 'cucumber'
require 'ddtrace'

# Configure default Cucumber integration
Datadog.configure do |c|
c.ci.instrument :cucumber, **options
end

# Example of how to attach tags from scenario to active span
Around do |scenario, block|
active_span = Datadog.configuration[:cucumber][:tracer].active_span
unless active_span.nil?
scenario.tags.filter { |tag| tag.include? ':' }.each do |tag|
active_span.set_tag(*tag.name.split(':', 2))
end
end
block.call
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` | Operation name used for `cucumber` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'cucumber.test'` |

### Dalli

Dalli integration will trace all calls to your `memcached` server:
Expand Down Expand Up @@ -1112,30 +1066,6 @@ Datadog.configure do |c|
end
```

### Minitest

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

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

```ruby
require 'minitest'
require 'ddtrace'

# Configure default Minitest integration
Datadog.configure do |c|
c.ci.instrument :minitest, **options
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` | Operation name used for `minitest` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'minitest.test'` |

### MongoDB

The integration traces any `Command` that is sent from the [MongoDB Ruby Driver](https://github.com/mongodb/mongo-ruby-driver) to a MongoDB cluster. By extension, Object Document Mappers (ODM) such as Mongoid are automatically instrumented if they use the official Ruby driver. To activate the integration, simply:
Expand Down Expand Up @@ -1795,30 +1725,6 @@ end
| --- | ----------- | ------- |
| `service_name` | Service name for `roda` instrumentation. | `'nil'` |

### RSpec

RSpec integration will trace all executions of example groups and examples when using `rspec` test framework.

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

```ruby
require 'rspec'
require 'ddtrace'

# Configure default RSpec integration
Datadog.configure do |c|
c.ci.instrument :rspec, **options
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` | Operation name used for `rspec` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'rspec.example'` |

### Sequel

The Sequel integration traces queries made to your database.
Expand Down Expand Up @@ -2789,4 +2695,3 @@ See [this issue](https://github.com/DataDog/dd-trace-rb/issues/3015) for a discu
[header tags]: https://docs.datadoghq.com/tracing/configure_data_security/#applying-header-tags-to-root-spans
[1]: https://docs.datadoghq.com/tracing/trace_collection/compatibility/ruby/
[2]: https://docs.datadoghq.com/tracing/trace_collection/compatibility/ruby#integrations
[3]: https://docs.datadoghq.com/tracing/trace_collection/compatibility/ruby#ci-visibility-integrations
3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_activesupport.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_aws.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_contrib.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_contrib_old.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_core_old.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_elasticsearch_7.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_elasticsearch_8.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_hanami_1.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_http.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_opensearch_2.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_opensearch_3.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_opentracing.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions gemfiles/jruby_9.2_rack_1.gemfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading