Skip to content

Commit

Permalink
remove get_time_provider option from the public docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@anmarchenko
anmarchenko committed Sep 25, 2024
1 parent 6e4db87 commit 6af5030
Showing 1 changed file with 1 addition and 10 deletions.
11 changes: 1 addition & 10 deletions docs/GettingStarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2044,7 +2044,6 @@ For example, if `tracing.sampling.default_rate` is configured by [Remote Configu
| `service` | `DD_SERVICE` | `String` | _Ruby filename_ | Your application's default service name. (e.g. `billing-api`) This value is set as a tag on all traces. |
| `tags` | `DD_TAGS` | `Hash` | `nil` | Custom tags in value pairs separated by `,` (e.g. `layer:api,team:intake`) These tags are set on all traces. See [Environment and tags](#environment-and-tags) for more details. |
| `time_now_provider` | | `Proc` | `->{ Time.now }` | Changes how time is retrieved. See [Setting the time provider](#setting-the-time-provider) for more details. |
| `get_time_provider` | | `Proc` | `->(unit = :float_second) { ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, unit) }` | Changes how monotonic time is retrieved. See [Setting the time provider](#setting-the-time-provider) for more details. |
| `version` | `DD_VERSION` | `String` | `nil` | Your application version (e.g. `2.5`, `202003181415`, `1.3-alpha`, etc.) This value is set as a tag on all traces. |
| `telemetry.enabled` | `DD_INSTRUMENTATION_TELEMETRY_ENABLED` | `Bool` | `true` | Allows you to enable sending telemetry data to Datadog. Can be disabled, as documented [here](https://docs.datadoghq.com/tracing/configure_data_security/#telemetry-collection). |
| **Tracing** | | | | |
Expand Down Expand Up @@ -2662,15 +2661,7 @@ Datadog.configure do |c|
end
```

Span duration calculation uses the system monotonic clock when available, to change the function that provides monotonic clock,
configure the following:

```ruby
Datadog.configure do |c|
# For Timecop, for example, `::Process.clock_gettime_without_mock` allows the tracer to use the real monotonic time.
c.get_time_provider = ->(unit = :float_second) { ::Process.clock_gettime_without_mock(::Process::CLOCK_MONOTONIC, unit) }
end
```
Span duration calculation will still use the system monotonic clock when available, thus not being affected by this setting.

### Metrics

Expand Down

0 comments on commit 6af5030

Please sign in to comment.