firebase-perf/dev.gitlive.firebase.perf/FirebasePerformance

FirebasePerformance

actual class FirebasePerformance(source)
expect class FirebasePerformance(source)

The Firebase Performance Monitoring API.

It is automatically initialized by FirebaseApp.

This SDK uses FirebaseInstallations to identify the app instance and periodically sends data to the Firebase backend. To stop sending performance events, call setPerformanceCollectionEnabled with value false.

actual class FirebasePerformance(source)
actual class FirebasePerformance(source)
actual class FirebasePerformance(source)

Constructors

Link copied to clipboard
constructor(android: FirebasePerformance)
constructor(ios: FIRPerformance)
constructor()

Properties

Link copied to clipboard
val FirebasePerformance.android: FirebasePerformance
Link copied to clipboard
val FirebasePerformance.ios: FIRPerformance
Link copied to clipboard
val FirebasePerformance.js: FirebasePerformance

Functions

Link copied to clipboard
Link copied to clipboard
actual fun isPerformanceCollectionEnabled(): Boolean
expect fun isPerformanceCollectionEnabled(): Boolean

Determines whether performance monitoring is enabled or disabled. This respects the Firebase Performance specific values first, and if these aren't set, uses the Firebase wide data collection switch.

actual fun isPerformanceCollectionEnabled(): Boolean
actual fun isPerformanceCollectionEnabled(): Boolean
actual fun isPerformanceCollectionEnabled(): Boolean
Link copied to clipboard
actual fun newTrace(traceName: String): Trace
expect fun newTrace(traceName: String): Trace

Creates a Trace object with given name.

actual fun newTrace(traceName: String): Trace
actual fun newTrace(traceName: String): Trace
actual fun newTrace(traceName: String): Trace
Link copied to clipboard
Link copied to clipboard
actual fun setPerformanceCollectionEnabled(enable: Boolean)
expect fun setPerformanceCollectionEnabled(enable: Boolean)

Enables or disables performance monitoring. This setting is persisted and applied on future invocations of your application. By default, performance monitoring is enabled. If you need to change the default (for example, because you want to prompt the user before collecting performance stats), add:

actual fun setPerformanceCollectionEnabled(enable: Boolean)
actual fun setPerformanceCollectionEnabled(enable: Boolean)
actual fun setPerformanceCollectionEnabled(enable: Boolean)