Files
react-native/ReactCommon/utils/Telemetry.h
T
Valentin Shergin cc78aee56a Fabric: Telemetry time point serialization functions
Summary:
Fabric's Telemetry uses `std::chrono::steady_clock::time_point`s to represent the exact moments in time when some events happen. This is the same clock that pretty much any performance tracker use (and should use), QPL included.
However, different trackers use different serializable representations of that timepoints. This diff adds functions that convert the timepoint value to UNIX Timestamp and to a number of seconds from the `steady_clock` epoch start.

Changelog: [Internal] Fabric-specific internal change.

Reviewed By: mdvacca

Differential Revision: D22887632

fbshipit-source-id: 2b51acddccee9af8071a34797b5015d6fd008394
2020-08-01 21:31:40 -07:00

116 lines
3.5 KiB
C++

/*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <chrono>
#include <type_traits>
namespace facebook {
namespace react {
/*
* Represents a monotonic clock suitable for measuring intervals.
*/
using TelemetryClock = std::chrono::steady_clock;
/*
* Represents a point in time satisfied the requirements of TelemetryClock.
*/
using TelemetryTimePoint = TelemetryClock::time_point;
/*
* Represents a time interval satisfied the requirements of TelemetryClock.
*/
using TelemetryDuration = std::chrono::nanoseconds;
/*
* Represents a time point which never happens.
*/
static TelemetryTimePoint const kTelemetryUndefinedTimePoint =
TelemetryTimePoint::max();
/*
* Returns a time point representing the current point in time.
*/
static inline TelemetryTimePoint telemetryTimePointNow() {
return TelemetryClock::now();
}
/*
* Returns a number of milliseconds that passed from some epoch starting time
* point to a given time point. The epoch starting time point is not specified
* but stays the same for an application run.
*/
static inline int64_t telemetryTimePointToMilliseconds(
TelemetryTimePoint timePoint) {
return std::chrono::duration_cast<std::chrono::milliseconds>(
timePoint - TelemetryTimePoint{})
.count();
}
/*
* Returns a number of seconds that passed from "Steady Clock" epoch starting
* time point to a given time point.
*/
static inline double telemetryTimePointToSteadyClockSeconds(
TelemetryTimePoint timePoint) {
static_assert(
std::is_same<decltype(timePoint), std::chrono::steady_clock::time_point>::
value,
"`TelemetryClock` must be `std::chrono::steady_clock` to make the "
"following implementation work correctly.");
auto nanoseconds = std::chrono::duration_cast<std::chrono::nanoseconds>(
timePoint.time_since_epoch())
.count();
return nanoseconds / 1.0e9;
}
/*
* Converts a time point on one clock to a time point on a different clock.
*/
template <
typename DestinationTimePointT,
typename SourceTimePointT,
typename DestnationClockT = typename DestinationTimePointT::clock,
typename SourceClockT = typename SourceTimePointT::clock>
DestinationTimePointT clockCast(SourceTimePointT timePoint) {
auto sourseClockNow = SourceClockT::now();
auto destinationClockNow = DestnationClockT::now();
return std::chrono::time_point_cast<typename DestnationClockT::duration>(
timePoint - sourseClockNow + destinationClockNow);
}
/*
* Returns a number of seconds that passed from the UNIX Epoch starting time
* point to a given time point.
* Also known as POSIX time or UNIX Timestamp.
*/
static inline double telemetryTimePointToSecondsSinceEpoch(
TelemetryTimePoint timePoint) {
auto systemClockTimePoint =
clockCast<std::chrono::system_clock::time_point, TelemetryTimePoint>(
timePoint);
return std::chrono::duration_cast<std::chrono::microseconds>(
systemClockTimePoint.time_since_epoch())
.count() /
1000000.0;
}
/*
* Returns a number of milliseconds that represents the given duration object.
*/
static inline int64_t telemetryDurationToMilliseconds(
TelemetryDuration duration) {
return std::chrono::duration_cast<std::chrono::milliseconds>(duration)
.count();
}
} // namespace react
} // namespace facebook