-
-
Notifications
You must be signed in to change notification settings - Fork 340
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
1,168 additions
and
307 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
Large diffs are not rendered by default.
Oops, something went wrong.
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
Large diffs are not rendered by default.
Oops, something went wrong.
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,236 @@ | ||
| #import "SentryMetricProfiler.h" | ||
|
|
||
| #if SENTRY_TARGET_PROFILING_SUPPORTED | ||
|
|
||
| # import "SentryDependencyContainer.h" | ||
| # import "SentryLog.h" | ||
| # import "SentryMachLogging.hpp" | ||
| # import "SentryNSNotificationCenterWrapper.h" | ||
| # import "SentryNSProcessInfoWrapper.h" | ||
| # import "SentryNSTimerWrapper.h" | ||
| # import "SentrySystemWrapper.h" | ||
| # import "SentryTime.h" | ||
|
|
||
| static const NSTimeInterval kSentryMetricProfilerTimeseriesInterval = 0.1; // 10 Hz | ||
|
|
||
| NSString *const kSentryMetricProfilerSerializationKeyMemoryFootprint = @"memory-footprint"; | ||
| NSString *const kSentryMetricProfilerSerializationKeyMemoryPressure = @"memory-pressure"; | ||
| NSString *const kSentryMetricProfilerSerializationKeyPowerState = @"is-low-power-mode"; | ||
| NSString *const kSentryMetricProfilerSerializationKeyThermalState = @"thermal-state"; | ||
| NSString *const kSentryMetricProfilerSerializationKeyCPUUsageFormat = @"cpu-usage-%d"; | ||
|
|
||
| NSString *const kSentryMetricProfilerSerializationUnitBytes = @"bytes"; | ||
| NSString *const kSentryMetricProfilerSerializationUnitBoolean = @"bool"; | ||
| NSString *const kSentryMetricProfilerSerializationUnitMemoryPressureEnum = @"memory-pressure-enum"; | ||
| NSString *const kSentryMetricProfilerSerializationUnitThermalStateEnum = @"thermal-state-enum"; | ||
| NSString *const kSentryMetricProfilerSerializationUnitPercentage = @"percent"; | ||
|
|
||
| namespace { | ||
| NSDictionary<NSString *, id> * | ||
| serializedValues(NSArray<NSDictionary<NSString *, NSNumber *> *> *values, NSString *unit) | ||
| { | ||
| return @ { @"unit" : unit, @"values" : values }; | ||
| } | ||
| } // namespace | ||
|
|
||
| @implementation SentryMetricProfiler { | ||
| NSTimer *_timer; | ||
|
|
||
| SentryNSProcessInfoWrapper *_processInfoWrapper; | ||
| SentrySystemWrapper *_systemWrapper; | ||
| SentryNSTimerWrapper *_timerWrapper; | ||
|
|
||
| /// arrays of readings keyed on NSNumbers representing the core number for the set of readings | ||
| NSMutableDictionary<NSNumber *, NSMutableArray<NSDictionary<NSString *, NSNumber *> *> *> | ||
| *_cpuUsage; | ||
|
|
||
| NSMutableArray<NSDictionary<NSString *, NSNumber *> *> *_memoryFootprint; | ||
| NSMutableArray<NSDictionary<NSString *, NSNumber *> *> *_thermalState; | ||
| NSMutableArray<NSDictionary<NSString *, NSNumber *> *> *_powerLevelState; | ||
| NSMutableArray<NSDictionary<NSString *, NSNumber *> *> *_memoryPressureState; | ||
| uint64_t _profileStartTime; | ||
| } | ||
|
|
||
| - (instancetype)initWithProfileStartTime:(uint64_t)profileStartTime | ||
| processInfoWrapper:(SentryNSProcessInfoWrapper *)processInfoWrapper | ||
| systemWrapper:(SentrySystemWrapper *)systemWrapper | ||
| timerWrapper:(SentryNSTimerWrapper *)timerWrapper | ||
| { | ||
| if (self = [super init]) { | ||
| _cpuUsage = [NSMutableDictionary<NSNumber *, | ||
| NSMutableArray<NSDictionary<NSString *, NSNumber *> *> *> | ||
| dictionary]; | ||
| const auto processorCount = processInfoWrapper.processorCount; | ||
| for (NSUInteger core = 0; core < processorCount; core++) { | ||
| _cpuUsage[@(core)] = [NSMutableArray<NSDictionary<NSString *, NSNumber *> *> array]; | ||
| } | ||
|
|
||
| _systemWrapper = systemWrapper; | ||
| _processInfoWrapper = processInfoWrapper; | ||
| _timerWrapper = timerWrapper; | ||
|
|
||
| _memoryFootprint = [NSMutableArray<NSDictionary<NSString *, NSNumber *> *> array]; | ||
| _thermalState = [NSMutableArray<NSDictionary<NSString *, NSNumber *> *> array]; | ||
| _powerLevelState = [NSMutableArray<NSDictionary<NSString *, NSNumber *> *> array]; | ||
| _memoryPressureState = [NSMutableArray<NSDictionary<NSString *, NSNumber *> *> array]; | ||
|
|
||
| _profileStartTime = profileStartTime; | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| - (void)dealloc | ||
| { | ||
| [self stop]; | ||
| } | ||
|
|
||
| # pragma mark - Public | ||
|
|
||
| - (void)start | ||
| { | ||
| [self registerSampler]; | ||
| [self registerStateChangeNotifications]; | ||
| [self registerMemoryPressureWarningHandler]; | ||
| } | ||
|
|
||
| - (void)stop | ||
| { | ||
| [_timer invalidate]; | ||
| [_systemWrapper deregisterMemoryPressureNotifications]; | ||
| [_processInfoWrapper stopMonitoring:self]; | ||
| } | ||
|
|
||
| - (NSMutableDictionary<NSString *, id> *)serialize | ||
| { | ||
| const auto dict = [NSMutableDictionary<NSString *, id> dictionary]; | ||
|
|
||
| if (_memoryFootprint.count > 0) { | ||
| dict[kSentryMetricProfilerSerializationKeyMemoryFootprint] | ||
| = serializedValues(_memoryFootprint, kSentryMetricProfilerSerializationUnitBytes); | ||
| } | ||
| if (_memoryPressureState.count > 0) { | ||
| dict[kSentryMetricProfilerSerializationKeyMemoryPressure] = serializedValues( | ||
| _memoryPressureState, kSentryMetricProfilerSerializationUnitMemoryPressureEnum); | ||
| } | ||
| if (_powerLevelState.count > 0) { | ||
| dict[kSentryMetricProfilerSerializationKeyPowerState] | ||
| = serializedValues(_powerLevelState, kSentryMetricProfilerSerializationUnitBoolean); | ||
| } | ||
| if (_thermalState.count > 0) { | ||
| dict[kSentryMetricProfilerSerializationKeyThermalState] = serializedValues( | ||
| _thermalState, kSentryMetricProfilerSerializationUnitThermalStateEnum); | ||
| } | ||
|
|
||
| [_cpuUsage enumerateKeysAndObjectsUsingBlock:^(NSNumber *_Nonnull core, | ||
| NSMutableArray<NSDictionary<NSString *, NSNumber *> *> *_Nonnull readings, | ||
| BOOL *_Nonnull stop) { | ||
| if (readings.count > 0) { | ||
| dict[[NSString stringWithFormat:kSentryMetricProfilerSerializationKeyCPUUsageFormat, | ||
| core.intValue]] | ||
| = serializedValues(readings, kSentryMetricProfilerSerializationUnitPercentage); | ||
| } | ||
| }]; | ||
|
|
||
| return dict; | ||
| } | ||
|
|
||
| # pragma mark - Private | ||
|
|
||
| - (void)registerSampler | ||
| { | ||
| __weak auto weakSelf = self; | ||
| _timer = [_timerWrapper scheduledTimerWithTimeInterval:kSentryMetricProfilerTimeseriesInterval | ||
| repeats:YES | ||
| block:^(NSTimer *_Nonnull timer) { | ||
| [weakSelf recordCPUPercentagePerCore]; | ||
| [weakSelf recordMemoryFootprint]; | ||
| }]; | ||
| } | ||
|
|
||
| /** | ||
| * This is a more fine-grained API, providing normal/warn/critical levels of memory usage, versus | ||
| * using `UIApplicationDidReceiveMemoryWarningNotification` which does not provide any additional | ||
| * information ("This notification does not contain a userInfo dictionary." from | ||
| * https://developer.apple.com/documentation/uikit/uiapplication/1622920-didreceivememorywarningnotificat). | ||
| */ | ||
| - (void)registerMemoryPressureWarningHandler | ||
| { | ||
| __weak auto weakSelf = self; | ||
| [_systemWrapper registerMemoryPressureNotifications:^(uintptr_t memoryPressureState) { | ||
| const auto strongSelf = weakSelf; | ||
| if (!strongSelf) { | ||
| return; | ||
| } | ||
| [strongSelf->_memoryPressureState | ||
| addObject:[strongSelf metricEntryForValue:@(memoryPressureState)]]; | ||
| }]; | ||
| } | ||
|
|
||
| - (void)registerStateChangeNotifications | ||
| { | ||
| // According to Apple docs: "To receive NSProcessInfoThermalStateDidChangeNotification, you must | ||
| // access the thermalState prior to registering for the notification." (from | ||
| // https://developer.apple.com/documentation/foundation/nsprocessinfothermalstatedidchangenotification/) | ||
| [self recordThermalState]; | ||
|
|
||
| [_processInfoWrapper monitorForThermalStateChanges:self callback:@selector(recordThermalState)]; | ||
|
|
||
| if (@available(macOS 12.0, *)) { | ||
| [_processInfoWrapper monitorForPowerStateChanges:self | ||
| callback:@selector(recordPowerLevelState)]; | ||
| } | ||
| } | ||
|
|
||
| - (void)recordThermalState | ||
| { | ||
| [_thermalState addObject:[self metricEntryForValue:@(_processInfoWrapper.thermalState)]]; | ||
| } | ||
|
|
||
| - (void)recordPowerLevelState | ||
| { | ||
| if (@available(macOS 12.0, *)) { | ||
| [_powerLevelState | ||
| addObject:[self metricEntryForValue:@(_processInfoWrapper.isLowPowerModeEnabled)]]; | ||
| } | ||
| } | ||
|
|
||
| - (void)recordMemoryFootprint | ||
| { | ||
| NSError *error; | ||
| const auto footprintBytes = [_systemWrapper memoryFootprintBytes:&error]; | ||
|
|
||
| if (error) { | ||
| SENTRY_LOG_ERROR(@"Failed to read memory footprint: %@", error); | ||
| return; | ||
| } | ||
|
|
||
| [_memoryFootprint addObject:[self metricEntryForValue:@(footprintBytes)]]; | ||
| } | ||
|
|
||
| - (void)recordCPUPercentagePerCore | ||
| { | ||
| NSError *error; | ||
| const auto result = [_systemWrapper cpuUsagePerCore:&error]; | ||
|
|
||
| if (error) { | ||
| SENTRY_LOG_ERROR(@"Failed to read CPU usages: %@", error); | ||
| return; | ||
| } | ||
|
|
||
| SENTRY_LOG_DEBUG(@"Reporting CPU usages: %@", result); | ||
|
|
||
| [result enumerateObjectsUsingBlock:^(NSNumber *_Nonnull usage, NSUInteger core, | ||
| BOOL *_Nonnull stop) { [_cpuUsage[@(core)] addObject:[self metricEntryForValue:usage]]; }]; | ||
| } | ||
|
|
||
| - (NSDictionary<NSString *, NSNumber *> *)metricEntryForValue:(NSNumber *)value | ||
| { | ||
| return @{ | ||
| @"value" : value, | ||
| @"elapsed_since_start_ns" : @(getDurationNs(_profileStartTime, getAbsoluteTime())) | ||
| }; | ||
| } | ||
|
|
||
| @end | ||
|
|
||
| #endif // SENTRY_TARGET_PROFILING_SUPPORTED |
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.