Skip to content

Commit

Permalink
upgrade guide: a bunch of changes from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
anmarchenko committed Apr 23, 2024
1 parent 3fbaf5b commit 576d656
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ end

## Upgrade from ddtrace v1.x

If you used test visibility for Ruby with ddtrace gem, check out our [upgrade guide](/docs/UpgradeGuide.md).
If you used [test visibility for Ruby](https://docs.datadoghq.com/tests/setup/ruby/) with [ddtrace](https://github.com/datadog/dd-trace-rb) gem, check out our [upgrade guide](/docs/UpgradeGuide.md).

## Usage

Expand Down Expand Up @@ -108,7 +108,7 @@ end
Configuration `ci.instrument` accepts the following optional parameters:

- `enabled` (default: `true`) - defines whether tests should be traced (useful for temporarily disabling tracing)
- `service_name` - service name used for this instrumentation (when you want it to be different for given test framework)
- `service_name` - name of the service or library under test (when you want it to be different for a test framework)

Example usage:

Expand Down Expand Up @@ -219,7 +219,7 @@ Datadog.configure { |c| c.diagnostics.startup_logs.enabled = false }

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 `DD_TRACE_DEBUG=1` or in the configure block:
You can enable this via `DD_TRACE_DEBUG=1` or in the `Datadog.configure` block:

```ruby
Datadog.configure { |c| c.diagnostics.debug = true }
Expand Down
4 changes: 2 additions & 2 deletions docs/UpgradeGuide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Upgrading from ddtrace 1.x to datadog-ci

Test visibility for Ruby is no longer part of `datadog` gem and fully migrated to
[Test visibility for Ruby](https://docs.datadoghq.com/tests/setup/ruby/) is no longer part of `datadog` gem and fully migrated to
`datadog-ci` gem. To continue using it after gem `datadog` v2.0 is released, do these changes.

## Add datadog-ci to your gemfile
Expand Down Expand Up @@ -31,7 +31,7 @@ end

## Change WebMock or VCR configuration

Test visibility features (such as intelligent test runner, git metadata upload, code coverage support) require some DataDog endpoints to be allowlisted by WebMock/VCR tools when using agentless mode.
New test visibility features (such as [intelligent test runner](https://docs.datadoghq.com/intelligent_test_runner/), git metadata upload, [code coverage support](https://docs.datadoghq.com/tests/code_coverage)) require some DataDog endpoints to be allowlisted by WebMock/VCR tools when using agentless mode.

For WebMock allow all requests that match datadoghq:

Expand Down

0 comments on commit 576d656

Please sign in to comment.