開始使用 Apple 平台的 Performance Monitoring

事前準備

如果您尚未將 Firebase 新增至 Apple 專案，請先完成這項操作。

注意：Firebase 同時支援 CocoaPods 和 Swift Package Manager。如果您選擇使用 Swift Package Manager 安裝 Firebase，可以略過 CocoaPods 相關步驟，例如修改 Podfile 及執行 pod 指令。

步驟 1：在應用程式中新增 Performance Monitoring

新增 Performance Monitoring SDK 後，Firebase 會自動開始針對應用程式的畫面轉譯、與應用程式生命週期相關的資料 (例如應用程式啟動時間)，以及 HTTP/S 網路要求的資料。

使用 Swift Package Manager 安裝及管理 Firebase 依附元件。

請參閱安裝指南，瞭解將 Firebase SDK 新增至 Apple 專案的不同方式，包括直接匯入架構及使用 CocoaPods。

1. 在 Xcode 中保持開啟應用程式專案，然後依序點選「File」>「Add Packages」。
2. 在系統提示時，新增 Firebase Apple 平台 SDK 存放區：

  https://github.com/firebase/firebase-ios-sdk.git

注意：新專案應使用預設的 SDK 版本 (最新) 版本，但您也可以視需要選擇較舊的版本。
3. 選擇 Performance Monitoring 程式庫。
4. 在目標建構設定的「Other Linker Flags」部分中新增 -ObjC 標記。
5. 完成後，Xcode 會自動開始在背景解析並下載依附元件。

接下來，設定 Firebase 模組：

1. 將 FirebaseCore 模組匯入 UIApplicationDelegate，以及應用程式委派使用的任何其他 Firebase 模組。例如，如要使用 Cloud Firestore 和驗證：

   SwiftUI

   import SwiftUI
   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Swift

   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Objective-C

   @import FirebaseCore;
   @import FirebaseFirestore;
   @import FirebaseAuth;
   // ...
         

2. 在應用程式委派的 application(_:didFinishLaunchingWithOptions:) 方法中設定 FirebaseApp 共用例項：

   SwiftUI

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Swift

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Objective-C

   // Use Firebase library to configure APIs
   [FIRApp configure];

3. 如果您使用 SwiftUI，則必須建立應用程式委派，並透過 UIApplicationDelegateAdaptor 或 NSApplicationDelegateAdaptor 將其附加至 App 結構體。您也必須停用應用程式委派功能切換功能。詳情請參閱 SwiftUI 操作說明。

   SwiftUI

   @main
   struct YourApp: App {
     // register app delegate for Firebase setup
     @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
   
     var body: some Scene {
       WindowGroup {
         NavigationView {
           ContentView()
         }
       }
     }
   }
         

4. 重新編譯應用程式。

注意： 您在應用程式中新增 Performance Monitoring 時，系統會將遠端設定 SDK 當做依附元件納入依附元件中。如果您已在使用遠端設定，不會發現任何差異。不過，如果您是第一次使用遠端設定，請參閱遠端設定說明文件，進一步瞭解您將在應用程式中存取的各種功能。

步驟 2：產生初始資料顯示的效能事件

當您將 SDK 成功新增至應用程式時，Firebase 就會開始處理事件。如果您在本機上進行開發，請與應用程式互動，以產生用於初始資料收集和處理的事件。

注意： Performance Monitoring SDK 會先在本機批次處理事件，然後定期 (每 30 秒) 或應用程式返回前景時，將事件傳送至 Firebase。因此，從應用程式互動到 Firebase 從應用程式收到事件資訊之間會有延遲。

1. 繼續使用模擬器或測試裝置開發應用程式。

2. 產生事件時，請在背景和前景間切換應用程式多次、透過切換不同螢幕與應用程式互動，以及/或觸發網路要求。

3. 前往 Firebase 控制台的「Performance」(效能) 資訊主頁。您應該會在幾分鐘內看到初始資料。

   如果沒看到初始資料，請參閱疑難排解提示。

步驟 3：(選用) 查看效能事件的記錄訊息

1. 啟用偵錯記錄功能，如下所示：

   1. 在 Xcode (最低 v14.1) 中，依序選取「Product」 > 「Scheme」 >「Edit scheme」。
   2. 選取左選單中的「Run」，然後點選「Arguments」分頁標籤。
   3. 在「Passed on Launch」區段中，新增 -FIRDebugEnabled。

2. 檢查記錄訊息，看看是否有任何錯誤訊息。

3. Performance Monitoring 會使用 Firebase/Performance 來標記記錄訊息，方便您篩選記錄訊息。

4. 查看以下類型的記錄檔，這些記錄代表 Performance Monitoring 會記錄效能事件：

   • Logging trace metric: TRACE_NAME, FIREBASE_PERFORMANCE_CONSOLE_URL
   • Logging network request trace: URL

5. 按一下網址，即可在 Firebase 控制台查看資料。資訊主頁中的資料可能需要一些時間才會更新。

如果您的應用程式未記錄效能事件，請參閱疑難排解提示。

步驟 4：(選用) 為特定程式碼新增自訂監控功能

如要監控與應用程式中特定程式碼相關聯的效能資料，您可以檢測自訂程式碼追蹤記錄。

透過自訂程式碼追蹤記錄，您可以測量應用程式完成特定工作或一組工作需要的時間，例如載入一組圖片或查詢資料庫。自訂程式碼追蹤記錄的預設指標是其持續時間，但您也可以新增自訂指標，例如快取命中和記憶體警告。

在程式碼中，請使用 Performance Monitoring SDK 提供的 API 定義自訂程式碼追蹤記錄的開頭和結尾 (並新增所需的自訂指標)。

如要進一步瞭解這些功能，以及如何將這些功能加入應用程式，請參閱「新增特定程式碼的監控功能」一節。

步驟 5：部署應用程式並查看結果

使用 Xcode 模擬工具和一或多個測試裝置驗證 Performance Monitoring 後，即可將應用程式的更新版本部署到使用者。

您可以在 Firebase 控制台的「Performance」(效能) 資訊主頁監控效能資料。

已知問題

• Performance Monitoring 與 GTMSQLite 有已知的相容性問題。建議不要將 Performance Monitoring 與使用 GTMSQLite 的應用程式搭配使用。
• 呼叫 FirebaseApp.configure() 後的方法滑動可能會幹擾 Performance Monitoring SDK。
• iOS 8.0-8.2 模擬器的已知問題，會導致 Performance Monitoring 無法擷取效能事件。這些問題在 iOS 8.3 模擬器及以上版本中已修正。
• 使用 NSURLSession 的 backgroundSessionConfiguration 建立的連線時，連線時間會比平常更久。這些連線將獨立於處理程序之外執行，且時間會反映出處理中的回呼事件。

後續步驟

• 查看並執行 GitHub 上的 Performance Monitoring iOS 程式碼範例。

• 進一步瞭解 Performance Monitoring 自動收集的資料：

  • 與應用程式生命週期相關的資料，例如應用程式開始時間
  • 應用程式中的畫面轉譯資料
  • 應用程式發出的 HTTP/S 網路要求相關資料

• 在 Firebase 控制台中查看、追蹤及篩選效能資料。

• 檢測自訂程式碼追蹤記錄，為應用程式中的特定工作或工作流程新增監控功能。

• 使用屬性篩選成效資料。