diff --git a/README.md b/README.md index c099ce5c..ab6c6dc1 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: @@ -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 } diff --git a/docs/UpgradeGuide.md b/docs/UpgradeGuide.md index f0e5bd32..fca60690 100644 --- a/docs/UpgradeGuide.md +++ b/docs/UpgradeGuide.md @@ -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 @@ -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: