{"_id":"cordova-plugin-firebasex-performance","_rev":"8-bfbc381342c509f6fab1a20f260dc8e5","name":"cordova-plugin-firebasex-performance","dist-tags":{"latest":"2.0.2"},"versions":{"1.0.0":{"name":"cordova-plugin-firebasex-performance","version":"1.0.0","keywords":["cordova","firebase","performance","monitoring"],"license":"MIT","_id":"cordova-plugin-firebasex-performance@1.0.0","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"dist":{"shasum":"4f83561e4224fb4f194f753784d5d0712e59760d","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-1.0.0.tgz","fileCount":18,"integrity":"sha512-hIGk7fESo6uknU9WrzHOpS1n5j4AITeXYqzIFVC02OBGkpHJ04f+tdnimdcorwmIIOPFdn+SNldWxzvtMyMPYg==","signatures":[{"sig":"MEYCIQDAeS4/EQU3faHsEc21fuczVVr8Gc4YG2GK4le8U6eAQwIhAP+GvRuiWgSSTZH3S6xAH8M2bOstmUQFR5uoN/KdrzA7","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":58935},"cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"gitHead":"31354f26f1e421bab6a0f135c02ff6fc532edcef","_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"_npmVersion":"10.9.4","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","directories":{},"_nodeVersion":"22.22.0","dependencies":{"plist":"^3.0.1"},"_hasShrinkwrap":false,"devDependencies":{"xml-js":"^1.6.11"},"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-firebasex-performance_1.0.0_1773298579374_0.2989129079062225","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"cordova-plugin-firebasex-performance","version":"1.0.1","keywords":["cordova","firebase","performance","monitoring"],"author":{"name":"Dave Alden"},"license":"MIT","_id":"cordova-plugin-firebasex-performance@1.0.1","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"dist":{"shasum":"c542a4de8568569247b862602b83f96d66d0b920","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-1.0.1.tgz","fileCount":18,"integrity":"sha512-etiLNVvQyuazBTNbkpxNNyB5AVJn3MK5QFaf7G/OyZDoWdtgVuoClijxvlNzlzrv7eOKvMKNSxIZnxB2mmD9uQ==","signatures":[{"sig":"MEQCIARMHrIqsdkclF/X8Qmjfi8aEOdP0yeR+4aYDOn8U+ymAiBrxtwxH4uivRXQoI1rGrwahg5Xjdp1LN+hMu43DFIPrA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":59355},"cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"engines":{"cordovaDependencies":{"1.0.0":{"cordova":">=12","cordova-ios":">=7","cordova-android":">=14"}}},"gitHead":"6aff64c61e9289a36cb263e528ea894481615043","_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"repository":{"url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git","type":"git"},"_npmVersion":"10.9.4","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","directories":{},"_nodeVersion":"22.22.0","dependencies":{"plist":"^3.0.1"},"_hasShrinkwrap":false,"devDependencies":{"xml-js":"^1.6.11"},"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-firebasex-performance_1.0.1_1773385927433_0.3782724260512411","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"cordova-plugin-firebasex-performance","version":"1.0.2","keywords":["cordova","firebase","performance","monitoring"],"author":{"name":"Dave Alden"},"license":"MIT","_id":"cordova-plugin-firebasex-performance@1.0.2","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"dist":{"shasum":"c0ed3db957330b7daa25a062f655b2d2ffed8df9","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-1.0.2.tgz","fileCount":18,"integrity":"sha512-Uszzx6ZeaiYoh+RZb5nWR2H1l/CyjgyomnXimYZ/ufwBDIjtaQHhF1mi/MiTNv6WwUDyD5GLiAqDroOlTigrxQ==","signatures":[{"sig":"MEUCIHDzUZ6CWFwJHVYXQEkoK2GivPwJW+NrNmB270SI6mkkAiEAxA5k7Ikh719w0OwCBYioweWo7/eHEzCa1h2hJsn9aKQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":61936},"cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"engines":{"cordovaDependencies":{"1.0.0":{"cordova":">=12","cordova-ios":">=7","cordova-android":">=14"}}},"gitHead":"db24ae1d62d2e32a7b9bccafaf5a303ee93cff17","_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"repository":{"url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git","type":"git"},"_npmVersion":"10.9.4","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","directories":{},"_nodeVersion":"22.22.0","dependencies":{"plist":"^3.0.1"},"_hasShrinkwrap":false,"devDependencies":{"xml-js":"^1.6.11"},"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-firebasex-performance_1.0.2_1773646498927_0.35346965712801026","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"cordova-plugin-firebasex-performance","version":"1.0.3","keywords":["cordova","firebase","performance","monitoring"],"author":{"name":"Dave Alden"},"license":"MIT","_id":"cordova-plugin-firebasex-performance@1.0.3","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"dist":{"shasum":"ca31c72e1c63558728b55d90754054788c3f35da","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-1.0.3.tgz","fileCount":18,"integrity":"sha512-RIWbQo6yAKSBMPbaacnR1Aqwx6Rml0kDHdyq1bpfCPWj/nnpKUMAWFS9NHNk/pzET/Nryimvs5c5B+CGVzZwIQ==","signatures":[{"sig":"MEYCIQCtBbwBwrTtQKjsMAd7RizGLjzZ4rIY2sWWiG1Fw/njyQIhAK4SPYm84aI3vra8cS9GMW5yPhGF+H9o1DfSvBaUfaux","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":62113},"cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"engines":{"cordovaDependencies":{"1.0.0":{"cordova":">=12","cordova-ios":">=7","cordova-android":">=14"}}},"gitHead":"20508093ae7e1a8b185c68ea4a58f91f3c729d80","_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"repository":{"url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git","type":"git"},"_npmVersion":"10.9.4","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","directories":{},"_nodeVersion":"22.22.0","dependencies":{"plist":"^3.0.1"},"_hasShrinkwrap":false,"devDependencies":{"xml-js":"^1.6.11"},"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-firebasex-performance_1.0.3_1774029659192_0.9240226815830521","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"cordova-plugin-firebasex-performance","version":"2.0.0","keywords":["cordova","firebase","performance","monitoring"],"author":{"name":"Dave Alden"},"license":"MIT","_id":"cordova-plugin-firebasex-performance@2.0.0","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"dist":{"shasum":"7aaa5b855ff7fd19c653117c6ee406cc3b470759","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-2.0.0.tgz","fileCount":19,"integrity":"sha512-LOuGteRgkdMmtIw7y+BD5smKytu8CXfmcL3aH1OtC1Aq3KtgCzwAGJL1MQqI5aptwVeKhBEEgcsmwtDtv4ZSDQ==","signatures":[{"sig":"MEQCIDA5z2f+JRgHG+krSphal6EuYubBlkDxp1eDYShedU4tAiBzwmuxpm+1sSl6OLw9V+L0gGV1Ng/v95ycPuqtzoT7zA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":66057},"cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"engines":{"cordovaDependencies":{"1.0.0":{"cordova":">=12","cordova-ios":">=7","cordova-android":">=14"}}},"gitHead":"29378eaa6d88b5ac4e03e6633c983e38514074b6","_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"repository":{"url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git","type":"git"},"_npmVersion":"10.9.4","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","directories":{},"_nodeVersion":"22.22.0","dependencies":{"plist":"^3.0.1"},"_hasShrinkwrap":false,"devDependencies":{"xml-js":"^1.6.11"},"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-firebasex-performance_2.0.0_1780749569577_0.791440220935619","host":"s3://npm-registry-packages-npm-production"}},"2.0.1":{"name":"cordova-plugin-firebasex-performance","version":"2.0.1","keywords":["cordova","firebase","performance","monitoring"],"author":{"name":"Dave Alden"},"license":"MIT","_id":"cordova-plugin-firebasex-performance@2.0.1","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"dist":{"shasum":"cb4655d6fd838027826d891255c63a594b7603e0","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-2.0.1.tgz","fileCount":19,"integrity":"sha512-tFRpbgLJ4ps4AXX4Wk0N0oYujTKPJUw39y45Sc8IQVEivlIKi9+EtPvsGZkjFy1wnkvQInt1lusOSJB1/iqQ0g==","signatures":[{"sig":"MEUCIEaQRLB+pMzMCC0BXJasjIRp3GHM/tlND6KrtxSktjaZAiEA4Rw9+qr5rAh35UafHPw4WaTdLUrYPwJJ4+MH4XVpNwI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":66131},"cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"engines":{"cordovaDependencies":{"1.0.0":{"cordova":">=12","cordova-ios":">=7","cordova-android":">=14"}}},"gitHead":"b2b2ae71911dfd8dbbaf91b7f6501a5c54397ff4","_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"repository":{"url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git","type":"git"},"_npmVersion":"10.9.4","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","directories":{},"_nodeVersion":"22.22.0","dependencies":{"plist":"^3.0.1"},"_hasShrinkwrap":false,"devDependencies":{"xml-js":"^1.6.11"},"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-firebasex-performance_2.0.1_1787995947569_0.1364738788587061","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"cordova-plugin-firebasex-performance","version":"1.0.4","keywords":["cordova","firebase","performance","monitoring"],"author":{"name":"Dave Alden"},"license":"MIT","_id":"cordova-plugin-firebasex-performance@1.0.4","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"dist":{"shasum":"62205ae4e1f29cec53cd45e15a65af5554dff53d","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-1.0.4.tgz","fileCount":18,"integrity":"sha512-PiqMveLP5W3eIR5p/a6EQb2CgfGhgX5Up4sCHUvmAnALDzVV6O6MNdYaBhiHMCYsxEH/+sVSqsL+rHLJsEZIvw==","signatures":[{"sig":"MEUCIQDHU7D9jUr+m5KfILveXElQYbK7ZkbHIQxrreiiR26iQgIgBtw+Uzjsa46h4312zXOqsGXtgCmCQyZQ7hkO4QXbA+Q=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":62187},"cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"engines":{"cordovaDependencies":{"1.0.0":{"cordova":">=12","cordova-ios":">=7","cordova-android":">=14"}}},"gitHead":"73594672f4bab2efc68ed9d12c824ea31be036c8","_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"repository":{"url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git","type":"git"},"_npmVersion":"10.9.4","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","directories":{},"_nodeVersion":"22.22.0","dependencies":{"plist":"^3.0.1"},"_hasShrinkwrap":false,"devDependencies":{"xml-js":"^1.6.11"},"_npmOperationalInternal":{"tmp":"tmp/cordova-plugin-firebasex-performance_1.0.4_1787996068544_0.9788168924181939","host":"s3://npm-registry-packages-npm-production"}},"2.0.2":{"name":"cordova-plugin-firebasex-performance","version":"2.0.2","description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","author":{"name":"Dave Alden"},"license":"MIT","cordova":{"id":"cordova-plugin-firebasex-performance","platforms":["android","ios"]},"repository":{"type":"git","url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git"},"engines":{"cordovaDependencies":{"1.0.0":{"cordova":">=12","cordova-android":">=14","cordova-ios":">=7"}}},"keywords":["cordova","firebase","performance","monitoring"],"types":"types/index.d.ts","dependencies":{"plist":"^3.0.1"},"devDependencies":{"xml-js":"^1.6.11"},"_id":"cordova-plugin-firebasex-performance@2.0.2","gitHead":"f0af4793e63be8fe6248af4f6de5016cfdf8c55e","bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","_nodeVersion":"22.22.0","_npmVersion":"10.9.4","dist":{"integrity":"sha512-NG7o1W7RfkJR4WQ7hwJZcXTgSmYZZCJtm4ftBhFKQrS3JzLE1Ar3z3qteRPJeGcuJF/V/aNOBahMVckdtHVtAw==","shasum":"4f6ca0e733439f95c2af0266f3c9590df881293a","tarball":"https://registry.npmjs.org/cordova-plugin-firebasex-performance/-/cordova-plugin-firebasex-performance-2.0.2.tgz","fileCount":19,"unpackedSize":66354,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDKjaI9J4rsys+TQ6Duy6Us5WGi9EY0djHKD/689fnRIwIhAOM5bA9YxkSeS576/ax9x6Vzip4aIPhkME2gj2HUH9UL"}]},"_npmUser":{"name":"davealden","email":"dave@workingedge.co.uk"},"directories":{},"maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cordova-plugin-firebasex-performance_2.0.2_1788009337828_0.16461837330779905"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-12T06:56:19.373Z","modified":"2026-08-29T13:15:38.136Z","1.0.0":"2026-03-12T06:56:19.537Z","1.0.1":"2026-03-13T07:12:07.567Z","1.0.2":"2026-03-16T07:34:59.055Z","1.0.3":"2026-03-20T18:00:59.386Z","2.0.0":"2026-06-06T12:39:29.730Z","2.0.1":"2026-08-29T09:32:27.716Z","1.0.4":"2026-08-29T09:34:28.691Z","2.0.2":"2026-08-29T13:15:37.971Z"},"bugs":{"url":"https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues"},"author":{"name":"Dave Alden"},"license":"MIT","homepage":"https://github.com/dpa99c/cordova-plugin-firebasex-performance#readme","keywords":["cordova","firebase","performance","monitoring"],"repository":{"type":"git","url":"git+https://github.com/dpa99c/cordova-plugin-firebasex-performance.git"},"description":"Firebase Performance Monitoring module for cordova-plugin-firebasex","maintainers":[{"name":"davealden","email":"dave@workingedge.co.uk"}],"readme":"# cordova-plugin-firebasex-performance [![Latest Stable Version](https://img.shields.io/npm/v/cordova-plugin-firebasex-performance.svg)](https://www.npmjs.com/package/cordova-plugin-firebasex-performance)\n\nFirebase Performance Monitoring module for the [modular FirebaseX Cordova plugin suite](https://github.com/dpa99c/cordova-plugin-firebasex#modular-plugins).\n\nThe [Firebase Performance Monitoring SDK](https://firebase.google.com/docs/perf-mon) enables you to measure, monitor and analyze the performance of your app in the Firebase console.\n\nThis plugin wraps the [Firebase Performance Monitoring SDK](https://firebase.google.com/docs/perf-mon) and provides methods to control performance data collection and create custom performance traces in your Cordova app.\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**\n\n- [Installation](#installation)\n  - [Plugin variables](#plugin-variables)\n- [Android Performance Monitoring Gradle plugin](#android-performance-monitoring-gradle-plugin)\n- [Disable data collection on startup](#disable-data-collection-on-startup)\n- [API](#api)\n  - [setPerformanceCollectionEnabled](#setperformancecollectionenabled)\n  - [isPerformanceCollectionEnabled](#isperformancecollectionenabled)\n  - [startTrace](#starttrace)\n  - [incrementCounter](#incrementcounter)\n  - [stopTrace](#stoptrace)\n- [Reporting issues](#reporting-issues)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n# Installation\n\nInstall the plugin by adding it to your project's config.xml:\n\n    cordova plugin add cordova-plugin-firebasex-performance\n\nor by running:\n\n    cordova plugin add cordova-plugin-firebasex-performance\n\n**This module depends on `cordova-plugin-firebasex-core` which will be installed automatically as a dependency.**\n\n## Plugin variables\n\nThe following plugin variables are used to configure the performance module at install time.\nThey can be set on the command line at plugin installation time:\n\n    cordova plugin add cordova-plugin-firebasex-performance --variable VARIABLE_NAME=value\n\nOr in your `config.xml`:\n\n    <plugin name=\"cordova-plugin-firebasex-performance\">\n        <variable name=\"VARIABLE_NAME\" value=\"value\" />\n    </plugin>\n\n| Variable | Default | Description |\n|---|---|---|\n| `ANDROID_FIREBASE_PERF_VERSION` | `22.0.2` | Android Firebase Performance SDK version. |\n| `IOS_FIREBASE_SDK_VERSION` | `12.9.0` | iOS Firebase SDK version (for performance pod). |\n| `FIREBASE_PERFORMANCE_COLLECTION_ENABLED` | `true` | Whether to enable performance data collection on app startup. Set to `false` to [disable on startup](#disable-data-collection-on-startup) and enable at runtime using [`setPerformanceCollectionEnabled()`](#setperformancecollectionenabled). |\n| `ANDROID_FIREBASE_PERFORMANCE_MONITORING` | `false` | Whether to add the [Firebase Performance Monitoring Gradle plugin](#android-performance-monitoring-gradle-plugin) for automatic Android network request monitoring. |\n| `ANDROID_FIREBASE_PERF_GRADLE_PLUGIN_VERSION` | `2.0.1` | Version of the Firebase Performance Monitoring Gradle plugin to use. |\n\n# Android Performance Monitoring Gradle plugin\n\n-   The [Firebase Performance Monitoring Gradle plugin for Android](https://firebase.google.com/docs/perf-mon/get-started-android?authuser=0#add-perfmon-plugin) is required to enable automatic monitoring of network requests in Android apps.\n-   However, as [outlined here](https://proandroiddev.com/hidden-costs-of-firebase-performance-and-how-to-avoid-them-a54f96bafcb1), adding this Gradle plugin to your Android builds can significantly increase Android build times and memory usage.\n-   For this reason, the Gradle plugin is not added to your Android app builds by default.\n-   If you want to add it to make use of automatic network request monitoring on Android, set the `ANDROID_FIREBASE_PERFORMANCE_MONITORING` plugin variable at plugin install time:\n    -   `--variable ANDROID_FIREBASE_PERFORMANCE_MONITORING=true`\n-   If you choose to add it, the Gradle plugin currently requires Gradle v6.1.1 and Android Studio v4.0 or above.\n-   Note: on iOS when this plugin is installed, automatic network request monitoring takes place without requiring any extra configuration.\n\n# Disable data collection on startup\n\nBy default, performance data collection is enabled on app startup.\nTo disable this, set the `FIREBASE_PERFORMANCE_COLLECTION_ENABLED` plugin variable to `false` at install time:\n\n    cordova plugin add cordova-plugin-firebasex-performance --variable FIREBASE_PERFORMANCE_COLLECTION_ENABLED=false\n\nData collection can then be enabled/disabled at runtime using [`setPerformanceCollectionEnabled()`](#setperformancecollectionenabled).\n\n# API\n\nThe following methods are available via the `FirebasexPerformance` global object.\n\n## setPerformanceCollectionEnabled\n\nManually enable/disable performance data collection, e.g. if [disabled on app startup](#disable-data-collection-on-startup).\n\n**Parameters**:\n\n-   {boolean} setEnabled - whether to enable or disable performance data collection\n\n```javascript\nFirebasexPerformance.setPerformanceCollectionEnabled(true); // Enables performance data collection\n\nFirebasexPerformance.setPerformanceCollectionEnabled(false); // Disables performance data collection\n```\n\n## isPerformanceCollectionEnabled\n\nIndicates whether performance data collection is enabled.\n\nNotes:\n\n-   This value applies both to the current app session and subsequent app sessions until such time as it is changed.\n-   It returns the value set by [`setPerformanceCollectionEnabled()`](#setperformancecollectionenabled).\n-   If automatic data collection was not [disabled on app startup](#disable-data-collection-on-startup), this will always return `true`.\n\n**Parameters**:\n\n-   {function} success - callback function which will be invoked on success.\n    Will be passed a {boolean} indicating if the setting is enabled.\n-   {function} error - (optional) callback function which will be passed a {string} error message as an argument\n\n```javascript\nFirebasexPerformance.isPerformanceCollectionEnabled(\n    function (enabled) {\n        console.log(\n            \"Performance data collection is \" +\n                (enabled ? \"enabled\" : \"disabled\")\n        );\n    },\n    function (error) {\n        console.error(\n            \"Error getting Performance data collection setting: \" + error\n        );\n    }\n);\n```\n\n## startTrace\n\nStart a trace.\n\n**Parameters**:\n\n-   {string} name - name of trace to start\n-   {function} success - callback function to call on successfully starting trace\n-   {function} error - callback function which will be passed a {string} error message as an argument\n\n```javascript\nFirebasexPerformance.startTrace(\"test trace\", success, error);\n```\n\n## incrementCounter\n\nTo count the performance-related events that occur in your app (such as cache hits or retries), add a line of code similar to the following whenever the event occurs, using a string other than retry to name that event if you are counting a different type of event:\n\n**Parameters**:\n\n-   {string} name - name of trace\n-   {string} counterName - name of counter to increment\n-   {function} success - callback function to call on successfully incrementing counter\n-   {function} error - callback function which will be passed a {string} error message as an argument\n\n```javascript\nFirebasexPerformance.incrementCounter(\"test trace\", \"retry\", success, error);\n```\n\n## stopTrace\n\nStop the trace.\n\n**Parameters**:\n\n-   {string} name - name of trace to stop\n-   {function} success - callback function to call on successfully stopping trace\n-   {function} error - callback function which will be passed a {string} error message as an argument\n\n```javascript\nFirebasexPerformance.stopTrace(\"test trace\");\n```\n\n# Reporting issues\n\nBefore reporting an issue with this plugin, please do the following:\n- Check the existing [issues](https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues) to see if the issue has already been reported.\n- Check the [issue template](https://github.com/dpa99c/cordova-plugin-firebasex-performance/issues/new/choose) and provide all requested information.\n- The more information and context you provide, the easier it is for the maintainers to understand the issue and provide a resolution.\n","readmeFilename":"README.md"}