{"_id":"@capgo/capacitor-firebase-performance","_rev":"4-40d98d6feca4d6fea9d93bac9e388c78","name":"@capgo/capacitor-firebase-performance","dist-tags":{"latest":"7.4.2"},"versions":{"7.4.0":{"name":"@capgo/capacitor-firebase-performance","version":"7.4.0","keywords":["capacitor","plugin","native"],"author":{"name":"Capgo Team"},"license":"Apache-2.0","_id":"@capgo/capacitor-firebase-performance@7.4.0","maintainers":[{"name":"riderx","email":"martin.donadieu@hey.com"}],"homepage":"https://capgo.app/","bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"dist":{"shasum":"2d4cc28a26f605ce4ec0c7a6ce7fca45331ec240","tarball":"https://registry.npmjs.org/@capgo/capacitor-firebase-performance/-/capacitor-firebase-performance-7.4.0.tgz","fileCount":27,"integrity":"sha512-qNTXPmqXxOQJyUmyCMFHWloqUMPCa5YJ9LY1FH/vyAtFHAlKe9lycS+T4R2nGQOaEy5oRkscGYJU+d8Ur4PDMA==","signatures":[{"sig":"MEUCIQCEbLDth1iMFUa3PV48P6M4yBZ2Ynw5TH90U3KbelofDwIgMhRvBlogLdN1DL6lwrJO91V3UcGhpYz62dke+s+ELT8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":129235},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"97786da96a720a520f80ac1031a0f12063f135d7","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api FirebasePerformancePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild -scheme CapgoCapacitorFirebasePerformance -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"riderx","email":"martin.donadieu@hey.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"_npmVersion":"11.6.2","description":"Capacitor plugin for Firebase Performance Monitoring.","directories":{},"_nodeVersion":"24.11.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","firebase":"12.6.0","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"firebase":"12.6.0","@capacitor/core":">=7.0.0"},"peerDependenciesMeta":{"firebase":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-performance_7.4.0_1763999185924_0.9199586273620699","host":"s3://npm-registry-packages-npm-production"}},"7.4.1":{"name":"@capgo/capacitor-firebase-performance","version":"7.4.1","keywords":["capacitor","plugin","native"],"author":{"name":"Capgo Team"},"license":"Apache-2.0","_id":"@capgo/capacitor-firebase-performance@7.4.1","maintainers":[{"name":"riderx","email":"martin.donadieu@hey.com"}],"homepage":"https://capgo.app/","bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"dist":{"shasum":"e82213296628301fed691f3feba89ba1e14b2189","tarball":"https://registry.npmjs.org/@capgo/capacitor-firebase-performance/-/capacitor-firebase-performance-7.4.1.tgz","fileCount":27,"integrity":"sha512-A2mdTqIqMhsstOs7nzboEV9mwAvwgje1s9FK4BACuTpvoG2adZe3JhqItOSzukKIxH6wkFzPm+6CVJdTry1Qqg==","signatures":[{"sig":"MEUCIDMgqXcuBxl9F2e4MJWThYKxF/cEZyq1+BeadjHGlgBIAiEA0mTdeGZOrq0TmUxva4Ut5Hh0yg0YmpECaCwYyD0MEHY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":129235},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"c965f5a7def32792245434af874be9775557c34d","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api FirebasePerformancePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild -scheme CapgoCapacitorFirebasePerformance -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"riderx","email":"martin.donadieu@hey.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"_npmVersion":"11.6.2","description":"Capacitor plugin for Firebase Performance Monitoring.","directories":{},"_nodeVersion":"24.11.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","firebase":"12.6.0","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"firebase":"12.6.0","@capacitor/core":">=7.0.0"},"peerDependenciesMeta":{"firebase":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-performance_7.4.1_1763999747727_0.6623719387143152","host":"s3://npm-registry-packages-npm-production"}},"7.4.2":{"name":"@capgo/capacitor-firebase-performance","version":"7.4.2","keywords":["capacitor","plugin","native"],"author":{"name":"Capgo Team"},"license":"MPL-2.0","_id":"@capgo/capacitor-firebase-performance@7.4.2","maintainers":[{"name":"riderx","email":"martin.donadieu@hey.com"}],"homepage":"https://capgo.app/","bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"dist":{"shasum":"c9c6da2cd98dbb62fa5a3d0143cccac293ab33db","tarball":"https://registry.npmjs.org/@capgo/capacitor-firebase-performance/-/capacitor-firebase-performance-7.4.2.tgz","fileCount":27,"integrity":"sha512-VrOIzCja7gGnt2xpnx9aNEobNbu92KqGzurjg72TXqiTDrYIpv/ZK2e1KR1lDfiUshIgS6tdZdEkHx4cg2zq1w==","signatures":[{"sig":"MEQCIAwOVUegSi2klWLGymE3ZiX+Er1i3sKA85u2Kxck3ammAiAJrtGO5YyuQNfuO+xq8kOFnydVKWkUAuUECpgopdNCDw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":134617},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"8d8a06c3dfefe13eb43aaf4313ef701ee9a76767","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api FirebasePerformancePlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild -scheme CapgoCapacitorFirebasePerformance -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"riderx","email":"martin.donadieu@hey.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"_npmVersion":"11.6.2","description":"Capacitor plugin for Firebase Performance Monitoring.","directories":{},"_nodeVersion":"24.11.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.0.1","rollup":"4.30.1","firebase":"12.6.0","prettier":"3.4.2","swiftlint":"2.0.0","typescript":"4.1.5","@capacitor/cli":"7.0.0","@capacitor/ios":"7.0.0","@capacitor/core":"7.0.0","@capacitor/docgen":"0.3.0","@capacitor/android":"7.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"2.0.0"},"peerDependencies":{"firebase":"12.6.0","@capacitor/core":">=7.0.0"},"peerDependenciesMeta":{"firebase":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/capacitor-firebase-performance_7.4.2_1764858720732_0.43660859935165974","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-11-24T15:46:25.730Z","modified":"2026-08-19T10:40:44.734Z","7.4.0":"2025-11-24T15:46:26.097Z","7.4.1":"2025-11-24T15:55:47.906Z","7.4.2":"2025-12-04T14:32:00.881Z"},"bugs":{"url":"https://github.com/Cap-go/capacitor-firebase/issues"},"author":{"name":"Capgo Team"},"license":"MPL-2.0","homepage":"https://capgo.app/","keywords":["capacitor","plugin","native"],"repository":{"url":"git+https://github.com/Cap-go/capacitor-firebase.git","type":"git"},"description":"Capacitor plugin for Firebase Performance Monitoring.","maintainers":[{"email":"martin.donadieu@hey.com","name":"riderx"},{"email":"tori@capgo.app","name":"torichancapgo"}],"readme":"# @capacitor-firebase/performance\n\nUnofficial Capacitor plugin for [Firebase Performance Monitoring](https://firebase.google.com/docs/perf-mon).[^1]\n\n
\n \n \"Deliver\n \n
\n\n## Installation\n\n```bash\nnpm install @capacitor-firebase/performance firebase\nnpx cap sync\n```\n\nAdd 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)).\n\n### Android\n\nSee [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.\n\n#### Variables\n\nIf needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency:\n\n- `$firebasePerfVersion` version of `com.google.firebase:firebase-perf` (default: `21.0.4`)\n\nThis can be useful if you encounter dependency conflicts with other plugins in your project.\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## Demo\n\nA working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)\n\n## Usage\n\n```typescript\nimport { FirebasePerformance } from '@capacitor-firebase/performance';\n\nconst startTrace = async () => {\n await FirebasePerformance.startTrace({ traceName: 'test_trace' });\n};\n\nconst stopTrace = async () => {\n await FirebasePerformance.stopTrace({ traceName: 'test_trace' });\n};\n\nconst incrementMetric = async () => {\n await FirebasePerformance.incrementMetric({\n traceName: 'test_trace',\n metricName: 'item_cache_hit',\n incrementBy: 1,\n });\n};\n\nconst setEnabled = async () => {\n await FirebasePerformance.setEnabled({ enabled: true });\n};\n\nconst isEnabled = async () => {\n const result = await FirebasePerformance.isEnabled();\n return result.enabled;\n};\n\nconst putAttribute = async () => {\n await FirebasePerformance.putAttribute({\n traceName: 'test_trace',\n attribute: 'user_id',\n value: '123',\n });\n};\n\nconst getAttribute = async () => {\n const result = await FirebasePerformance.getAttribute({\n traceName: 'test_trace',\n attribute: 'user_id',\n });\n return result.attributes;\n};\n\nconst getAttributes = async () => {\n const result = await FirebasePerformance.getAttributes({ traceName: 'test_trace' });\n return result.attributes;\n};\n\nconst removeAttribute = async () => {\n await FirebasePerformance.removeAttribute({\n traceName: 'test_trace',\n attribute: 'user_id',\n });\n};\n\nconst putMetric = async () => {\n await FirebasePerformance.putMetric({\n traceName: 'test_trace',\n metricName: 'item_cache_hit',\n num: 1,\n });\n};\n\nconst getMetric = async () => {\n const result = await FirebasePerformance.getMetric({\n traceName: 'test_trace',\n metricName: 'item_cache_hit',\n });\n return result.value;\n};\n\nconst record = async () => {\n await FirebasePerformance.record({\n traceName: 'test_trace',\n startTime: Date.now(),\n duration: 1000,\n options: {\n metrics: {\n item_cache_hit: 1,\n },\n attributes: {\n user_id: '123',\n },\n },\n });\n};\n```\n\n## API\n\n\n\n* [`startTrace(...)`](#starttrace)\n* [`stopTrace(...)`](#stoptrace)\n* [`incrementMetric(...)`](#incrementmetric)\n* [`setEnabled(...)`](#setenabled)\n* [`isEnabled()`](#isenabled)\n* [`putAttribute(...)`](#putattribute)\n* [`getAttribute(...)`](#getattribute)\n* [`getAttributes(...)`](#getattributes)\n* [`removeAttribute(...)`](#removeattribute)\n* [`putMetric(...)`](#putmetric)\n* [`getMetric(...)`](#getmetric)\n* [`record(...)`](#record)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\n\n\n\n\n### startTrace(...)\n\n```typescript\nstartTrace(options: StartTraceOptions) => Promise\n```\n\nStarts a trace.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------- |\n| **`options`** | StartTraceOptions |\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### stopTrace(...)\n\n```typescript\nstopTrace(options: StopTraceOptions) => Promise\n```\n\nStops a trace.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | StopTraceOptions |\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### incrementMetric(...)\n\n```typescript\nincrementMetric(options: IncrementMetricOptions) => Promise\n```\n\nAtomically increments the metric with the given name for the selected trace by the `incrementBy` value.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------------- |\n| **`options`** | IncrementMetricOptions |\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### setEnabled(...)\n\n```typescript\nsetEnabled(options: SetEnabledOptions) => Promise\n```\n\nEnables or disables performance monitoring.\nWill be applied with the next start of the app.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------- |\n| **`options`** | SetEnabledOptions |\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### isEnabled()\n\n```typescript\nisEnabled() => Promise\n```\n\nDetermines whether performance monitoring is enabled or disabled.\n\n**Returns:** Promise<IsEnabledResult>\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### putAttribute(...)\n\n```typescript\nputAttribute(options: PutAttributeOptions) => Promise\n```\n\nSets a custom attribute of a trace to a given value.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------- |\n| **`options`** | PutAttributeOptions |\n\n**Since:** 6.3.0\n\n--------------------\n\n\n### getAttribute(...)\n\n```typescript\ngetAttribute(options: GetAttributeOptions) => Promise\n```\n\nReturns the value of a custom attribute of a trace.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------- |\n| **`options`** | GetAttributeOptions |\n\n**Returns:** Promise<GetAttributeResult>\n\n**Since:** 6.3.0\n\n--------------------\n\n\n### getAttributes(...)\n\n```typescript\ngetAttributes(options: GetAttributesOptions) => Promise\n```\n\nGets the all the custom attributes of a trace with their values.\n\n| Param | Type |\n| ------------- | --------------------------------------------------------------------- |\n| **`options`** | GetAttributesOptions |\n\n**Returns:** Promise<GetAttributesResult>\n\n**Since:** 6.3.0\n\n--------------------\n\n\n### removeAttribute(...)\n\n```typescript\nremoveAttribute(options: RemoveAttributeOptions) => Promise\n```\n\nRemoves a custom attribute from a trace given its name.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------------- |\n| **`options`** | GetAttributeOptions |\n\n**Since:** 6.3.0\n\n--------------------\n\n\n### putMetric(...)\n\n```typescript\nputMetric(options: PutMetricOptions) => Promise\n```\n\nSets the value of a custom metric.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | PutMetricOptions |\n\n**Since:** 6.3.0\n\n--------------------\n\n\n### getMetric(...)\n\n```typescript\ngetMetric(options: GetMetricOptions) => Promise\n```\n\nGet the value of a custom metric by name.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------------- |\n| **`options`** | GetMetricOptions |\n\n**Returns:** Promise<GetMetricResult>\n\n**Since:** 6.3.0\n\n--------------------\n\n\n### record(...)\n\n```typescript\nrecord(options: RecordOptions) => Promise\n```\n\nRecords a trace given its name and options.\n\nOnly available on web.\n\n| Param | Type |\n| ------------- | ------------------------------------------------------- |\n| **`options`** | RecordOptions |\n\n**Since:** 6.3.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### StartTraceOptions\n\n| Prop | Type | Description | Since |\n| --------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`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 |\n\n\n#### StopTraceOptions\n\n| Prop | Type | Description | Since |\n| --------------- | ------------------- | ------------------------------------------------- | ----- |\n| **`traceName`** | string | Name of the trace that was set with `startTrace`. | 0.1.0 |\n\n\n#### IncrementMetricOptions\n\n| Prop | Type | Description | Default | Since |\n| ----------------- | ------------------- | ------------------------------------------------- | -------------- | ----- |\n| **`traceName`** | string | Name of the trace that was set with `startTrace`. | | 0.1.0 |\n| **`metricName`** | string | Name of the metric to be incremented. | | 0.1.0 |\n| **`incrementBy`** | number | Amount by which the metric has to be incremented. | 1 | 0.1.0 |\n\n\n#### SetEnabledOptions\n\n| Prop | Type | Description | Since |\n| ------------- | -------------------- | ----------------------------------------- | ----- |\n| **`enabled`** | boolean | Should performance monitoring be enabled. | 0.1.0 |\n\n\n#### IsEnabledResult\n\n| Prop | Type | Description | Since |\n| ------------- | -------------------- | --------------------------------------------------------------- | ----- |\n| **`enabled`** | boolean | `true` if performance monitoring is enabled, otherwise `false`. | 0.1.0 |\n\n\n#### PutAttributeOptions\n\n| Prop | Type | Description | Since |\n| --------------- | ------------------- | --------------------------------------- | ----- |\n| **`traceName`** | string | Name of the trace to set its attribute. | 6.3.0 |\n| **`attribute`** | string | Name of the attribute to set its value. | 6.3.0 |\n| **`value`** | string | The value to set to the attribute. | 6.3.0 |\n\n\n#### GetAttributeResult\n\n| Prop | Type | Description | Since |\n| ----------- | --------------------------- | ---------------------------------- | ----- |\n| **`value`** | string \\| null | The value of the custom attribute. | 6.3.0 |\n\n\n#### GetAttributeOptions\n\n| Prop | Type | Description | Since |\n| --------------- | ------------------- | -------------------------------------------- | ----- |\n| **`traceName`** | string | Name of the trace to set its attribute. | 6.3.0 |\n| **`attribute`** | string | Name of the attribute to retrieve its value. | 6.3.0 |\n\n\n#### GetAttributesResult\n\n| Prop | Type | Description | Since |\n| ---------------- | --------------------------------------- | ------------------------------------------------------------ | ----- |\n| **`attributes`** | { [key: string]: string; } | A map of all custom attributes of a trace with their values. | 6.3.0 |\n\n\n#### GetAttributesOptions\n\n| Prop | Type | Description | Since |\n| --------------- | ------------------- | ---------------------------------------- | ----- |\n| **`traceName`** | string | Name of the trace to get its attributes. | 6.3.0 |\n\n\n#### PutMetricOptions\n\n| Prop | Type | Description | Since |\n| ---------------- | ------------------- | ---------------------------------------------------------------------------------------- | ----- |\n| **`traceName`** | string | Name of the trace to set its metric. | 6.3.0 |\n| **`metricName`** | string | The metric name. | 6.3.0 |\n| **`num`** | number | The value to set for the metric. The given value is floored down to the nearest integer. | 6.3.0 |\n\n\n#### GetMetricResult\n\n| Prop | Type | Description | Since |\n| ----------- | ------------------- | ---------------------------------- | ----- |\n| **`value`** | number | The value of the metric if exists. | 6.3.0 |\n\n\n#### GetMetricOptions\n\n| Prop | Type | Description | Since |\n| ---------------- | ------------------- | ------------------------------------ | ----- |\n| **`traceName`** | string | Name of the trace to get its metric. | 6.3.0 |\n| **`metricName`** | string | The metric name. | 6.3.0 |\n\n\n#### RecordOptions\n\n| Prop | Type | Description | Since |\n| --------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----- |\n| **`traceName`** | string | Name of the trace to record. | 6.3.0 |\n| **`startTime`** | number | Start time of the trace since epoch in milliseconds. | 6.3.0 |\n| **`duration`** | number | The duration of the trace in milliseconds. | 6.3.0 |\n| **`options`** | { metrics?: { [key: string]: number; }; attributes?: { [key: string]: string; }; } | An optional object that holds optional maps of custom metrics and attributes. | 6.3.0 |\n\n\n### Type Aliases\n\n\n#### RemoveAttributeOptions\n\nGetAttributeOptions\n\n\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/performance/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/performance/LICENSE).\n\n[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.\n","readmeFilename":"README.md"}