This repository has been archived by the owner on Oct 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Get Timestamp with process.hrtime and Date.now (#261)
* Replace process.hrtime with Date.now Although process.hrtime() provides a high-resolution timer, it is from an unknown relative time, not epoch i.e. The time is relative to an arbitrary time in the past (not related to the time of day) and therefore not subject to clock drifts. The whole purpose of hrtime is to gather information on intervals or durations. That's why it doesn't really matter what the point in time was. Also, it is impossible to construct the ISO timestamp from hrtime, which is required when we export metrics data using stackdriver exporter. I am proposing to use Date.now function, as it returns the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC. I have written timestampFromMillis function to construct Timestamp object from the given milliseconds. * Construct Timestamp from Date.now and Process.hrtime * mock time for tests
- Loading branch information
1 parent
ebbc3e3
commit 47a672e
Showing
10 changed files
with
471 additions
and
175 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
/** | ||
* Copyright 2019, OpenCensus 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 | ||
* | ||
* http://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 {Timestamp} from '../metrics/export/types'; | ||
|
||
const MILLIS_PER_SECOND = 1e3; | ||
const NANOS_PER_MILLI = 1e3 * 1e3; | ||
const NANOS_PER_SECOND = 1e3 * 1e3 * 1e3; | ||
|
||
let hrtime = process.hrtime; | ||
let hrtimeOrigin: [number, number] = [0, 0]; | ||
let hrtimeRefSeconds = 0; | ||
let hrtimeRefNanos = 0; | ||
|
||
function setHrtimeReference() { | ||
resetHrtimeFunctionCache(); | ||
hrtimeOrigin = hrtime(); | ||
const refTime = Date.now(); | ||
hrtimeRefSeconds = Math.floor(refTime / MILLIS_PER_SECOND); | ||
hrtimeRefNanos = (refTime % MILLIS_PER_SECOND) * NANOS_PER_MILLI; | ||
} | ||
|
||
/** | ||
* This is used to enable tests to mock process.hrtime while still allow us to | ||
* cache it. | ||
*/ | ||
function resetHrtimeFunctionCache() { | ||
hrtime = process.hrtime; | ||
} | ||
|
||
/** | ||
* Gets the current timestamp with seconds and nanoseconds. | ||
* | ||
* @returns {Timestamp} The Timestamp. | ||
*/ | ||
export function getTimestampWithProcessHRTime(): Timestamp { | ||
const [offsetSecs, offsetNanos] = hrtime(hrtimeOrigin); | ||
|
||
// determine drift in seconds and nanoseconds | ||
const seconds = hrtimeRefSeconds + offsetSecs; | ||
const nanos = hrtimeRefNanos + offsetNanos; | ||
|
||
if (nanos >= NANOS_PER_SECOND) { | ||
return {seconds: seconds + 1, nanos: nanos % NANOS_PER_SECOND}; | ||
} | ||
return {seconds, nanos}; | ||
} | ||
|
||
setHrtimeReference(); | ||
|
||
export const TEST_ONLY = { | ||
setHrtimeReference, | ||
resetHrtimeFunctionCache | ||
}; |
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
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
Oops, something went wrong.