-
Notifications
You must be signed in to change notification settings - Fork 836
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into chore/remove-accidental-meter-export
- Loading branch information
Showing
6 changed files
with
150 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| export interface Clock { | ||
| /** | ||
| * Return the current time in milliseconds from some epoch such as the Unix epoch or process start | ||
| */ | ||
| now(): number; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * A utility for returning wall times anchored to a given point in time. Wall time measurements will | ||
| * not be taken from the system, but instead are computed by adding a monotonic clock time | ||
| * to the anchor point. | ||
| * | ||
| * This is needed because the system time can change and result in unexpected situations like | ||
| * spans ending before they are started. Creating an anchored clock for each local root span | ||
| * ensures that span timings and durations are accurate while preventing span times from drifting | ||
| * too far from the system clock. | ||
| * | ||
| * Only creating an anchored clock once per local trace ensures span times are correct relative | ||
| * to each other. For example, a child span will never have a start time before its parent even | ||
| * if the system clock is corrected during the local trace. | ||
| * | ||
| * Heavily inspired by the OTel Java anchored clock | ||
| * https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/AnchoredClock.java | ||
| */ | ||
| export class AnchoredClock implements Clock { | ||
| private _monotonicClock: Clock; | ||
| private _epochMillis: number; | ||
| private _performanceMillis: number; | ||
|
|
||
| /** | ||
| * Create a new AnchoredClock anchored to the current time returned by systemClock. | ||
| * | ||
| * @param systemClock should be a clock that returns the number of milliseconds since January 1 1970 such as Date | ||
| * @param monotonicClock should be a clock that counts milliseconds monotonically such as window.performance or perf_hooks.performance | ||
| */ | ||
| public constructor(systemClock: Clock, monotonicClock: Clock) { | ||
| this._monotonicClock = monotonicClock; | ||
| this._epochMillis = systemClock.now(); | ||
| this._performanceMillis = monotonicClock.now(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the current time by adding the number of milliseconds since the | ||
| * AnchoredClock was created to the creation epoch time | ||
| */ | ||
| public now(): number { | ||
| const delta = this._monotonicClock.now() - this._performanceMillis; | ||
| return this._epochMillis + delta; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
packages/opentelemetry-core/test/common/anchored-clock.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import assert = require('assert'); | ||
| import { AnchoredClock, otperformance } from '../../src'; | ||
|
|
||
| describe('AnchoredClock', () => { | ||
| it('should keep time', done => { | ||
| const clock = new AnchoredClock(Date, otperformance); | ||
| setTimeout(() => { | ||
| // after about 100ms, the clocks are within 10ms of each other | ||
| assert.ok(Math.abs(Date.now() - clock.now()) < 10); | ||
| done(); | ||
| }, 100); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters