ก่อนที่คุณจะเริ่ม
เพิ่ม Firebase ในโปรเจ็กต์ Android ของคุณ หากยังไม่ได้ ทำ
ขั้นตอนที่ 1 : เพิ่ม SDK การตรวจสอบประสิทธิภาพให้กับแอปของคุณ
หลังจากที่คุณเพิ่ม SDK การตรวจสอบประสิทธิภาพแล้ว Firebase จะเริ่มรวบรวมข้อมูลสำหรับ การแสดงผลหน้าจอ ของแอปโดยอัตโนมัติและข้อมูลที่เกี่ยวข้องกับวงจรชีวิตของแอป (เช่น เวลาเริ่มต้นของแอป ) ต้องการเปิดใช้งาน Firebase การตรวจสอบการร้องขอของเครือข่ายนอกจากนี้คุณยังจะต้องเพิ่มประสิทธิภาพการตรวจสอบปลั๊กอิน Gradle (ขั้นตอนต่อไป)
ใช้ Firebase Android BoM ประกาศการอ้างอิงสำหรับไลบรารี Android การตรวจสอบประสิทธิภาพใน ไฟล์ Gradle ของ โมดูล ของคุณ (ระดับแอป) (โดยทั่วไปคือ
app/build.gradle
)Java
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:26.6.0') // Declare 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 แต่ละเวอร์ชันในบรรทัดการอ้างอิง
โปรดทราบว่าหากคุณใช้ไลบรารี Firebase หลาย ไลบรารีในแอปของคุณเราขอแนะนำอย่างยิ่งให้ใช้ BoM เพื่อจัดการเวอร์ชันไลบรารีซึ่งจะช่วยให้มั่นใจได้ว่าทุกเวอร์ชันจะเข้ากันได้
dependencies { // Declare 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:19.1.1' }
โคตรลิน + KTX
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:26.6.0') // Declare 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-ktx' }
เมื่อใช้ Firebase Android BoM แอปของคุณจะใช้ไลบรารี Firebase Android เวอร์ชันที่เข้ากันได้เสมอ
(ทางเลือก) ประกาศการอ้างอิงไลบรารี Firebase โดยไม่ต้อง ใช้ BoM
หากคุณเลือกที่จะไม่ใช้ Firebase BoM คุณต้องระบุไลบรารี Firebase แต่ละเวอร์ชันในบรรทัดการอ้างอิง
โปรดทราบว่าหากคุณใช้ไลบรารี Firebase หลาย ไลบรารีในแอปของคุณเราขอแนะนำอย่างยิ่งให้ใช้ BoM เพื่อจัดการเวอร์ชันไลบรารีซึ่งจะช่วยให้มั่นใจได้ว่าทุกเวอร์ชันจะเข้ากันได้
dependencies { // Declare 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-ktx:19.1.1' }
รวบรวมแอปของคุณใหม่
ขั้นตอนที่ 2 : เพิ่มปลั๊กอินการตรวจสอบประสิทธิภาพลงในแอปของคุณ
หลังจากที่คุณเพิ่มปลั๊กอิน Performance Monitoring Gradle แล้ว Firebase จะเริ่มรวบรวมข้อมูลสำหรับ คำขอเครือข่าย HTTP / S โดยอัตโนมัติ ปลั๊กอินยังช่วยให้คุณสามารถใช้การติดตามโค้ดที่กำหนดเองโดยใช้ คำอธิบายประกอบ @AddTrace
ใน โมดูล ของคุณ (ระดับแอป) ไฟล์ Gradle (โดยปกติคือ
app/build.gradle
) ให้ใช้ปลั๊กอินการตรวจสอบประสิทธิภาพ:apply plugin: 'com.android.application' apply plugin: 'com.google.gms.google-services' // Apply the Performance Monitoring plugin apply plugin: 'com.google.firebase.firebase-perf' android { // ... }
ในไฟล์
build.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.5' // Google Services plugin // Add the dependency for the Performance Monitoring plugin classpath 'com.google.firebase:perf-plugin:1.3.5' // Performance Monitoring plugin } }
รวบรวมแอปของคุณใหม่
ขั้นตอนที่ 3 : สร้างเหตุการณ์ประสิทธิภาพสำหรับการแสดงข้อมูลเริ่มต้น
Firebase ตรวจพบว่าคุณได้เพิ่ม SDK ลงในแอปสำเร็จแล้วเมื่อได้รับข้อมูลเหตุการณ์ (เช่นการโต้ตอบกับแอป) จากแอปของคุณ หากคุณยังคงพัฒนาในพื้นที่ให้โต้ตอบกับแอปของคุณเพื่อสร้างเหตุการณ์สำหรับการตรวจจับ SDK ตลอดจนการรวบรวมและประมวลผลข้อมูลเบื้องต้น
สร้างเหตุการณ์โดยสลับแอปของคุณไปมาระหว่างพื้นหลังและพื้นหน้าหลาย ๆ ครั้งโต้ตอบกับแอปของคุณโดยการนำทางผ่านหน้าจอและ / หรือเรียกใช้คำขอเครือข่าย
ไปที่ แดชบอร์ด ประสิทธิภาพ ของคอนโซล Firebase เพื่อดูว่า Firebase ตรวจพบ SDK หรือไม่
หากคุณไม่เห็นข้อความ "ตรวจพบ SDK" ภายในไม่กี่นาทีหลังจากเพิ่ม SDK ลงในแอปของคุณโปรดอ่าน เคล็ดลับการแก้ปัญหา
การตรวจสอบประสิทธิภาพประมวลผลข้อมูลเหตุการณ์ประสิทธิภาพก่อนที่จะแสดงใน แดชบอร์ด ประสิทธิภาพ คุณควรเห็นข้อมูลเริ่มต้นของคุณแสดงภายใน 24 ชั่วโมงหลังจากเห็นข้อความการตรวจจับ SDK
หากคุณไม่เห็นการแสดงข้อมูลเริ่มต้นของคุณให้อ่าน คำแนะนำ ในการ แก้ปัญหา
ขั้นตอนที่ 4 : (ไม่บังคับ) ดูข้อความบันทึกสำหรับเหตุการณ์ประสิทธิภาพ
เปิดใช้งานการบันทึกการแก้ไขข้อบกพร่องสำหรับการตรวจสอบประสิทธิภาพในเวลาที่สร้างโดยการเพิ่มองค์ประกอบ
<meta-data>
ลงในไฟล์AndroidManifest.xml
ของแอปของคุณดังนี้:<application> <meta-data android:name="firebase_performance_logcat_enabled" android:value="true" /> </application>
ตรวจสอบข้อความบันทึกของคุณเพื่อหาข้อความแสดงข้อผิดพลาด
การตรวจสอบประสิทธิภาพแท็กข้อความบันทึกด้วย
FirebasePerformance
การใช้การกรอง logcat คุณสามารถดูการติดตามระยะเวลาและการบันทึกคำร้องขอเครือข่าย HTTP / S โดยการรันคำสั่งต่อไปนี้:adb logcat -s FirebasePerformance
ตรวจสอบประเภทของบันทึกต่อไปนี้ซึ่งระบุว่า Performance Monitoring กำลังบันทึกเหตุการณ์ประสิทธิภาพ:
-
Logging trace metric: TRACE_NAME
-
Logging network request trace: URL
-
หากแอปของคุณไม่ได้บันทึกเหตุการณ์ประสิทธิภาพโปรดอ่าน เคล็ดลับการแก้ปัญหา
ขั้นตอนที่ 5 : (ไม่บังคับ) เพิ่มการตรวจสอบที่กำหนดเองสำหรับรหัสเฉพาะ
หากต้องการตรวจสอบข้อมูลประสิทธิภาพที่เกี่ยวข้องกับโค้ดเฉพาะในแอปของคุณคุณสามารถใช้การ ติดตามโค้ดที่กำหนดเอง ได้
ด้วยการติดตามโค้ดที่กำหนดเองคุณสามารถวัดได้ว่าแอปของคุณใช้เวลานานเพียงใดในการทำงานหรือชุดงานที่ต้องการเช่นการโหลดชุดรูปภาพหรือการสืบค้นฐานข้อมูลของคุณ เมตริกเริ่มต้นสำหรับการติดตามโค้ดที่กำหนดเองคือระยะเวลา แต่คุณยังสามารถเพิ่มเมตริกที่กำหนดเองได้เช่นการเข้าชมแคชและคำเตือนเกี่ยวกับหน่วยความจำ
ในโค้ดของคุณคุณกำหนดจุดเริ่มต้นและจุดสิ้นสุดของการติดตามโค้ดที่กำหนดเอง (และเพิ่มเมตริกที่กำหนดเองที่ต้องการ) โดยใช้ API ที่จัดเตรียมโดย Performance Monitoring SDK สำหรับแอป Android คุณสามารถตรวจสอบระยะเวลาของวิธีการเฉพาะโดยใช้ คำอธิบายประกอบ @AddTrace
ไปที่ เพิ่มการตรวจสอบสำหรับรหัสเฉพาะ เพื่อเรียนรู้เพิ่มเติมเกี่ยวกับคุณสมบัติเหล่านี้และวิธีเพิ่มลงในแอปของคุณ
ขั้นตอนที่ 6 : ปรับใช้แอปของคุณจากนั้นตรวจสอบผลลัพธ์
หลังจากที่คุณตรวจสอบความถูกต้องของการตรวจสอบประสิทธิภาพโดยใช้อุปกรณ์ทดสอบหนึ่งเครื่องขึ้นไปคุณสามารถปรับใช้แอปเวอร์ชันที่อัปเดตให้กับผู้ใช้ของคุณได้
คุณตรวจสอบข้อมูลประสิทธิภาพได้ใน แดชบอร์ด ประสิทธิภาพ ของคอนโซล 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;
หากคุณเห็นข้อผิดพลาดนี้คุณสามารถ:
อัปเกรดปลั๊กอินการตรวจสอบประสิทธิภาพเป็น v1.1.1 หรือใหม่กว่า (ล่าสุดคือ v1.3.5)
แทนที่บรรทัดการพึ่งพาปลั๊กอินการตรวจสอบประสิทธิภาพในไฟล์
build.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' } } }
การตรวจสอบประสิทธิภาพรายงานขนาดเพย์โหลดทั้งหมดสำหรับคำขอเครือข่าย HTTP ตามค่าที่กำหนดในส่วนหัวความยาวเนื้อหา HTTP ค่านี้อาจไม่ถูกต้องเสมอไป
การตรวจสอบประสิทธิภาพรองรับเฉพาะกระบวนการหลักในแอพ Android แบบหลายกระบวนการ
ขั้นตอนถัดไป
ตรวจสอบและเรียกใช้ ตัวอย่างโค้ดการตรวจสอบประสิทธิภาพ Android บน GitHub
เรียนรู้เพิ่มเติมเกี่ยวกับข้อมูลที่รวบรวมโดยอัตโนมัติโดยการตรวจสอบประสิทธิภาพ:
- ข้อมูลที่เกี่ยวข้องกับวงจรชีวิตของ แอป เช่น เวลาเริ่มต้นของแอป
- ข้อมูลสำหรับ การแสดงผลหน้าจอ ในแอปของคุณ
- ข้อมูลสำหรับ คำขอเครือข่าย HTTP / S ที่ ออกโดยแอปของคุณ
ดูติดตามและกรอง ข้อมูลประสิทธิภาพของคุณในคอนโซล Firebase
เพิ่มการตรวจสอบสำหรับงานหรือเวิร์กโฟลว์เฉพาะในแอปของคุณโดย ใช้การติดตามโค้ดที่กำหนดเอง