Skip to main content
Capgo logo
← Back To Plugins

Using @capgo/capacitor-firebase-performance

Capacitor plugin for Firebase Performance Monitoring.

Install

bun add @capgo/capacitor-firebase-performance
bunx cap sync

What This Plugin Exposes

  • startTrace - Starts a trace.
  • stopTrace - Stops a trace.
  • incrementMetric - Atomically increments the metric with the given name for the selected trace by the incrementBy value.
  • setEnabled - Enables or disables performance monitoring. Will be applied with the next start of the app.

Example Usage

startTrace

Starts a trace.

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.startTrace({} as StartTraceOptions);

stopTrace

Stops a trace.

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.stopTrace({} as StopTraceOptions);

incrementMetric

Atomically increments the metric with the given name for the selected trace by the incrementBy value.

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.incrementMetric({} as IncrementMetricOptions);

setEnabled

Enables or disables performance monitoring. Will be applied with the next start of the app.

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';

await FirebasePerformance.setEnabled({} as SetEnabledOptions);

Full Reference