Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RUMM-2341 Expose server date provider interface #950

Merged
merged 2 commits into from
Aug 2, 2022
Merged

RUMM-2341 Expose server date provider interface #950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
023ef61
RUMM-2341 Expose server date provider interface
maxep Jul 29, 2022
b8a839c
RUMM-2341 Update CHANGELOG
maxep Jul 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* [IMPROVEMENT] Include the exact model information in RUM `device.model`. See [#888][]
* [FEATURE] Allow filtering outgoing logs with a status threshold. See [#867][]
* [BUGFIX] Fix compilation issue in SwiftUI Previews. See [#949][]
* [IMPROVEMENT] Expose server date provider for custom clock synchronization. See [#950][]

# 1.11.1 / 20-06-2022

Expand Down Expand Up @@ -397,6 +398,7 @@
[#876]: https://github.com/DataDog/dd-sdk-ios/issues/876
[#894]: https://github.com/DataDog/dd-sdk-ios/issues/894
[#949]: https://github.com/DataDog/dd-sdk-ios/issues/949
[#950]: https://github.com/DataDog/dd-sdk-ios/issues/950
[@00FA9A]: https://github.com/00FA9A
[@Britton-Earnin]: https://github.com/Britton-Earnin
[@Hengyu]: https://github.com/Hengyu
Expand Down
18 changes: 12 additions & 6 deletions Datadog/Datadog.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@
61BB2B1B244A185D009F3F56 /* PerformancePreset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61BB2B1A244A185D009F3F56 /* PerformancePreset.swift */; };
61BBD19524ED4E9E0023E65F /* FeaturesConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61BBD19424ED4E9E0023E65F /* FeaturesConfiguration.swift */; };
61BBD19724ED50040023E65F /* FeaturesConfigurationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61BBD19624ED50040023E65F /* FeaturesConfigurationTests.swift */; };
61BCB81F256EB77F0039887B /* NTPServerDateProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61BCB81E256EB77F0039887B /* NTPServerDateProvider.swift */; };
61BCB81F256EB77F0039887B /* DatadogNTPDateProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61BCB81E256EB77F0039887B /* DatadogNTPDateProvider.swift */; };
61C1510D25AC8C1B00362D4B /* RUMViewIdentityTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61C1510C25AC8C1B00362D4B /* RUMViewIdentityTests.swift */; };
61C2C20724C098FC00C0321C /* RUMSessionScope.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61C2C20624C098FC00C0321C /* RUMSessionScope.swift */; };
61C2C20924C0C75500C0321C /* RUMSessionScopeTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61C2C20824C0C75500C0321C /* RUMSessionScopeTests.swift */; };
Expand Down Expand Up @@ -700,7 +700,7 @@
D2CB6E4527C50EAE00A62B57 /* RUMResourceScope.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61494CB024C839460082C633 /* RUMResourceScope.swift */; };
D2CB6E4627C50EAE00A62B57 /* RUMSessionScope.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61C2C20624C098FC00C0321C /* RUMSessionScope.swift */; };
D2CB6E4727C50EAE00A62B57 /* TracingUUID.swift in Sources */ = {isa = PBXBuildFile; fileRef = 617CEB382456BC3A00AD4669 /* TracingUUID.swift */; };
D2CB6E4827C50EAE00A62B57 /* NTPServerDateProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61BCB81E256EB77F0039887B /* NTPServerDateProvider.swift */; };
D2CB6E4827C50EAE00A62B57 /* DatadogNTPDateProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61BCB81E256EB77F0039887B /* DatadogNTPDateProvider.swift */; };
D2CB6E4927C50EAE00A62B57 /* AttributesSanitizer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61122ED925B1BA9700F9C7F5 /* AttributesSanitizer.swift */; };
D2CB6E4C27C50EAE00A62B57 /* RUMDataModelsMapping.swift in Sources */ = {isa = PBXBuildFile; fileRef = 618715F824DC13A100FC0F69 /* RUMDataModelsMapping.swift */; };
D2CB6E4D27C50EAE00A62B57 /* Globals.swift in Sources */ = {isa = PBXBuildFile; fileRef = 61C3638424361E9200C4D4E6 /* Globals.swift */; };
Expand Down Expand Up @@ -1036,6 +1036,8 @@
D2DC4BBD27F234E000E4FB96 /* CITestIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = E143CCAE27D236F600F4018A /* CITestIntegrationTests.swift */; };
D2DC4BF627F484AA00E4FB96 /* DataEncryption.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2DC4BF527F484AA00E4FB96 /* DataEncryption.swift */; };
D2DC4BF727F484AA00E4FB96 /* DataEncryption.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2DC4BF527F484AA00E4FB96 /* DataEncryption.swift */; };
D2E2C2592893E54600E336BE /* ServerDateProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2E2C2582893E54600E336BE /* ServerDateProvider.swift */; };
D2E2C25A2893E54600E336BE /* ServerDateProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2E2C2582893E54600E336BE /* ServerDateProvider.swift */; };
D2EFA86B286DCDBB00F1FAA6 /* DateCorrector.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2EFA86A286DCDBB00F1FAA6 /* DateCorrector.swift */; };
D2EFA86C286DCDBB00F1FAA6 /* DateCorrector.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2EFA86A286DCDBB00F1FAA6 /* DateCorrector.swift */; };
D2EFF3D32731822A00D09F33 /* RUMViewsHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = D2EFF3D22731822A00D09F33 /* RUMViewsHandler.swift */; };
Expand Down Expand Up @@ -1598,7 +1600,7 @@
61BB2B1A244A185D009F3F56 /* PerformancePreset.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PerformancePreset.swift; sourceTree = "<group>"; };
61BBD19424ED4E9E0023E65F /* FeaturesConfiguration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FeaturesConfiguration.swift; sourceTree = "<group>"; };
61BBD19624ED50040023E65F /* FeaturesConfigurationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FeaturesConfigurationTests.swift; sourceTree = "<group>"; };
61BCB81E256EB77F0039887B /* NTPServerDateProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NTPServerDateProvider.swift; sourceTree = "<group>"; };
61BCB81E256EB77F0039887B /* DatadogNTPDateProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DatadogNTPDateProvider.swift; sourceTree = "<group>"; };
61C1510C25AC8C1B00362D4B /* RUMViewIdentityTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RUMViewIdentityTests.swift; sourceTree = "<group>"; };
61C2C20624C098FC00C0321C /* RUMSessionScope.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RUMSessionScope.swift; sourceTree = "<group>"; };
61C2C20824C0C75500C0321C /* RUMSessionScopeTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RUMSessionScopeTests.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1820,6 +1822,7 @@
D2CB6FEC27C5352300A62B57 /* DatadogCrashReportingTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = DatadogCrashReportingTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
D2D37DBE2846335F00FB4348 /* DatadogV1CoreProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DatadogV1CoreProtocol.swift; sourceTree = "<group>"; };
D2DC4BF527F484AA00E4FB96 /* DataEncryption.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DataEncryption.swift; sourceTree = "<group>"; };
D2E2C2582893E54600E336BE /* ServerDateProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ServerDateProvider.swift; sourceTree = "<group>"; };
D2EFA86A286DCDBB00F1FAA6 /* DateCorrector.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DateCorrector.swift; sourceTree = "<group>"; };
D2EFF3D22731822A00D09F33 /* RUMViewsHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RUMViewsHandler.swift; sourceTree = "<group>"; };
D2F1B81026D795F3009F3293 /* DDNoopRUMMonitor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DDNoopRUMMonitor.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -3527,8 +3530,9 @@
61C576C4256E655600295F7C /* Time */ = {
isa = PBXGroup;
children = (
61BCB81E256EB77F0039887B /* NTPServerDateProvider.swift */,
D2E2C2582893E54600E336BE /* ServerDateProvider.swift */,
61C576C5256E65BD00295F7C /* ServerDateCorrector.swift */,
61BCB81E256EB77F0039887B /* DatadogNTPDateProvider.swift */,
);
path = Time;
sourceTree = "<group>";
Expand Down Expand Up @@ -5127,7 +5131,7 @@
61C2C20724C098FC00C0321C /* RUMSessionScope.swift in Sources */,
617CEB392456BC3A00AD4669 /* TracingUUID.swift in Sources */,
D2956CA82869BA23007D5462 /* DatadogContext.swift in Sources */,
61BCB81F256EB77F0039887B /* NTPServerDateProvider.swift in Sources */,
61BCB81F256EB77F0039887B /* DatadogNTPDateProvider.swift in Sources */,
61122EDA25B1BA9700F9C7F5 /* AttributesSanitizer.swift in Sources */,
618715F924DC13A100FC0F69 /* RUMDataModelsMapping.swift in Sources */,
61C3638524361E9200C4D4E6 /* Globals.swift in Sources */,
Expand Down Expand Up @@ -5221,6 +5225,7 @@
B3FC3C0926526F0000DEED9E /* VitalInfo.swift in Sources */,
61DA8CAF28620C760074A606 /* Cryptography.swift in Sources */,
616F1FB32840125400651A3A /* RUMV2Configuration.swift in Sources */,
D2E2C2592893E54600E336BE /* ServerDateProvider.swift in Sources */,
613E81F025A740140084B751 /* RUMEventsMapper.swift in Sources */,
61D980BA24E28D0100E03345 /* RUMIntegrations.swift in Sources */,
61C5A88424509A0C00DA608C /* DDSpan.swift in Sources */,
Expand Down Expand Up @@ -5724,6 +5729,7 @@
D2CB6E2927C50EAE00A62B57 /* KronosInternetAddress.swift in Sources */,
D2CB6E2A27C50EAE00A62B57 /* RUMContextProvider.swift in Sources */,
6122514927FDFF82004F5AE4 /* RUMScopeDependencies.swift in Sources */,
D2E2C25A2893E54600E336BE /* ServerDateProvider.swift in Sources */,
D2CB6E2B27C50EAE00A62B57 /* RUMViewScope.swift in Sources */,
D2CB6E2C27C50EAE00A62B57 /* KronosNTPPacket.swift in Sources */,
D2CB6E2D27C50EAE00A62B57 /* CrashReportingFeature.swift in Sources */,
Expand Down Expand Up @@ -5763,7 +5769,7 @@
61DA8CB028620C760074A606 /* Cryptography.swift in Sources */,
D2DC4BF727F484AA00E4FB96 /* DataEncryption.swift in Sources */,
D2CB6E4727C50EAE00A62B57 /* TracingUUID.swift in Sources */,
D2CB6E4827C50EAE00A62B57 /* NTPServerDateProvider.swift in Sources */,
D2CB6E4827C50EAE00A62B57 /* DatadogNTPDateProvider.swift in Sources */,
D2CB6E4927C50EAE00A62B57 /* AttributesSanitizer.swift in Sources */,
6194E4BD2878AF7600EB6307 /* ConsoleLogger.swift in Sources */,
D2CB6E4C27C50EAE00A62B57 /* RUMDataModelsMapping.swift in Sources */,
Expand Down
2 changes: 1 addition & 1 deletion Datadog/E2ETests/NTP/KronosE2ETests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class KronosE2ETests: E2ETests {
}

// Run test for each Datadog NTP pool:
NTPServerDateProvider.datadogNTPServers.forEach { ddNTPPool in
DatadogNTPDateProvider.datadogNTPServers.forEach { ddNTPPool in
let result = measure(resourceName: DD.PerfSpanName.fromCurrentMethodName()) {
performKronosSync(using: ddNTPPool)
}
Expand Down
4 changes: 3 additions & 1 deletion Sources/Datadog/Core/FeaturesConfiguration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ internal struct FeaturesConfiguration {
let sdkVersion: String
let proxyConfiguration: [AnyHashable: Any]?
let encryption: DataEncryption?
let serverDateProvider: ServerDateProvider?
}

struct Logging {
Expand Down Expand Up @@ -168,7 +169,8 @@ extension FeaturesConfiguration {
origin: CITestIntegration.active?.origin,
sdkVersion: sdkVersion,
proxyConfiguration: configuration.proxyConfiguration,
encryption: configuration.encryption
encryption: configuration.encryption,
serverDateProvider: configuration.serverDateProvider
)

if configuration.loggingEnabled {
Expand Down
18 changes: 2 additions & 16 deletions ...e/System/Time/NTPServerDateProvider.swift → .../System/Time/DatadogNTPDateProvider.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,7 @@

import Foundation

/// Abstract the monotonic clock synchronized with the server using NTP.
internal protocol ServerDateProvider {
/// Start the clock synchronisation with NTP server.
/// Calls the `completion` by passing it the server time offset when the synchronization succeeds or`nil` if it fails.
func synchronize(update: @escaping (TimeInterval) -> Void)
}

internal class NTPServerDateProvider: ServerDateProvider {
static let datadogNTPServers = [
"0.datadog.pool.ntp.org",
"1.datadog.pool.ntp.org",
"2.datadog.pool.ntp.org",
"3.datadog.pool.ntp.org"
]

internal class DatadogNTPDateProvider: ServerDateProvider {
let kronos: KronosClockProtocol

init(kronos: KronosClockProtocol = KronosClock()) {
Expand All @@ -29,7 +15,7 @@ internal class NTPServerDateProvider: ServerDateProvider {

func synchronize(update: @escaping (TimeInterval) -> Void) {
kronos.sync(
from: NTPServerDateProvider.datadogNTPServers.randomElement()!, // swiftlint:disable:this force_unwrapping
from: DatadogNTPServers.randomElement()!, // swiftlint:disable:this force_unwrapping
first: { _, offset in
update(offset)
},
Expand Down
2 changes: 2 additions & 0 deletions Sources/Datadog/Core/System/Time/ServerDateCorrector.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ import Foundation
internal class ServerDateCorrector: DateCorrector {
/// Server offset publisher.
private let publisher: ValuePublisher<TimeInterval> = ValuePublisher(initialValue: 0)
private let provider: ServerDateProvider

init(serverDateProvider: ServerDateProvider) {
self.provider = serverDateProvider
serverDateProvider.synchronize(update: publisher.publishAsync)
}

Expand Down
23 changes: 23 additions & 0 deletions Sources/Datadog/Core/System/Time/ServerDateProvider.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2019-2020 Datadog, Inc.
*/

import Foundation

/// List of Datadog NTP pools.
public let DatadogNTPServers = [
"0.datadog.pool.ntp.org",
"1.datadog.pool.ntp.org",
"2.datadog.pool.ntp.org",
"3.datadog.pool.ntp.org"
]

/// Abstract the monotonic clock synchronized with the server using NTP.
public protocol ServerDateProvider {
/// Start the clock synchronisation with NTP server.
///
/// Calls the `completion` by passing it the server time offset when the synchronization succeeds.
func synchronize(update: @escaping (TimeInterval) -> Void)
}
2 changes: 1 addition & 1 deletion Sources/Datadog/Datadog.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ public class Datadog {
let userInfoProvider = UserInfoProvider()
let dateProvider = SystemDateProvider()
let dateCorrector = ServerDateCorrector(
serverDateProvider: NTPServerDateProvider()
serverDateProvider: configuration.common.serverDateProvider ?? DatadogNTPDateProvider()
)
let networkConnectionInfoProvider = NetworkConnectionInfoProvider()
let carrierInfoProvider = CarrierInfoProvider()
Expand Down
15 changes: 15 additions & 0 deletions Sources/Datadog/DatadogConfiguration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ extension Datadog {
private(set) var loggingEnabled: Bool
private(set) var tracingEnabled: Bool
private(set) var rumEnabled: Bool
private(set) var serverDateProvider: ServerDateProvider?
private(set) var crashReportingPlugin: DDCrashReportingPluginType?

/// If `DatadogEndpoint` is set, it will override `logsEndpoint`, `tracesEndpoint` and `rumEndpoint` values.
Expand Down Expand Up @@ -398,6 +399,20 @@ extension Datadog {
return self
}

/// Sets a custom NTP synchronization interface.
///
/// By default, the Datadog SDK synchronizes with dedicated NTP pools provided by the
/// https://www.ntppool.org/ . Using different pools or setting a no-op `ServerDateProvider`
/// implementation will result in desynchronization of the SDK instance and the Datadog servers.
/// This can lead to significant time shift in RUM sessions or distributed traces.
///
/// - Parameter serverDateProvider: An object that complies with `ServerDateProvider`
/// for provider clock synchronisation.
public func set(serverDateProvider: ServerDateProvider) -> Builder {
configuration.serverDateProvider = serverDateProvider
return self
}

// MARK: - Logging Configuration

/// Enables or disables the logging feature.
Expand Down
6 changes: 5 additions & 1 deletion Sources/Datadog/Kronos/KronosClock.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,11 @@ internal final class KronosClock: KronosClockProtocol {
) {
self.loadFromDefaults()

KronosNTPClient().query(pool: pool, numberOfSamples: samples) { offset, done, total in
KronosNTPClient().query(pool: pool, numberOfSamples: samples) { [weak self] offset, done, total in
guard let self = self else {
return
}

if let offset = offset {
self.stableTime = KronosTimeFreeze(offset: offset)

Expand Down
30 changes: 30 additions & 0 deletions Sources/DatadogObjc/DatadogConfiguration+objc.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,22 @@ internal struct DDDataEncryptionBridge: DataEncryption {
}
}

@objc
public protocol DDServerDateProvider: AnyObject {
/// Start the clock synchronisation with NTP server.
///
/// Calls the `completion` by passing it the server time offset when the synchronization succeeds or`nil` if it fails.
func synchronize(update: @escaping (TimeInterval) -> Void)
}

internal struct DDServerDateProviderBridge: ServerDateProvider {
let objcProvider: DDServerDateProvider

func synchronize(update: @escaping (TimeInterval) -> Void) {
objcProvider.synchronize(update: update)
}
}

@objc
public class DDConfiguration: NSObject {
internal let sdkConfiguration: Datadog.Configuration
Expand Down Expand Up @@ -267,6 +283,20 @@ public class DDConfigurationBuilder: NSObject {
_ = sdkBuilder.set(customRUMEndpoint: customRUMEndpoint)
}

/// Sets a custom NTP synchronization interface.
///
/// By default, the Datadog SDK synchronizes with dedicated NTP pools provided by the
/// https://www.ntppool.org/ . Using different pools or setting a no-op `DDServerDateProvider`
/// implementation will result in desynchronization of the SDK instance and the Datadog servers.
/// This can lead to significant time shift in RUM sessions or distributed traces.
///
/// - Parameter serverDateProvider: An object that complies with `DDServerDateProvider`
/// for provider clock synchronisation.
@objc
public func set(serverDateProvider: DDServerDateProvider) {
_ = sdkBuilder.set(serverDateProvider: DDServerDateProviderBridge(objcProvider: serverDateProvider))
}

@available(*, deprecated, message: "This option is replaced by `set(endpoint:)`. Refer to the new API comment for details.")
@objc
public func set(logsEndpoint: DDLogsEndpoint) {
Expand Down
Loading