--- description: Unofficial Capacitor plugin for Firebase Performance Monitoring SDK to measure app performance and identify bottlenecks. title: Capacitor Firebase Performance Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/plugins/firebase/performance-monitoring.png --- [ Skip to content](#capacitor-firebaseperformance) [ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Changelog ](#changelog) * [ License ](#license) * [ Remote Config ](/docs/plugins/firebase/remote-config/) * [ Formbricks ](/docs/plugins/formbricks/) * [ Geocoder ](/docs/plugins/geocoder/) * [ Google Sign-In ](/docs/plugins/google-sign-in/) * [ Grafana Faro ](/docs/plugins/grafana-faro/) * [ libSQL ](/docs/plugins/libsql/) * [ Live Update ](/docs/plugins/live-update/) * [ Managed Configurations ](/docs/plugins/managed-configurations/) * [ Media Session ](/docs/plugins/media-session/) * [ ML Kit ](/docs/plugins/mlkit/) * [ Navigation Bar ](/docs/plugins/navigation-bar/) * [ NFC ](/docs/plugins/nfc/) * [ OAuth ](/docs/plugins/oauth/) * [ Pedometer ](/docs/plugins/pedometer/) * [ Photo Editor ](/docs/plugins/photo-editor/) * [ PostHog ](/docs/plugins/posthog/) * [ Printer ](/docs/plugins/printer/) * [ Purchases ](/docs/plugins/purchases/) * [ RealtimeKit ](/docs/plugins/realtimekit/) * [ Screen Orientation ](/docs/plugins/screen-orientation/) * [ Screenshot ](/docs/plugins/screenshot/) * [ Secure Preferences ](/docs/plugins/secure-preferences/) * [ Speech Recognition ](/docs/plugins/speech-recognition/) * [ Speech Synthesis ](/docs/plugins/speech-synthesis/) * [ Share Target ](/docs/plugins/share-target/) * [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/) * [ SQLite ](/docs/plugins/sqlite/) * [ Superwall ](/docs/plugins/superwall/) * [ Torch ](/docs/plugins/torch/) * [ Wifi ](/docs/plugins/wifi/) * [ Zip ](/docs/plugins/zip/) * [ Cloud ](/docs/cloud/) * [ Live Updates ](/docs/cloud/live-updates/) * Advanced * Integrations * [ Native Builds ](/docs/cloud/native-builds/) * [ Configuration ](/docs/cloud/native-builds/configuration/) * [ Environments ](/docs/cloud/native-builds/environments/) * Guides * [ Sample Projects ](/docs/cloud/native-builds/sample-projects/) * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ Automations ](/docs/cloud/automations/) * [ Assist ](/docs/cloud/assist/) * Account * Organizations * [ Organization and User Management ](/docs/cloud/organizations/memberships/) * [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/) * [ Teams ](/docs/cloud/organizations/teams/) * [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/) * [ Integrations ](/docs/cloud/integrations/) * [ License Keys ](/docs/cloud/license-keys/) * [ Webhooks ](/docs/cloud/webhooks/) * [ Pricing ](https://capawesome.io/pricing/) * [ FAQ ](/docs/cloud/faq/) * [ Support ](/docs/cloud/support/) * [ Contributing ](/docs/contributing/) * [ LLMs ](/docs/llms/) * [ Insiders ](/docs/insiders/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/insiders/support/) * [ FAQ ](/docs/insiders/faq/) * [ Blog ](/blog/) * Categories * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Changelog ](#changelog) * [ License ](#license) # @capacitor-firebase/performance[¶](#capacitor-firebaseperformance "Permanent link") Unofficial Capacitor plugin for [Firebase Performance Monitoring](https://firebase.google.com/docs/perf-mon).[1](#fn:1) [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | | 5.x.x | 5.x.x | Deprecated | | 1.x.x | 4.x.x | Deprecated | ## Installation[¶](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/performance` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capacitor-firebase/performance firebase [](#%5F%5Fcodelineno-2-2)npx cap sync ` Add Firebase to your project if you haven't already ([Android](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) / [iOS](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) / [Web](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)). ### Android[¶](#android "Permanent link") See [Add the Performance Monitoring plugin to your app](https://firebase.google.com/docs/perf-mon/get-started-android#add-perfmon-plugin) and follow the instructions to set up your app correctly. #### Variables[¶](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$firebasePerfVersion` version of `com.google.firebase:firebase-perf` (default: `22.0.4`) This can be useful if you encounter dependency conflicts with other plugins in your project. ## Configuration[¶](#configuration "Permanent link") No configuration required for this plugin. ## Demo[¶](#demo "Permanent link") A working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo) ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { FirebasePerformance } from '@capacitor-firebase/performance'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const startTrace = async () => { [](#%5F%5Fcodelineno-3-4) await FirebasePerformance.startTrace({ traceName: 'test_trace' }); [](#%5F%5Fcodelineno-3-5)}; [](#%5F%5Fcodelineno-3-6) [](#%5F%5Fcodelineno-3-7)const stopTrace = async () => { [](#%5F%5Fcodelineno-3-8) await FirebasePerformance.stopTrace({ traceName: 'test_trace' }); [](#%5F%5Fcodelineno-3-9)}; [](#%5F%5Fcodelineno-3-10) [](#%5F%5Fcodelineno-3-11)const incrementMetric = async () => { [](#%5F%5Fcodelineno-3-12) await FirebasePerformance.incrementMetric({ [](#%5F%5Fcodelineno-3-13) traceName: 'test_trace', [](#%5F%5Fcodelineno-3-14) metricName: 'item_cache_hit', [](#%5F%5Fcodelineno-3-15) incrementBy: 1, [](#%5F%5Fcodelineno-3-16) }); [](#%5F%5Fcodelineno-3-17)}; [](#%5F%5Fcodelineno-3-18) [](#%5F%5Fcodelineno-3-19)const setEnabled = async () => { [](#%5F%5Fcodelineno-3-20) await FirebasePerformance.setEnabled({ enabled: true }); [](#%5F%5Fcodelineno-3-21)}; [](#%5F%5Fcodelineno-3-22) [](#%5F%5Fcodelineno-3-23)const isEnabled = async () => { [](#%5F%5Fcodelineno-3-24) const result = await FirebasePerformance.isEnabled(); [](#%5F%5Fcodelineno-3-25) return result.enabled; [](#%5F%5Fcodelineno-3-26)}; [](#%5F%5Fcodelineno-3-27) [](#%5F%5Fcodelineno-3-28)const putAttribute = async () => { [](#%5F%5Fcodelineno-3-29) await FirebasePerformance.putAttribute({ [](#%5F%5Fcodelineno-3-30) traceName: 'test_trace', [](#%5F%5Fcodelineno-3-31) attribute: 'user_id', [](#%5F%5Fcodelineno-3-32) value: '123', [](#%5F%5Fcodelineno-3-33) }); [](#%5F%5Fcodelineno-3-34)}; [](#%5F%5Fcodelineno-3-35) [](#%5F%5Fcodelineno-3-36)const getAttribute = async () => { [](#%5F%5Fcodelineno-3-37) const result = await FirebasePerformance.getAttribute({ [](#%5F%5Fcodelineno-3-38) traceName: 'test_trace', [](#%5F%5Fcodelineno-3-39) attribute: 'user_id', [](#%5F%5Fcodelineno-3-40) }); [](#%5F%5Fcodelineno-3-41) return result.attributes; [](#%5F%5Fcodelineno-3-42)}; [](#%5F%5Fcodelineno-3-43) [](#%5F%5Fcodelineno-3-44)const getAttributes = async () => { [](#%5F%5Fcodelineno-3-45) const result = await FirebasePerformance.getAttributes({ traceName: 'test_trace' }); [](#%5F%5Fcodelineno-3-46) return result.attributes; [](#%5F%5Fcodelineno-3-47)}; [](#%5F%5Fcodelineno-3-48) [](#%5F%5Fcodelineno-3-49)const removeAttribute = async () => { [](#%5F%5Fcodelineno-3-50) await FirebasePerformance.removeAttribute({ [](#%5F%5Fcodelineno-3-51) traceName: 'test_trace', [](#%5F%5Fcodelineno-3-52) attribute: 'user_id', [](#%5F%5Fcodelineno-3-53) }); [](#%5F%5Fcodelineno-3-54)}; [](#%5F%5Fcodelineno-3-55) [](#%5F%5Fcodelineno-3-56)const putMetric = async () => { [](#%5F%5Fcodelineno-3-57) await FirebasePerformance.putMetric({ [](#%5F%5Fcodelineno-3-58) traceName: 'test_trace', [](#%5F%5Fcodelineno-3-59) metricName: 'item_cache_hit', [](#%5F%5Fcodelineno-3-60) num: 1, [](#%5F%5Fcodelineno-3-61) }); [](#%5F%5Fcodelineno-3-62)}; [](#%5F%5Fcodelineno-3-63) [](#%5F%5Fcodelineno-3-64)const getMetric = async () => { [](#%5F%5Fcodelineno-3-65) const result = await FirebasePerformance.getMetric({ [](#%5F%5Fcodelineno-3-66) traceName: 'test_trace', [](#%5F%5Fcodelineno-3-67) metricName: 'item_cache_hit', [](#%5F%5Fcodelineno-3-68) }); [](#%5F%5Fcodelineno-3-69) return result.value; [](#%5F%5Fcodelineno-3-70)}; [](#%5F%5Fcodelineno-3-71) [](#%5F%5Fcodelineno-3-72)const record = async () => { [](#%5F%5Fcodelineno-3-73) await FirebasePerformance.record({ [](#%5F%5Fcodelineno-3-74) traceName: 'test_trace', [](#%5F%5Fcodelineno-3-75) startTime: Date.now(), [](#%5F%5Fcodelineno-3-76) duration: 1000, [](#%5F%5Fcodelineno-3-77) options: { [](#%5F%5Fcodelineno-3-78) metrics: { [](#%5F%5Fcodelineno-3-79) item_cache_hit: 1, [](#%5F%5Fcodelineno-3-80) }, [](#%5F%5Fcodelineno-3-81) attributes: { [](#%5F%5Fcodelineno-3-82) user_id: '123', [](#%5F%5Fcodelineno-3-83) }, [](#%5F%5Fcodelineno-3-84) }, [](#%5F%5Fcodelineno-3-85) }); [](#%5F%5Fcodelineno-3-86)}; ` ## API[¶](#api "Permanent link") * [startTrace(...)](#starttrace) * [stopTrace(...)](#stoptrace) * [incrementMetric(...)](#incrementmetric) * [setEnabled(...)](#setenabled) * [isEnabled()](#isenabled) * [putAttribute(...)](#putattribute) * [getAttribute(...)](#getattribute) * [getAttributes(...)](#getattributes) * [removeAttribute(...)](#removeattribute) * [putMetric(...)](#putmetric) * [getMetric(...)](#getmetric) * [record(...)](#record) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### startTrace(...)[¶](#starttrace "Permanent link") `[](#%5F%5Fcodelineno-4-1)startTrace(options: StartTraceOptions) => Promise ` Starts a trace. | Param | Type | | ----------- | --------------------------------------- | | **options** | [StartTraceOptions](#starttraceoptions) | **Since:** 0.1.0 --- ### stopTrace(...)[¶](#stoptrace "Permanent link") `[](#%5F%5Fcodelineno-5-1)stopTrace(options: StopTraceOptions) => Promise ` Stops a trace. | Param | Type | | ----------- | ------------------------------------- | | **options** | [StopTraceOptions](#stoptraceoptions) | **Since:** 0.1.0 --- ### incrementMetric(...)[¶](#incrementmetric "Permanent link") `[](#%5F%5Fcodelineno-6-1)incrementMetric(options: IncrementMetricOptions) => Promise ` Atomically increments the metric with the given name for the selected trace by the `incrementBy` value. | Param | Type | | ----------- | ------------------------------------------------- | | **options** | [IncrementMetricOptions](#incrementmetricoptions) | **Since:** 0.1.0 --- ### setEnabled(...)[¶](#setenabled "Permanent link") `[](#%5F%5Fcodelineno-7-1)setEnabled(options: SetEnabledOptions) => Promise ` Enables or disables performance monitoring. Will be applied with the next start of the app. | Param | Type | | ----------- | --------------------------------------- | | **options** | [SetEnabledOptions](#setenabledoptions) | **Since:** 0.1.0 --- ### isEnabled()[¶](#isenabled "Permanent link") `[](#%5F%5Fcodelineno-8-1)isEnabled() => Promise ` Determines whether performance monitoring is enabled or disabled. **Returns:** `Promise<[IsEnabledResult](#isenabledresult)>` **Since:** 0.1.0 --- ### putAttribute(...)[¶](#putattribute "Permanent link") `[](#%5F%5Fcodelineno-9-1)putAttribute(options: PutAttributeOptions) => Promise ` Sets a custom attribute of a trace to a given value. | Param | Type | | ----------- | ------------------------------------------- | | **options** | [PutAttributeOptions](#putattributeoptions) | **Since:** 6.3.0 --- ### getAttribute(...)[¶](#getattribute "Permanent link") `[](#%5F%5Fcodelineno-10-1)getAttribute(options: GetAttributeOptions) => Promise ` Returns the value of a custom attribute of a trace. | Param | Type | | ----------- | ------------------------------------------- | | **options** | [GetAttributeOptions](#getattributeoptions) | **Returns:** `Promise<[GetAttributeResult](#getattributeresult)>` **Since:** 6.3.0 --- ### getAttributes(...)[¶](#getattributes "Permanent link") `[](#%5F%5Fcodelineno-11-1)getAttributes(options: GetAttributesOptions) => Promise ` Gets the all the custom attributes of a trace with their values. | Param | Type | | ----------- | --------------------------------------------- | | **options** | [GetAttributesOptions](#getattributesoptions) | **Returns:** `Promise<[GetAttributesResult](#getattributesresult)>` **Since:** 6.3.0 --- ### removeAttribute(...)[¶](#removeattribute "Permanent link") `[](#%5F%5Fcodelineno-12-1)removeAttribute(options: RemoveAttributeOptions) => Promise ` Removes a custom attribute from a trace given its name. | Param | Type | | ----------- | ------------------------------------------- | | **options** | [GetAttributeOptions](#getattributeoptions) | **Since:** 6.3.0 --- ### putMetric(...)[¶](#putmetric "Permanent link") `[](#%5F%5Fcodelineno-13-1)putMetric(options: PutMetricOptions) => Promise ` Sets the value of a custom metric. | Param | Type | | ----------- | ------------------------------------- | | **options** | [PutMetricOptions](#putmetricoptions) | **Since:** 6.3.0 --- ### getMetric(...)[¶](#getmetric "Permanent link") `[](#%5F%5Fcodelineno-14-1)getMetric(options: GetMetricOptions) => Promise ` Get the value of a custom metric by name. | Param | Type | | ----------- | ------------------------------------- | | **options** | [GetMetricOptions](#getmetricoptions) | **Returns:** `Promise<[GetMetricResult](#getmetricresult)>` **Since:** 6.3.0 --- ### record(...)[¶](#record "Permanent link") `[](#%5F%5Fcodelineno-15-1)record(options: RecordOptions) => Promise ` Records a trace given its name and options. Only available on web. | Param | Type | | ----------- | ------------------------------- | | **options** | [RecordOptions](#recordoptions) | **Since:** 6.3.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### StartTraceOptions[¶](#starttraceoptions "Permanent link") | Prop | Type | Description | Since | | ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | | **traceName** | string | Custom trace name. Names for custom code traces must meet the following requirements: no leading or trailing whitespace, no leading underscore (\_) character, and max length is 100 characters. | 0.1.0 | #### StopTraceOptions[¶](#stoptraceoptions "Permanent link") | Prop | Type | Description | Since | | ------------- | ------ | ----------------------------------------------- | ----- | | **traceName** | string | Name of the trace that was set with startTrace. | 0.1.0 | #### IncrementMetricOptions[¶](#incrementmetricoptions "Permanent link") | Prop | Type | Description | Default | Since | | --------------- | ------ | ------------------------------------------------- | ------- | ----- | | **traceName** | string | Name of the trace that was set with startTrace. | 0.1.0 | | | **metricName** | string | Name of the metric to be incremented. | 0.1.0 | | | **incrementBy** | number | Amount by which the metric has to be incremented. | 1 | 0.1.0 | #### SetEnabledOptions[¶](#setenabledoptions "Permanent link") | Prop | Type | Description | Since | | ----------- | ------- | ----------------------------------------- | ----- | | **enabled** | boolean | Should performance monitoring be enabled. | 0.1.0 | #### IsEnabledResult[¶](#isenabledresult "Permanent link") | Prop | Type | Description | Since | | ----------- | ------- | ----------------------------------------------------------- | ----- | | **enabled** | boolean | true if performance monitoring is enabled, otherwise false. | 0.1.0 | #### PutAttributeOptions[¶](#putattributeoptions "Permanent link") | Prop | Type | Description | Since | | ------------- | ------ | --------------------------------------- | ----- | | **traceName** | string | Name of the trace to set its attribute. | 6.3.0 | | **attribute** | string | Name of the attribute to set its value. | 6.3.0 | | **value** | string | The value to set to the attribute. | 6.3.0 | #### GetAttributeResult[¶](#getattributeresult "Permanent link") | Prop | Type | Description | Since | | --------- | -------------- | ---------------------------------- | ----- | | **value** | string \| null | The value of the custom attribute. | 6.3.0 | #### GetAttributeOptions[¶](#getattributeoptions "Permanent link") | Prop | Type | Description | Since | | ------------- | ------ | -------------------------------------------- | ----- | | **traceName** | string | Name of the trace to set its attribute. | 6.3.0 | | **attribute** | string | Name of the attribute to retrieve its value. | 6.3.0 | #### GetAttributesResult[¶](#getattributesresult "Permanent link") | Prop | Type | Description | Since | | -------------- | ---------------------------- | ------------------------------------------------------------ | ----- | | **attributes** | { \[key: string\]: string; } | A map of all custom attributes of a trace with their values. | 6.3.0 | #### GetAttributesOptions[¶](#getattributesoptions "Permanent link") | Prop | Type | Description | Since | | ------------- | ------ | ---------------------------------------- | ----- | | **traceName** | string | Name of the trace to get its attributes. | 6.3.0 | #### PutMetricOptions[¶](#putmetricoptions "Permanent link") | Prop | Type | Description | Since | | -------------- | ------ | ---------------------------------------------------------------------------------------- | ----- | | **traceName** | string | Name of the trace to set its metric. | 6.3.0 | | **metricName** | string | The metric name. | 6.3.0 | | **num** | number | The value to set for the metric. The given value is floored down to the nearest integer. | 6.3.0 | #### GetMetricResult[¶](#getmetricresult "Permanent link") | Prop | Type | Description | Since | | --------- | ------ | ---------------------------------- | ----- | | **value** | number | The value of the metric if exists. | 6.3.0 | #### GetMetricOptions[¶](#getmetricoptions "Permanent link") | Prop | Type | Description | Since | | -------------- | ------ | ------------------------------------ | ----- | | **traceName** | string | Name of the trace to get its metric. | 6.3.0 | | **metricName** | string | The metric name. | 6.3.0 | #### RecordOptions[¶](#recordoptions "Permanent link") | Prop | Type | Description | Since | | ------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----- | | **traceName** | string | Name of the trace to record. | 6.3.0 | | **startTime** | number | Start time of the trace since epoch in milliseconds. | 6.3.0 | | **duration** | number | The duration of the trace in milliseconds. | 6.3.0 | | **options** | { metrics?: { \[key: string\]: number; }; attributes?: { \[key: string\]: string; }; } | An optional object that holds optional maps of custom metrics and attributes. | 6.3.0 | ### Type Aliases[¶](#type-aliases "Permanent link") #### RemoveAttributeOptions[¶](#removeattributeoptions "Permanent link") `[GetAttributeOptions](#getattributeoptions)` ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/performance/CHANGELOG.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/performance/LICENSE). --- 1. This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text") May 21, 2026 Back to top