// Copyright 2020 The Chromium Authors // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #import "ios/chrome/app/application_delegate/metric_kit_subscriber.h" #import "base/apple/foundation_util.h" #import "base/files/file_path.h" #import "base/functional/bind.h" #import "base/metrics/histogram_base.h" #import "base/metrics/histogram_functions.h" #import "base/numerics/safe_conversions.h" #import "base/path_service.h" #import "base/strings/sys_string_conversions.h" #import "base/task/task_traits.h" #import "base/task/thread_pool.h" #import "base/time/time.h" #import "base/version.h" #import "components/crash/core/app/crashpad.h" #import "components/crash/core/common/reporter_running_ios.h" #import "components/previous_session_info/previous_session_info.h" #import "components/version_info/version_info.h" #import "ios/chrome/browser/crash_report/model/features.h" #import "ios/chrome/browser/metrics/model/activity_reporter.h" #import "ios/chrome/browser/metrics/model/histogram_bridge.h" namespace { // Task identifier for tracking startup until the app becomes interactive. NSString* const kMainLaunchTaskId = @"MainLaunchTask"; void ReportExitReason(base::HistogramBase* histogram, MetricKitExitReason bucket, NSUInteger count) { if (!count) { return; } histogram->AddCount(base::saturated_cast(bucket), base::saturated_cast(count)); } void ReportLongDuration(const std::string& histogram_name, NSMeasurement* measurement) { if (!measurement) { return; } double value = [measurement measurementByConvertingToUnit:NSUnitDuration.seconds] .doubleValue; base::UmaHistogramCustomTimes(histogram_name, base::Seconds(value), base::Seconds(1), base::Seconds(86400 /* secs per day */), 50); } void ReportMemory(const std::string& histogram_name, NSMeasurement* measurement) { if (!measurement) { return; } double value = [measurement measurementByConvertingToUnit:NSUnitInformationStorage.megabytes] .doubleValue; base::UmaHistogramMemoryLargeMB(histogram_name, value); } // Sends a compressed external diagnostic dump to Crashpad using pre-cached // base annotations to avoid redundant string conversions and lock contention. void SendDiagnostic( MXDiagnostic* diagnostic, const std::string& type, const std::map& base_annotations) { base::FilePath cache_dir_path; if (!base::PathService::Get(base::DIR_CACHE, &cache_dir_path)) { return; } // Deflate the payload. NSError* error = nil; NSData* payload = [diagnostic.JSONRepresentation compressedDataUsingAlgorithm:NSDataCompressionAlgorithmZlib error:&error]; if (!payload) { return; } base::span spanpayload = base::apple::NSDataToSpan(payload); std::map override_annotations = base_annotations; override_annotations["ver"] = base::SysNSStringToUTF8(diagnostic.metaData.applicationBuildVersion); override_annotations["metrickit_type"] = type; const std::string source = type == "crash" ? "MetricKit" : "MetricKit_Diagnostics"; crash_reporter::ProcessExternalDump(source, spanpayload, override_annotations); } // Iterates through diagnostic payloads and exports reports to Crashpad. void ProcessDiagnosticPayloads(NSArray* payloads) { if (!crash_reporter::IsCrashpadRunning()) { return; } PreviousSessionInfo* previous_session = [PreviousSessionInfo sharedInstance]; NSDictionary* report_parameters = [previous_session.reportParameters copy]; NSString* breadcrumbs = [previous_session.breadcrumbs copy]; std::map base_annotations; base_annotations["metrickit"] = "true"; for (NSString* key in report_parameters.allKeys) { base_annotations[base::SysNSStringToUTF8(key)] = base::SysNSStringToUTF8(report_parameters[key]); } if (breadcrumbs) { base_annotations["breadcrumbs"] = base::SysNSStringToUTF8(breadcrumbs); } for (MXDiagnosticPayload* payload in payloads) { for (MXCrashDiagnostic* diagnostic in payload.crashDiagnostics) { SendDiagnostic(diagnostic, "crash", base_annotations); } if (base::FeatureList::IsEnabled(kMetrickitNonCrashReport)) { for (MXCPUExceptionDiagnostic* diagnostic in payload .cpuExceptionDiagnostics) { SendDiagnostic(diagnostic, "cpu-exception", base_annotations); } for (MXHangDiagnostic* diagnostic in payload.hangDiagnostics) { SendDiagnostic(diagnostic, "hang", base_annotations); } for (MXDiskWriteExceptionDiagnostic* diagnostic in payload .diskWriteExceptionDiagnostics) { SendDiagnostic(diagnostic, "diskwrite-exception", base_annotations); } for (MXCPUExceptionDiagnostic* diagnostic in payload .appLaunchDiagnostics) { SendDiagnostic(diagnostic, "app-launch", base_annotations); } } } } // Record MXPayload data even when the version is mismatched. const char kHistogramPrefixIncludingMismatch[] = "IOS.MetricKit.IncludingMismatch."; const char kHistogramPrefix[] = "IOS.MetricKit."; std::string HistogramPrefix(bool include_mismatch) { return include_mismatch ? kHistogramPrefixIncludingMismatch : kHistogramPrefix; } } // namespace @implementation MetricKitSubscriber + (instancetype)sharedInstance { static MetricKitSubscriber* instance = [[MetricKitSubscriber alloc] init]; return instance; } + (void)createExtendedLaunchTask { [MXMetricManager extendLaunchMeasurementForTaskID:kMainLaunchTaskId error:nil]; } + (void)endExtendedLaunchTask { [MXMetricManager finishExtendedLaunchMeasurementForTaskID:kMainLaunchTaskId error:nil]; } - (void)setEnabled:(BOOL)enable { if (enable == _enabled) { return; } _enabled = enable; if (enable) { [[MXMetricManager sharedManager] addSubscriber:self]; } else { [[MXMetricManager sharedManager] removeSubscriber:self]; } if (@available(iOS 27.0, *)) { [[MetricKitReportSubscriber sharedInstance] setEnabled:enable]; } } - (void)didReceiveMetricPayloads:(NSArray*)payloads { for (MXMetricPayload* payload : payloads) { [self processPayload:payload]; } } - (void)logStartupDurationMXHistogram:(MXHistogram*)histogram toUMAHistogram:(const std::string&)histogramUMAName { if (!histogram || !histogram.totalBucketCount) { return; } // It should take less than 1 minute to startup. // Histogram is defined in millisecond granularity. base::HistogramBase* histogramUMA = base::Histogram::FactoryTimeGet( histogramUMAName, base::Milliseconds(1), base::Minutes(1), 50, base::HistogramBase::kUmaTargetedHistogramFlag); for (MXHistogramBucket* bucket in [histogram bucketEnumerator]) { // MXHistogram structure is linear and the bucket size is not guaranteed to // never change. As the granularity is small in the current iOS version, // (10ms) they are reported using a representative value of the bucket. // DCHECK on the size of the bucket to detect if the resolution decrease. // Time based MXHistogram report their values using `UnitDuration` which has // seconds as base unit. Hence, start and end are given in seconds. double start = [bucket.bucketStart measurementByConvertingToUnit:NSUnitDuration.milliseconds] .doubleValue; double end = [bucket.bucketEnd measurementByConvertingToUnit:NSUnitDuration.milliseconds] .doubleValue; // DCHECKS that resolution is less than 10ms. // Note: Real paylods use 10ms resolution but the simulated payload in Xcode // uses 100ms resolution so it will trigger this DCHECK. DCHECK_LE(end - start, 10); double sample = (end + start) / 2; histogramUMA->AddCount( base::saturated_cast(sample), bucket.bucketCount); } } - (void)logForegroundExit:(MXForegroundExitData*)exitData histogramPrefix:(const std::string&)prefix { int exclusive_max = static_cast(MetricKitExitReasonMaxValue) + 1; base::HistogramBase* histogramUMA = base::LinearHistogram::FactoryGet( prefix + "ForegroundExitData", 1, exclusive_max, static_cast(exclusive_max + 1), base::HistogramBase::kUmaTargetedHistogramFlag); ReportExitReason(histogramUMA, MetricKitExitReasonNormal, exitData.cumulativeNormalAppExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonAbnormal, exitData.cumulativeAbnormalExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonWatchdog, exitData.cumulativeAppWatchdogExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonMemoryLimit, exitData.cumulativeMemoryResourceLimitExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonBadAccess, exitData.cumulativeBadAccessExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonIllegalInstruction, exitData.cumulativeIllegalInstructionExitCount); } - (void)logBackgroundExit:(MXBackgroundExitData*)exitData histogramPrefix:(const std::string&)prefix { int exclusive_max = static_cast(MetricKitExitReasonMaxValue) + 1; base::HistogramBase* histogramUMA = base::LinearHistogram::FactoryGet( prefix + "BackgroundExitData", 1, exclusive_max, static_cast(exclusive_max + 1), base::HistogramBase::kUmaTargetedHistogramFlag); ReportExitReason(histogramUMA, MetricKitExitReasonNormal, exitData.cumulativeNormalAppExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonAbnormal, exitData.cumulativeAbnormalExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonWatchdog, exitData.cumulativeAppWatchdogExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonCpuLimit, exitData.cumulativeCPUResourceLimitExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonMemoryLimit, exitData.cumulativeMemoryResourceLimitExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonMemoryPressure, exitData.cumulativeMemoryPressureExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonSuspendedWithLockedFile, exitData.cumulativeSuspendedWithLockedFileExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonBadAccess, exitData.cumulativeBadAccessExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonIllegalInstruction, exitData.cumulativeIllegalInstructionExitCount); ReportExitReason(histogramUMA, MetricKitExitReasonBackgroundTaskAssertionTimeout, exitData.cumulativeBackgroundTaskAssertionTimeoutExitCount); } - (void)processPayload:(MXMetricPayload*)payload { if (!payload.includesMultipleApplicationVersions && base::SysNSStringToUTF8(payload.metaData.applicationBuildVersion) == version_info::GetVersionNumber()) { [self processPayload:payload withHistogramPrefix:HistogramPrefix(false)]; } [self processPayload:payload withHistogramPrefix:HistogramPrefix(true)]; } - (void)processPayload:(MXMetricPayload*)payload withHistogramPrefix:(const std::string&)prefix { ReportLongDuration(prefix + "ForegroundTimePerDay", payload.applicationTimeMetrics.cumulativeForegroundTime); ReportLongDuration(prefix + "BackgroundTimePerDay", payload.applicationTimeMetrics.cumulativeBackgroundTime); ReportLongDuration(prefix + "CPUTimePerDay", payload.cpuMetrics.cumulativeCPUTime); ReportMemory(prefix + "AverageSuspendedMemory", payload.memoryMetrics.averageSuspendedMemory.averageMeasurement); ReportMemory(prefix + "PeakMemoryUsage", payload.memoryMetrics.peakMemoryUsage); MXHistogram* histogrammedApplicationResumeTime = payload.applicationLaunchMetrics.histogrammedApplicationResumeTime; [self logStartupDurationMXHistogram:histogrammedApplicationResumeTime toUMAHistogram:prefix + "ApplicationResumeTime"]; MXHistogram* histogrammedTimeToFirstDraw = payload.applicationLaunchMetrics.histogrammedTimeToFirstDraw; [self logStartupDurationMXHistogram:histogrammedTimeToFirstDraw toUMAHistogram:prefix + "TimeToFirstDraw"]; MXHistogram* histogrammedOptimizedTimeToFirstDraw = payload.applicationLaunchMetrics.histogrammedOptimizedTimeToFirstDraw; [self logStartupDurationMXHistogram:histogrammedOptimizedTimeToFirstDraw toUMAHistogram:prefix + "OptimizedTimeToFirstDraw"]; MXHistogram* histogrammedExtendedLaunch = payload.applicationLaunchMetrics.histogrammedExtendedLaunch; [self logStartupDurationMXHistogram:histogrammedExtendedLaunch toUMAHistogram:prefix + "ExtendedLaunch"]; MXHistogram* histogrammedApplicationHangTime = payload.applicationResponsivenessMetrics.histogrammedApplicationHangTime; [self logStartupDurationMXHistogram:histogrammedApplicationHangTime toUMAHistogram:prefix + "ApplicationHangTime"]; [self logForegroundExit:payload.applicationExitMetrics.foregroundExitData histogramPrefix:prefix]; [self logBackgroundExit:payload.applicationExitMetrics.backgroundExitData histogramPrefix:prefix]; } - (void)didReceiveDiagnosticPayloads:(NSArray*)payloads { base::ThreadPool::PostTask( FROM_HERE, {base::TaskPriority::BEST_EFFORT, base::TaskShutdownBehavior::CONTINUE_ON_SHUTDOWN, base::ThreadPolicy::PREFER_BACKGROUND, base::MayBlock()}, base::BindOnce(ProcessDiagnosticPayloads, payloads)); } @end