Skip to content

Commit

Permalink
add comment that get_time_provider setting is internal
Browse files Browse the repository at this point in the history
  • Loading branch information
anmarchenko committed Sep 25, 2024
1 parent 6af5030 commit b03599c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lib/datadog/core/configuration/settings.rb
Original file line number Diff line number Diff line change
Expand Up @@ -654,10 +654,10 @@ def initialize(*_)
end
end

# The monotonic clock time provider used by Datadog.
# It must respect the interface of [Datadog::Core::Utils::Time#get_time] method.
# The monotonic clock time provider used by Datadog. This option is internal and is used by `datadog-ci`
# gem to avoid traces' durations being skewed by timecop.
#
# When testing, it can be helpful to use a different monotonic clock time provider.
# It must respect the interface of [Datadog::Core::Utils::Time#get_time] method.
#
# For [Timecop](https://rubygems.org/gems/timecop), for example,
# `->(unit = :float_second) { ::Process.clock_gettime_without_mock(::Process::CLOCK_MONOTONIC, unit) }`
Expand Down

0 comments on commit b03599c

Please sign in to comment.