Bắt đầu với Giám sát hiệu suất dành cho Android

Trước khi bắt đầu

Nếu bạn chưa có, hãy thêm Firebase vào dự án Android của bạn .

Bước 1 : Thêm SDK giám sát hiệu suất vào ứng dụng của bạn

Sau khi bạn thêm SDK giám sát hiệu suất, Firebase sẽ tự động bắt đầu thu thập dữ liệu về hiển thị màn hình của ứng dụng và dữ liệu liên quan đến vòng đời ứng dụng của bạn (như thời gian bắt đầu ứng dụng ). Để bật Firebase giám sát các yêu cầu mạng, bạn cũng phải thêm plugin Gradle giám sát hiệu suất (bước tiếp theo).

  1. Trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle ), hãy thêm phần phụ thuộc cho Giám sát hiệu suất thư viện dành cho Android. Chúng tôi khuyên bạn nên sử dụng BoM Android của Firebase để kiểm soát việc tạo phiên bản thư viện.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.7.0"))
    
        // Add the dependency for the Performance Monitoring library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-perf")
    }
    

    Bằng cách sử dụng Firebase Android BoM , ứng dụng của bạn sẽ luôn sử dụng các phiên bản tương thích của thư viện Firebase Android.

    (Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần sử dụng BoM

    Nếu chọn không sử dụng BoM Firebase, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc của nó.

    Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện nhằm đảm bảo rằng tất cả các phiên bản đều tương thích.

    dependencies {
        // Add the dependency for the Performance Monitoring library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-perf:20.5.1")
    }
    
    Bạn đang tìm mô-đun thư viện dành riêng cho Kotlin? Bắt đầu từ tháng 10 năm 2023 (Firebase BoM 32.5.0) , cả nhà phát triển Kotlin và Java đều có thể phụ thuộc vào mô-đun thư viện chính (để biết chi tiết, hãy xem Câu hỏi thường gặp về sáng kiến ​​này ).

  2. Biên dịch lại ứng dụng của bạn.

Bước 2 : Thêm plugin Gradle giám sát hiệu suất vào ứng dụng của bạn

Sau khi bạn thêm plugin Giám sát hiệu suất cho Gradle, Firebase sẽ tự động bắt đầu thu thập dữ liệu cho các yêu cầu mạng HTTP/S . Plugin cũng cho phép bạn thiết lập các dấu vết mã tùy chỉnh bằng cách sử dụng chú thích @AddTrace .

  1. Trong tệp Gradle cấp cơ sở (cấp dự án) ( <project>/build.gradle.kts hoặc <project>/build.gradle ), hãy thêm plugin Gradle giám sát hiệu suất:

    Kotlin

    plugins {
        // To benefit from the latest Performance Monitoring plugin features,
        // update your Android Gradle plugin dependency to at least v3.4.0
        id("com.android.application") version "7.3.0" apply false
    
        // Make sure that you have the Google services Gradle plugin dependency
        id("com.google.gms.google-services") version "4.4.0" apply false
    
        // Add the dependency for the Performance Monitoring Gradle plugin
        id("com.google.firebase.firebase-perf") version "1.4.2" apply false
    }
    

    Groovy

    plugins {
        // To benefit from the latest Performance Monitoring plugin features,
        // update your Android Gradle plugin dependency to at least v3.4.0
        id 'com.android.application' version '7.3.0' apply false
    
        // Make sure that you have the Google services Gradle plugin dependency
        id 'com.google.gms.google-services' version '4.4.0' apply false
    
        // Add the dependency for the Performance Monitoring Gradle plugin
        id 'com.google.firebase.firebase-perf' version '1.4.2' apply false
    }
    
  2. Trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle ), hãy thêm plugin Gradle giám sát hiệu suất:

    Kotlin

    plugins {
        id("com.android.application")
    
        // Make sure that you have the Google services Gradle plugin
        id("com.google.gms.google-services")
    
        // Add the Performance Monitoring Gradle plugin
        id("com.google.firebase.firebase-perf")
        ...
    }
    

    Groovy

    plugins {
        id 'com.android.application'
    
        // Make sure that you have the Google services Gradle plugin
        id 'com.google.gms.google-services'
    
        // Add the Performance Monitoring Gradle plugin
        id 'com.google.firebase.firebase-perf'
        ...
    }
    
  3. Biên dịch lại ứng dụng của bạn.

Bước 3 : Tạo các sự kiện hiệu suất để hiển thị dữ liệu ban đầu

Firebase bắt đầu xử lý các sự kiện khi bạn thêm SDK vào ứng dụng của mình thành công. Nếu bạn vẫn đang phát triển cục bộ, hãy tương tác với ứng dụng của bạn để tạo sự kiện cho việc thu thập và xử lý dữ liệu ban đầu.

  1. Tạo sự kiện bằng cách chuyển đổi ứng dụng của bạn giữa nền và nền trước nhiều lần, tương tác với ứng dụng của bạn bằng cách điều hướng trên các màn hình và/hoặc kích hoạt các yêu cầu mạng.

  2. Chuyển đến trang tổng quan Hiệu suất của bảng điều khiển Firebase. Bạn sẽ thấy hiển thị dữ liệu ban đầu của mình trong vòng vài phút.

    Nếu bạn không thấy hiển thị dữ liệu ban đầu của mình, hãy xem lại các mẹo khắc phục sự cố .

Bước 4 : (Tùy chọn) Xem thông báo nhật ký cho các sự kiện hiệu suất

  1. Bật tính năng ghi nhật ký gỡ lỗi cho Giám sát hiệu suất tại thời điểm xây dựng bằng cách thêm phần tử <meta-data> vào tệp AndroidManifest.xml của ứng dụng, như sau:

    <application>
        <meta-data
          android:name="firebase_performance_logcat_enabled"
          android:value="true" />
    </application>
    
  2. Kiểm tra thông điệp tường trình của bạn xem có thông báo lỗi nào không.

  3. Giám sát hiệu suất gắn thẻ thông điệp tường trình của nó với FirebasePerformance . Bằng cách sử dụng tính năng lọc logcat, bạn có thể xem cụ thể dấu vết thời lượng và ghi nhật ký yêu cầu mạng HTTP/S bằng cách chạy lệnh sau:

    adb logcat -s FirebasePerformance
  4. Kiểm tra các loại nhật ký sau để biết rằng Giám sát hiệu suất đang ghi nhật ký các sự kiện hiệu suất:

    • Logging trace metric: TRACE_NAME , FIREBASE_PERFORMANCE_CONSOLE_URL
    • Logging network request trace: URL
  5. Nhấp vào URL để xem dữ liệu của bạn trong bảng điều khiển Firebase. Có thể mất vài phút để dữ liệu cập nhật trên trang tổng quan.

Nếu ứng dụng của bạn không ghi nhật ký các sự kiện hiệu suất, hãy xem lại mẹo khắc phục sự cố .

Bước 5 : (Tùy chọn) Thêm giám sát tùy chỉnh cho mã cụ thể

Để giám sát dữ liệu hiệu suất được liên kết với mã cụ thể trong ứng dụng của bạn, bạn có thể thiết lập các dấu vết mã tùy chỉnh .

Với dấu vết mã tùy chỉnh, bạn có thể đo khoảng thời gian ứng dụng của bạn hoàn thành một tác vụ hoặc một nhóm tác vụ cụ thể, chẳng hạn như tải một tập hợp hình ảnh hoặc truy vấn cơ sở dữ liệu của bạn. Số liệu mặc định cho dấu vết mã tùy chỉnh là thời lượng của nó, nhưng bạn cũng có thể thêm số liệu tùy chỉnh, chẳng hạn như số lần truy cập bộ đệm và cảnh báo bộ nhớ.

Trong mã của mình, bạn xác định phần đầu và phần cuối của dấu vết mã tùy chỉnh (và thêm bất kỳ số liệu tùy chỉnh mong muốn nào) bằng cách sử dụng API do SDK giám sát hiệu suất cung cấp. Đối với ứng dụng Android, bạn cũng có thể theo dõi thời lượng của các phương pháp cụ thể bằng cách sử dụng chú thích @AddTrace .

Hãy truy cập Thêm giám sát cho mã cụ thể để tìm hiểu thêm về các tính năng này và cách thêm chúng vào ứng dụng của bạn.

Bước 6 : Triển khai ứng dụng của bạn sau đó xem xét kết quả

Sau khi xác thực tính năng Giám sát hiệu suất bằng một hoặc nhiều thiết bị thử nghiệm, bạn có thể triển khai phiên bản cập nhật của ứng dụng cho người dùng của mình.

Bạn có thể theo dõi dữ liệu hiệu suất trong bảng điều khiển Hiệu suất của bảng điều khiển Firebase.

Các vấn đề đã biết

  • Plugin Giám sát hiệu suất cho Gradle v1.1.0 có thể gây ra sự không khớp trong các phần phụ thuộc của Guava, dẫn đến lỗi sau:

    Error:Execution failed for task ':app:packageInstantRunResourcesDebug'.
    > com.google.common.util.concurrent.MoreExecutors.directExecutor()Ljava/util/concurrent/Executor;

    Nếu bạn thấy lỗi này, bạn có thể:

    • Nâng cấp plugin Giám sát hiệu suất lên v1.1.1 trở lên (mới nhất là v1.4.2).

    • Thay thế dòng phụ thuộc plugin Giám sát hiệu suất trong tệp Gradle cấp cơ sở (cấp dự án) của bạn ( <project>/build.gradle.kts hoặc <project>/build.gradle ), như sau:

      Kotlin

      buildscript {
        // ...
      
        dependencies {
          // ...
      
          // Replace the standard Performance Monitoring plugin dependency line, as follows:
          classpath("com.google.firebase:perf-plugin:1.1.0") {
              exclude(group = "com.google.guava", module = "guava-jdk5")
          }
        }
      }
      

      Groovy

      buildscript {
        // ...
      
        dependencies {
          // ...
      
          // Replace the standard Performance Monitoring plugin dependency line, as follows:
          classpath('com.google.firebase:perf-plugin:1.1.0') {
              exclude group: 'com.google.guava', module: 'guava-jdk5'
          }
        }
      }
      
  • Giám sát hiệu suất báo cáo tổng kích thước tải trọng cho các yêu cầu mạng HTTP dựa trên giá trị được đặt trong tiêu đề độ dài nội dung HTTP. Giá trị này có thể không phải lúc nào cũng chính xác.

  • Giám sát hiệu suất chỉ hỗ trợ quy trình chính trong ứng dụng Android nhiều quy trình.

Bước tiếp theo