Firebase 性能监控使用入门 (Android)

准备工作

将 Firebase 添加到您的 Android 项目（如果尚未添加）。

请务必在项目级 build.gradle file 文件中的 buildscript 和 allprojects 部分添加 Google 的 Maven 代码库。

第 1 步：将 Performance Monitoring SDK 添加到您的应用

借助 Performance Monitoring SDK，您可以监控应用中的自动时长跟踪记录及任何其他自定义跟踪记录。

1. 在您的模块（应用级）Gradle 文件（通常是 app/build.gradle）中：

   // ...
   
   dependencies {
     // ...
   
     implementation 'com.google.firebase:firebase-core:17.0.1'
   
     // Add the dependency for the Performance Monitoring library
     implementation 'com.google.firebase:firebase-perf:18.0.1'
   }
   

2. 重新编译您的应用。

注意：在将 Performance Monitoring SDK 添加到应用时，Remote Config SDK 会作为依赖项一并添加。如果您已在使用远程配置，则不会发现任何不同。但如果您是初次使用远程配置，请浏览远程配置文档，以详细了解您将能够在应用中使用的各种新增功能。

第 2 步：将性能监控插件添加到您的应用

性能监控 Gradle 插件会启用检测 (instrumentation) 技术，以实现 @AddTrace 注释处理及 HTTP/HTTPS 网络请求自动监控。

性能监控插件的工作原理

在您的代码转换为 DEX 文件之前，性能监控插件会使用 Transform API 和 ASM 字节码检测框架来访问您应用的已编译类文件并进行代码检测（用于衡量性能）。检测代码所需的时间主要取决于类的数量和大小。

如果应用编译所需时间超出您的预期，请考虑以下选项：

• 在编译时为您的调试版本停用性能监控插件
• 模块化代码以优化构建速度

v2.0.0 已弃用 firebase-plugins。
您必须按照以下步骤所示明确添加性能监控插件。

要将性能监控插件添加到您的应用，请执行以下操作：

1. 在您的模块（应用级）Gradle 文件（通常是 app/build.gradle）中：

   apply plugin: 'com.android.application'
   // Apply the Performance Monitoring plugin
   apply plugin: 'com.google.firebase.firebase-perf'
   
   dependencies {
     // ...
   }
   

2. 在根级（项目级）Gradle 文件 (build.gradle) 中添加规则，以纳入性能监控插件。

   buildscript {
   
       repositories {
         // Check that you have the following line (if not, add it):
         google()  // Google's Maven repository
         // Add the Bintray repository
         jcenter()
       }
   
       dependencies {
         // ...
   
         // To benefit from the latest Performance Monitoring plugin features,
         // update your Android Gradle Plugin dependency to at least v3.4.0
         classpath 'com.android.tools.build:gradle:3.4.0'
   
         classpath 'com.google.gms:google-services:4.3.0'  // Google Services plugin
   
         // Add the dependency for the Performance Monitoring plugin
         classpath 'com.google.firebase:perf-plugin:1.3.1'  // Performance Monitoring plugin
       }
   }
   

3. 重新编译您的应用。

第 3 步：在 Firebase 控制台中查看性能监控结果

1. 在 Android Studio 中构建您的应用。

2. 使用以下任一工具来测试您的应用：

   • 安装了最新映像和 Google Play 服务 15.0.0 或更高版本的 Android 模拟器

   • 安装了 Google Play 服务 15.0.0 或更高版本的测试设备。

3. 确认性能监控结果显示在 Firebase 控制台中。

   结果通常在 12 小时内显示。

第 4 步：（可选）添加自定义跟踪记录和自定义指标

自定义跟踪记录是与您应用中某些代码相关联的性能数据的报告。如需详细了解自定义跟踪记录，请参阅 Firebase 性能监控概览。

您的应用中可以有多项自定义跟踪记录，并且可以同时运行。每项自定义跟踪记录都可以设置一个或多个指标来统计应用中与性能相关的事件，这些指标与创建它们的跟踪记录相关联。

请注意，自定义跟踪记录和指标的名称必须满足以下要求：没有前导空格或尾随空格，没有前导下划线 (_) 字符，最大长度为 32 个字符。

1. 在 .java 或 .kt 文件的顶部导入这些性能监控类：

   import com.google.firebase.perf.FirebasePerformance;
   import com.google.firebase.perf.metrics.Trace;
   

2. 要启动和停止自定义跟踪记录，请使用如下几行代码封装要跟踪的代码（该示例使用自定义跟踪记录名称 test_trace）：

   Java

   Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
   myTrace.start();
   
   // code that you want to trace
   
   myTrace.stop();
   MainActivity.java
   

   Kotlin

   val myTrace = FirebasePerformance.getInstance().newTrace("test_trace")
   myTrace.start()
   
   // code that you want to trace
   
   myTrace.stop()
   MainActivity.kt
   

3. 要添加自定义指标，请在每次发生事件时添加如下几行代码。例如，此自定义指标会统计应用中发生的与性能相关的事件，例如缓存命中或未命中（使用示例事件名称 item_cache_hit 和 item_cache_miss，次数为 1 的整数倍）。

   Java

   Trace myTrace = FirebasePerformance.getInstance().newTrace("test_trace");
   myTrace.start();
   // code that you want to trace (and log custom metrics)
   Item item = cache.fetch("item");
   if (item != null) {
       myTrace.incrementMetric("item_cache_hit", 1);
   } else {
       myTrace.incrementMetric("item_cache_miss", 1);
   }
   
   myTrace.stop();
   MainActivity.java
   

   Kotlin

   val myTrace = FirebasePerformance.getInstance().newTrace("test_trace")
   myTrace.start()
   // code that you want to trace (and log custom metrics)
   val item = cache.fetch("item")
   if (item != null) {
       myTrace.incrementMetric("item_cache_hit", 1)
   } else {
       myTrace.incrementMetric("item_cache_miss", 1)
   }
   
   myTrace.stop()
   MainActivity.kt
   

第 5 步：（可选）使用 @AddTrace 跟踪特定方法

您可以将 @AddTrace 注释添加到应用的方法中，并提供一个字符串来标识生成的自定义跟踪记录。这会使得从该方法开始时启动跟踪记录，并在方法完成时停止跟踪记录。

但请注意，对于使用 @AddTrace 注释创建的自定义跟踪记录，您无法添加自定义指标。

例如，要创建一个在调用 onCreate() 方法时运行的 onCreateTrace 的跟踪记录，请使用如下代码：

Java

@Override
@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
}
MainActivity.java

Kotlin

@AddTrace(name = "onCreateTrace", enabled = true /* optional */)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
}
MainActivity.kt

第 6 步：（可选）添加对特定网络请求的监控

Firebase 性能监控会自动收集网络请求。虽然该产品会自动收集您应用的大多数网络请求，但并非所有收集到请求都会报告。

要将特定网络请求纳入性能监控，请为您的应用添加以下代码：

Java

HttpMetric metric =
        FirebasePerformance.getInstance().newHttpMetric("https://www.google.com",
                FirebasePerformance.HttpMethod.GET);
final URL url = new URL("https://www.google.com");
metric.start();
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setDoOutput(true);
conn.setRequestProperty("Content-Type", "application/json");
try {
    DataOutputStream outputStream = new DataOutputStream(conn.getOutputStream());
    outputStream.write(data);
} catch (IOException ignored) {
}
metric.setRequestPayloadSize(data.length);
metric.setHttpResponseCode(conn.getResponseCode());
printStreamContent(conn.getInputStream());

conn.disconnect();
metric.stop();
MainActivity.java

Kotlin

val metric = FirebasePerformance.getInstance().newHttpMetric("https://www.google.com",
        FirebasePerformance.HttpMethod.GET)
val url = URL("https://www.google.com")
metric.start()
val conn = url.openConnection() as HttpURLConnection
conn.doOutput = true
conn.setRequestProperty("Content-Type", "application/json")
try {
    val outputStream = DataOutputStream(conn.outputStream)
    outputStream.write(data)
} catch (ignored: IOException) {
}

metric.setRequestPayloadSize(data.size.toLong())
metric.setHttpResponseCode(conn.responseCode)
printStreamContent(conn.inputStream)

conn.disconnect()
metric.stop()
MainActivity.kt

您通过这种方式专门捕获的 HTTP/HTTPS 网络请求会与性能监控自动捕获的网络请求一起显示在 Firebase 控制台中。

第 7 步：部署应用，然后查看结果

使用一个或多个测试设备验证性能监控后，您可以将更新后的应用版本部署给用户。

您可以在 Firebase 控制台中监控性能数据。

注意：Firebase 性能监控可能只会报告已完成的 HTTP/HTTPS 网络请求，具体取决于您代码的行为以及代码所使用的网络库。这意味着，报告中可能不会显示未完成的 HTTP/HTTPS 连接。

已知问题

• 性能监控 Gradle 插件 v1.1.0 可能导致 Guava 依赖项不匹配，造成以下错误：

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

  如果出现此错误，您可以采取以下任一措施：

  • 将性能监控插件升级到 v1.1.1 或更高版本（最新版本为 v1.3.1）。

  • 替换根级（项目级）Gradle 文件 (build.gradle) 中的性能监控插件依赖项行，如下所示：

    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'
        }
      }
    }
    

• 性能监控仅支持监控使用 OkHttp HTTP 客户端 v3.x.x 发起的 HTTP/HTTPS 网络请求。

• 性能监控会根据 HTTP 内容长度标头中设置的值，报告 HTTP/HTTPS 网络请求的总载荷大小。此值有时可能并不准确。

• 在多进程 Android 应用中，性能监控仅支持其中的主进程。

• 性能监控 Gradle 插件与以下内容不兼容：

  • DexGuard，它会停用自动跟踪和 HTTP/HTTPS 网络请求监控。但是，如果您的应用使用 DexGuard，通过 Performance Monitoring SDK 添加的自定义跟踪记录不受影响。

  • Jack，已弃用。

调试集成

您可以在构建时为性能监控启用调试日志记录功能，方法是在应用的 AndroidManifest.xml 文件中添加 <meta-data> 元素，如下所示：

<application>
    <meta-data
      android:name="firebase_performance_logcat_enabled"
      android:value="true" />
</application>

您可以使用 logcat 过滤功能查看跟踪记录和 HTTP/HTTPS 网络请求日志记录。性能监控日志消息会被标记为 FirebasePerformance，您可以使用以下命令对其进行过滤：

adb logcat -s FirebasePerformance

后续步骤

• 查看跟踪记录和网络请求的示例。

• 查看和运行 GitHub 上的性能监控 Android 版代码示例。

• 详细了解自动跟踪记录。

• 详细了解如何监控自定义属性。