Tắt tính năng Giám sát hiệu suất Firebase


Để cho phép người dùng chọn sử dụng hoặc không sử dụng Firebase Performance Monitoring, bạn nên thiết lập ứng dụng để có thể bật và tắt Performance Monitoring. Bạn cũng có thể thấy chức năng này hữu ích trong quá trình phát triển và kiểm thử ứng dụng.

Sau đây là một số lựa chọn mà bạn có thể cân nhắc:

  • Bạn có thể tắt SDK Performance Monitoring khi xây dựng ứng dụng, với tuỳ chọn bật lại SDK đó trong thời gian chạy.

  • Bạn có thể tạo ứng dụng bằng cách bật SDK Performance Monitoring nhưng có thể tắt SDK đó trong thời gian chạy bằng Firebase Remote Config.

  • Bạn có thể huỷ kích hoạt hoàn toàn SDK Performance Monitoring mà không có lựa chọn nào để bật SDK này trong thời gian chạy.

Tắt Performance Monitoring trong quá trình tạo ứng dụng

Một trường hợp mà việc tắt Performance Monitoring trong quá trình xây dựng ứng dụng có thể hữu ích là để tránh báo cáo dữ liệu hiệu suất từ phiên bản phát hành trước của ứng dụng trong quá trình phát triển và thử nghiệm ứng dụng.

Để tắt hoặc huỷ kích hoạt Performance Monitoring, bạn có thể thêm một trong hai khoá vào tệp danh sách thuộc tính (Info.plist) cho ứng dụng Apple:

  • Để tắt Performance Monitoring nhưng cho phép ứng dụng bật trong thời gian chạy, hãy đặt firebase_performance_collection_enabled thành false trong tệp Info.plist của ứng dụng.

  • Để vô hiệu hoá hoàn toàn Performance Monitoring mà không có tuỳ chọn bật trong thời gian chạy, hãy đặt firebase_performance_collection_deactivated thành true trong tệp Info.plist của ứng dụng.

Tắt ứng dụng trong thời gian chạy bằng Remote Config

Firebase Remote Config cho phép bạn thay đổi hành vi và giao diện của ứng dụng. Vì vậy, đây là một cách lý tưởng để cho phép bạn tắt Performance Monitoring trong các thực thể đã triển khai của ứng dụng.

Để tắt tính năng thu thập dữ liệu Performance Monitoring vào lần tiếp theo ứng dụng của Apple khởi động, hãy sử dụng mã ví dụ như bên dưới. Để biết thêm thông tin về cách sử dụng Remote Config trong ứng dụng Apple, hãy xem phần Sử dụng Firebase Remote Config trên các nền tảng của Apple.

  1. Đảm bảo rằng bạn đang dùng Remote Config trong Podfile:

    pod 'Firebase/RemoteConfig'

  2. Thêm nội dung sau vào đầu tệp AppDelegate của ứng dụng:

    Swift

    Lưu ý: Sản phẩm Firebase này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    import FirebaseRemoteConfig

    Objective-C

    Lưu ý: Sản phẩm Firebase này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    @import FirebaseRemoteConfig;

  3. Trong tệp AppDelegate, hãy thêm mã sau vào các câu lệnh launchOptions trong phương thức thực thể application:didFinishLaunchingWithOptions::

    Swift

    Lưu ý: Sản phẩm này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    remoteConfig = RemoteConfig.remoteConfig()
// You can change the "false" below to "true" to permit more fetches when validating
// your app, but you should change it back to "false" or remove this statement before
// distributing your app in production.
let remoteConfigSettings = RemoteConfigSettings(developerModeEnabled: false)
remoteConfig.configSettings = remoteConfigSettings!
// Load in-app defaults from a plist file that sets perf_disable to false until
// you update values in the Firebase console.
remoteConfig.setDefaultsFromPlistFileName("RemoteConfigDefaults")
// Important! This needs to be applied before FirebaseApp.configure()
if !remoteConfig["perf_disable"].boolValue {
    // The following line disables all automatic (out-of-the-box) monitoring
    Performance.sharedInstance().isInstrumentationEnabled = false
    // The following line disables all custom monitoring
    Performance.sharedInstance().isDataCollectionEnabled = false
}
else {
    Performance.sharedInstance().isInstrumentationEnabled = true
    Performance.sharedInstance().isDataCollectionEnabled = true
}
// Use Firebase library to configure APIs
FirebaseApp.configure()

    Objective-C

    Lưu ý: Sản phẩm Firebase này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    self.remoteConfig = [FIRRemoteConfig remoteConfig];
// You can change the NO below to YES to permit more fetches when validating
// your app, but you should change it back to NO or remove this statement before
// distributing your app in production.
FIRRemoteConfigSettings *remoteConfigSettings =
    [[FIRRemoteConfigSettings alloc] initWithDeveloperModeEnabled:NO];
self.remoteConfig.configSettings = remoteConfigSettings;
// Load in-app defaults from a plist file that sets perf_disable to false until
// you update values in the Firebase console.
[self.remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];
// Important! This needs to be applied before [FIRApp configure]
if (!self.remoteConfig[@"perf_disable"].numberValue.boolValue) {
    // The following line disables all automatic (out-of-the-box) monitoring
    [FIRPerformance sharedInstance].instrumentationEnabled = NO;
    // The following line disables all custom monitoring
    [FIRPerformance sharedInstance].dataCollectionEnabled = NO;
}
else {
    [FIRPerformance sharedInstance].instrumentationEnabled = YES;
    [FIRPerformance sharedInstance].dataCollectionEnabled = YES;
}
// Use Firebase library to configure APIs
[FIRApp configure];

  4. Trong ViewController.m hoặc một tệp triển khai khác mà ứng dụng của bạn dùng, hãy thêm mã sau để tìm nạp và kích hoạt các giá trị Remote Config:

    Swift

    Lưu ý: Sản phẩm Firebase này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    //RemoteConfig fetch and activation in your app, shortly after startup
remoteConfig.fetch(withExpirationDuration: TimeInterval(30.0)) { (status, error) -> Void in
  if status == .success {
    print("Config fetched!")
    self.remoteConfig.activateFetched()
  } else {
    print("Config not fetched")
    print("Error \(error!.localizedDescription)")
  }
}

    Objective-C

    Lưu ý: Sản phẩm Firebase này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    //RemoteConfig fetch and activation in your app, shortly after startup
[self.remoteConfig fetchWithExpirationDuration:30.0 completionHandler:^(FIRRemoteConfigFetchStatus status, NSError *error) {
  if (status == FIRRemoteConfigFetchStatusSuccess) {
    NSLog(@"Config fetched!");
    [self.remoteConfig activateFetched];
  } else {
    NSLog(@"Config not fetched");
    NSLog(@"Error %@", error.localizedDescription);
  }
}];

  5. Để tắt Performance Monitoring trong bảng điều khiển Firebase, hãy tạo tham số perf_disable trong dự án của ứng dụng, sau đó đặt giá trị của tham số đó thành true.

    Nếu bạn đặt giá trị của perf_disable thành false, thì Performance Monitoring vẫn được bật.

Tắt riêng tính năng thu thập dữ liệu tự động hoặc tuỳ chỉnh

Bạn có thể thực hiện một số thay đổi đối với mã nêu trên và trong bảng điều khiển Firebase để cho phép tắt tất cả tính năng giám sát tự động (ngay lập tức) một cách riêng biệt với tính năng giám sát tuỳ chỉnh.

  1. Thêm mã sau vào câu lệnh launchOptions trong phương thức thực thể application:didFinishLaunchingWithOptions: (thay vì nội dung hiển thị ở trên cho cùng một phương thức thực thể):

    Swift

    Lưu ý: Sản phẩm Firebase này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    remoteConfig = FIRRemoteConfig.remoteConfig()
let remoteConfigSettings = FIRRemoteConfigSettings(developerModeEnabled: true)
remoteConfig.configSettings = remoteConfigSettings!
// Important! This needs to be applied before FirebaseApp.configure()
if remoteConfig["perf_disable_auto"].boolValue {
    // The following line disables all automatic (out-of-the-box) monitoring
    Performance.sharedInstance().isInstrumentationEnabled = false
}
else {
    Performance.sharedInstance().isInstrumentationEnabled = true
}
if remoteConfig["perf_disable_manual"].boolValue {
    // The following line disables all custom monitoring
    Performance.sharedInstance().isDataCollectionEnabled = false
}
else {
    Performance.sharedInstance().isDataCollectionEnabled = true
}
// Use Firebase library to configure APIs
FirebaseApp.configure()

    Objective-C

    Lưu ý: Sản phẩm Firebase này không dùng được trên các mục tiêu macOS, Mac Catalyst, watchOS. 
    self.remoteConfig = [FIRRemoteConfig remoteConfig];
FIRRemoteConfigSettings *remoteConfigSettings =
    [[FIRRemoteConfigSettings alloc] initWithDeveloperModeEnabled:YES];
self.remoteConfig.configSettings = remoteConfigSettings;
// Important! This needs to be applied before [FirebaseApp configure]
if (self.remoteConfig[@"perf_disable_auto"].numberValue.boolValue) {
    // The following line disables all automatic (out-of-the-box) monitoring
    [FIRPerformance sharedInstance].instrumentationEnabled = NO;
}
else {
    [FIRPerformance sharedInstance].instrumentationEnabled = YES;
}
if (self.remoteConfig[@"perf_disable_manual"].numberValue.boolValue) {
    // The following line disables all custom monitoring
    [FIRPerformance sharedInstance].dataCollectionEnabled = NO;
}
else {
    [FIRPerformance sharedInstance].dataCollectionEnabled = YES;
}
// Use Firebase library to configure APIs
[FirebaseApp configure];

  2. Hoàn tất các bước sau trong bảng điều khiển Firebase:

    • Để tắt tất cả tính năng giám sát tự động (có sẵn), hãy tạo một thông số perf_disable_auto trong dự án của ứng dụng, sau đó đặt giá trị của thông số đó thành true.
    • Để tắt tất cả tính năng giám sát tuỳ chỉnh, hãy tạo một thông số perf_disable_manual trong dự án của ứng dụng, sau đó đặt giá trị của thông số đó thành true.