เริ่มต้นใช้งานการตรวจสอบประสิทธิภาพสำหรับ Android

ก่อนเริ่มต้น

เพิ่ม Firebase ลงในโปรเจ็กต์ Android หากยังไม่ได้ดำเนินการ

ขั้นตอนที่ 1: เพิ่ม Performance Monitoring SDK ลงในแอป

หลังจากเพิ่ม Performance Monitoring SDK แล้ว Firebase จะเริ่มรวบรวมข้อมูลการแสดงผลหน้าจอของแอปและข้อมูลที่เกี่ยวข้องกับวงจรชีวิตของแอปโดยอัตโนมัติ (เช่น เวลาเริ่มต้นของแอป) หากต้องการอนุญาตให้ Firebase ตรวจสอบคําขอเครือข่าย คุณต้องเพิ่มPerformance Monitoring ให้กับปลั๊กอิน Gradle ด้วย (ขั้นตอนถัดไป)

ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยปกติจะเป็น <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) ให้เพิ่มทรัพยากร Dependency สำหรับไลบรารี Performance Monitoring สำหรับ Android เราขอแนะนำให้ใช้ Firebase Android BoM เพื่อควบคุมการกำหนดเวอร์ชันของไลบรารี
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.15.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")
}
```
การใช้ Firebase Android BoM จะทำให้แอปใช้ไลบรารี Firebase Android เวอร์ชันที่เข้ากันได้อยู่เสมอ
(วิธีอื่น) เพิ่มไลบรารี Firebase ที่ต้องพึ่งพาโดยไม่ต้องใช้ BoM

หากเลือกไม่ใช้ Firebase BoM คุณต้องระบุเวอร์ชันของไลบรารี Firebase แต่ละเวอร์ชันในบรรทัดของ Dependency

โปรดทราบว่าหากคุณใช้ไลบรารี Firebase หลายรายการในแอป เราขอแนะนําอย่างยิ่งให้ใช้ BoM เพื่อจัดการเวอร์ชันของไลบรารี ซึ่งจะช่วยให้มั่นใจได้ว่าทุกเวอร์ชันจะใช้งานร่วมกันได้
```
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:21.0.5")
}
```
หากกำลังมองหาโมดูลไลบรารีสำหรับ Kotlin โดยเฉพาะ ตั้งแต่เดือนตุลาคม 2023 (Firebase BoM 32.5.0) เป็นต้นไป นักพัฒนาซอฟต์แวร์ทั้ง Kotlin และ Java จะใช้โมดูลไลบรารีหลักได้ (ดูรายละเอียดได้ในคําถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้)
คอมไพล์แอปอีกครั้ง

ขั้นตอนที่ 2: เพิ่มปลั๊กอิน Performance Monitoring Gradle ลงในแอป

หลังจากเพิ่มPerformance Monitoringปลั๊กอิน Gradle แล้ว Firebase จะเริ่มรวบรวมข้อมูลสำหรับคำขอเครือข่าย HTTP/S โดยอัตโนมัติ นอกจากนี้ ปลั๊กอินยังช่วยให้คุณเครื่องมือติดตามโค้ดที่กำหนดเองได้โดยใช้หมายเหตุกำกับ@AddTrace

หลักการทำงานของปลั๊กอิน Performance Monitoring

ก่อนที่โค้ดจะแปลงเป็นไฟล์ DEX ปลั๊กอิน Performance Monitoring จะใช้ Transform API และเฟรมเวิร์กเครื่องมือวัดผลของไบต์โค้ด ASM เพื่อไปที่ไฟล์คลาสที่คอมไพล์แล้วของแอปและเพื่อเครื่องมือวัดผลโค้ด (เพื่อวัดประสิทธิภาพ) เวลาที่ใช้ในการเครื่องมือวัดโค้ดจะขึ้นอยู่กับจํานวนและความซับซ้อนของคลาส

หากแอปใช้เวลาคอมไพล์นานกว่าที่คุณต้องการ ให้ลองพิจารณาตัวเลือกต่อไปนี้

ปิดใช้ปลั๊กอิน Performance Monitoring สำหรับบิลด์แก้ไขข้อบกพร่อง ณ เวลาคอมไพล์
แยกโค้ดเป็นโมดูลเพื่อเพิ่มประสิทธิภาพความเร็วของบิวด์

ในไฟล์ Gradle ระดับรูท (ระดับโปรเจ็กต์) (<project>/build.gradle.kts หรือ <project>/build.gradle) ให้เพิ่มPerformance Monitoringปลั๊กอิน Gradle ดังนี้

Kotlin

คุณยังใช้รูปแบบคำสั่ง buildscriptอยู่ไหม ดูวิธีเพิ่มปลั๊กอิน Firebase โดยใช้ไวยากรณ์ดังกล่าว

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.2" 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.2' apply false

    // Add the dependency for the Performance Monitoring Gradle plugin
    id 'com.google.firebase.firebase-perf' version '1.4.2' apply false
}

ในไฟล์ Gradle ของโมดูล (ระดับแอป) (โดยปกติจะเป็น <project>/<app-module>/build.gradle.kts หรือ <project>/<app-module>/build.gradle) ให้เพิ่มปลั๊กอิน Performance Monitoring ของ Gradle ดังนี้

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: สร้างเหตุการณ์ประสิทธิภาพสําหรับการแสดงข้อมูลเริ่มต้น

Firebase จะเริ่มประมวลผลเหตุการณ์เมื่อคุณเพิ่ม SDK ลงในแอปเรียบร้อยแล้ว หากคุณยังพัฒนาแอปในเครื่อง ให้โต้ตอบกับแอปเพื่อสร้างเหตุการณ์สําหรับการเก็บรวบรวมและประมวลผลข้อมูลเบื้องต้น

สร้างเหตุการณ์โดยการสลับแอปไปมาระหว่างเบื้องหลังและเบื้องหน้าหลายครั้ง การโต้ตอบกับแอปโดยการไปยังส่วนต่างๆ ของหน้าจอ และ/หรือการเรียกคําขอเครือข่าย
ไปที่แดชบอร์ดประสิทธิภาพของคอนโซล Firebase คุณควรเห็นข้อมูลเริ่มต้นแสดงภายในไม่กี่นาที

หากไม่เห็นการแสดงข้อมูลเริ่มต้น ให้ดูเคล็ดลับการแก้ปัญหา

ขั้นตอนที่ 4: (ไม่บังคับ) ดูข้อความบันทึกสําหรับเหตุการณ์ด้านประสิทธิภาพ

เปิดใช้การบันทึกการแก้ไขข้อบกพร่องสําหรับ Performance Monitoring ขณะสร้างโดยการเพิ่มองค์ประกอบ <meta-data> ลงในไฟล์ AndroidManifest.xml ของแอป ดังนี้
```
<application>
    <meta-data
      android:name="firebase_performance_logcat_enabled"
      android:value="true" />
</application>
```
ตรวจสอบข้อความบันทึกเพื่อหาข้อความแสดงข้อผิดพลาด
Performance Monitoring ติดแท็กข้อความบันทึกด้วย FirebasePerformance เมื่อใช้การกรอง logcat คุณสามารถดูการติดตามระยะเวลาและการบันทึกคําขอเครือข่าย HTTP/S โดยเฉพาะได้โดยเรียกใช้คําสั่งต่อไปนี้
```
adb logcat -s FirebasePerformance
```
ตรวจสอบบันทึกประเภทต่อไปนี้ซึ่งบ่งชี้ว่า Performance Monitoring บันทึกเหตุการณ์ด้านประสิทธิภาพ
- Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
- Logging network request trace: URL
คลิก URL เพื่อดูข้อมูลในคอนโซล Firebase ระบบอาจใช้เวลาสักครู่ในการอัปเดตข้อมูลในแดชบอร์ด

หากแอปไม่ได้บันทึกเหตุการณ์ด้านประสิทธิภาพ ให้ดูเคล็ดลับการแก้ปัญหา

ขั้นตอนที่ 5: (ไม่บังคับ) เพิ่มการตรวจสอบที่กําหนดเองสําหรับโค้ดที่เฉพาะเจาะจง

หากต้องการตรวจสอบข้อมูลประสิทธิภาพที่เชื่อมโยงกับโค้ดที่เฉพาะเจาะจงในแอป คุณสามารถตรวจสอบการติดตามโค้ดที่กําหนดเอง

การติดตามโค้ดที่กําหนดเองช่วยให้คุณวัดระยะเวลาที่แอปใช้ในการทํางานหนึ่งๆ หรือชุดงานให้เสร็จสมบูรณ์ได้ เช่น การโหลดชุดรูปภาพหรือการค้นหาฐานข้อมูล เมตริกเริ่มต้นสำหรับการติดตามโค้ดที่กำหนดเองคือระยะเวลา แต่คุณก็เพิ่มเมตริกที่กำหนดเองได้ เช่น การตีกลับแคชและคำเตือนเกี่ยวกับหน่วยความจำ

ในโค้ด คุณจะกําหนดจุดเริ่มต้นและจุดสิ้นสุดของการติดตามโค้ดที่กําหนดเอง (และเพิ่มเมตริกที่กําหนดเองที่ต้องการ) โดยใช้ API ที่ Performance Monitoring SDK มีให้ สําหรับแอป Android คุณสามารถตรวจสอบระยะเวลาของเมธอดที่เฉพาะเจาะจงได้โดยใช้คําอธิบายประกอบ@AddTrace

โปรดไปที่เพิ่มการตรวจสอบโค้ดที่เฉพาะเจาะจงเพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับฟีเจอร์เหล่านี้และวิธีเพิ่มลงในแอป

ขั้นตอนที่ 6: ติดตั้งใช้งานแอปแล้วตรวจสอบผลลัพธ์

หลังจากตรวจสอบ Performance Monitoring โดยใช้อุปกรณ์ทดสอบอย่างน้อย 1 เครื่องแล้ว คุณจะเผยแพร่แอปเวอร์ชันอัปเดตให้แก่ผู้ใช้ได้

คุณตรวจสอบข้อมูลประสิทธิภาพได้ในหน้าแดชบอร์ดประสิทธิภาพของคอนโซล Firebase

ปัญหาที่ทราบ

ปลั๊กอิน Performance Monitoring Gradle v1.1.0 อาจทําให้เกิดความไม่ตรงกันในข้อกําหนดของ Guava ซึ่งส่งผลให้เกิดข้อผิดพลาดต่อไปนี้
```
Error:Execution failed for task ':app:packageInstantRunResourcesDebug'.
> com.google.common.util.concurrent.MoreExecutors.directExecutor()Ljava/util/concurrent/Executor;
```
หากเห็นข้อผิดพลาดนี้ คุณดำเนินการได้ดังนี้
- อัปเกรดปลั๊กอิน Performance Monitoring เป็น v1.1.1 ขึ้นไป (เวอร์ชันล่าสุดคือ v1.4.2)
- แทนที่บรรทัด Dependency ของปลั๊กอิน Performance Monitoring ในไฟล์ Gradle ระดับรูท (ระดับโปรเจ็กต์) (<project>/build.gradle.kts หรือ <project>/build.gradle) ดังนี้
  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' } } }
Performance Monitoring จะรายงานขนาดเพย์โหลดทั้งหมดสําหรับคําขอเครือข่าย HTTP โดยอิงตามค่าที่ตั้งไว้ในส่วนหัวความยาวเนื้อหา HTTP ค่านี้อาจไม่ถูกต้องเสมอไป
Performance Monitoring รองรับเฉพาะกระบวนการหลักในแอป Android แบบหลายกระบวนการ

ขั้นตอนถัดไป

ตรวจสอบและเรียกใช้ตัวอย่างโค้ด Performance Monitoring Android ใน GitHub
ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อมูลที่ Performance Monitoring รวบรวมโดยอัตโนมัติ
- ข้อมูลที่เกี่ยวข้องกับวงจรชีวิตของแอป เช่น เวลาเริ่มต้นของแอป
- ข้อมูลสําหรับการแสดงภาพหน้าจอในแอป
- ข้อมูลสําหรับคําขอเครือข่าย HTTP/S ที่แอปของคุณส่ง
ดู ติดตาม และกรองข้อมูลประสิทธิภาพในคอนโซล Firebase
เพิ่มการตรวจสอบสำหรับงานหรือเวิร์กโฟลว์ที่เฉพาะเจาะจงในแอปโดยเครื่องมือวัดการติดตามโค้ดที่กำหนดเอง
ใช้แอตทริบิวต์เพื่อกรองข้อมูลประสิทธิภาพ