跳过内容

Page/area: Capgo marketing website. Role: Website copy sentence. Seen in: component doc/SignupCta.astro, component Hero.astro. Message key `hero_subtitle_v2` (Hero Subtitle V2).

GitHub

您可以使用我们的AI辅助设置来安装插件。将Capgo技能添加到您的AI工具中,使用以下命令:

终端窗口
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

context:Capgo营销网站。角色:UI标签。见于:页面代理/[slug].astro。消息键`agents_page_copy_label`(代理页面复制标签)。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-performance` plugin in my project.

然后使用以下提示:

终端窗口
bun add @capgo/capacitor-firebase-performance
bunx cap sync

Import

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

API概述

API概述

开始跟踪

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.startTrace({ traceName: 'trace' });

stopTrace

停止跟踪

增加指标

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.stopTrace({ traceName: 'trace' });

原子性地将给定名称的指标值增加给定值 incrementBy value.

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.incrementMetric({
traceName: 'trace',
metricName: 'metric',
});

setEnabled

setEnabled

启用或禁用性能监控。 下次应用启动时生效。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.setEnabled({ enabled: true });

isEnabled

isEnabled

确定性能监控是否启用或禁用。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
const result = await FirebasePerformance.isEnabled();
console.log(result);

putAttribute

putAttribute

设置跟踪的自定义属性。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.putAttribute({
traceName: 'trace',
attribute: "experiment",
value: "A",
});

getAttribute

getAttribute

获取跟踪的自定义属性值。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
const result = await FirebasePerformance.getAttribute({
traceName: 'trace',
attribute: 'attribute',
});
console.log(result);

getAttributes

获取属性

获取所有跟踪的自定义属性及其值。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
const result = await FirebasePerformance.getAttributes({ traceName: 'trace' });
console.log(result);

removeAttribute

移除属性

移除跟踪的自定义属性。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.removeAttribute({
traceName: 'trace',
attribute: 'attribute',
});

获取指标

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.putMetric({
traceName: 'trace',
metricName: 'metric',
num: 1,
});

复制到剪贴板

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
const result = await FirebasePerformance.getMetric({
traceName: 'trace',
metricName: 'metric',
});
console.log(result);

record

记录

根据名称和选项记录一个跟踪。

仅在Web上可用。

import { FirebasePerformance } from '@capgo/capacitor-firebase-performance';
await FirebasePerformance.record({
traceName: 'trace',
startTime: 10,
duration: 1000,
});

类型参考

类型参考

StartTraceOptions

开始跟踪选项
export interface StartTraceOptions {
/**
* 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.
*
* @since 0.1.0
*/
traceName: string;
}

StopTraceOptions

停止跟踪选项
export interface StopTraceOptions {
/**
* Name of the trace that was set with `startTrace`.
*
* @since 0.1.0
*/
traceName: string;
}

IncrementMetricOptions

增量指标选项
export interface IncrementMetricOptions {
/**
* Name of the trace that was set with `startTrace`.
*
* @since 0.1.0
*/
traceName: string;
/**
* Name of the metric to be incremented.
*
* @since 0.1.0
*/
metricName: string;
/**
* Amount by which the metric has to be incremented.
*
* @default 1
* @since 0.1.0
*/
incrementBy?: number;
}

SetEnabledOptions

设置启用选项
export interface SetEnabledOptions {
/**
* Should performance monitoring be enabled.
*
* @since 0.1.0
*/
enabled: boolean;
}

IsEnabledResult

是否启用结果
export interface IsEnabledResult {
/**
* `true` if performance monitoring is enabled, otherwise `false`.
*
* @since 0.1.0
*/
enabled: boolean;
}

PutAttributeOptions

设置属性选项
export interface PutAttributeOptions {
/**
* Name of the trace to set its attribute.
*
* @since 6.3.0
*/
traceName: string;
/**
* Name of the attribute to set its value.
*
* @since 6.3.0
* @example "experiment"
*/
attribute: string;
/**
* The value to set to the attribute.
*
* @since 6.3.0
* @example "A"
*/
value: string;
}

GetAttributeOptions

获取属性选项
export interface GetAttributeOptions {
/**
* Name of the trace to set its attribute.
*
* @since 6.3.0
*/
traceName: string;
/**
* Name of the attribute to retrieve its value.
*
* @since 6.3.0
*/
attribute: string;
}

GetAttributeResult

获取属性结果
export interface GetAttributeResult {
/**
* The value of the custom attribute.
*
* @since 6.3.0
*/
value: string | null;
}

GetAttributesOptions

获取属性选项
export interface GetAttributesOptions {
/**
* Name of the trace to get its attributes.
*
* @since 6.3.0
*/
traceName: string;
}

GetAttributesResult

获取属性结果
export interface GetAttributesResult {
/**
* A map of all custom attributes of a trace with their values.
*
* @since 6.3.0
*/
attributes: { [key: string]: string };
}

RemoveAttributeOptions

移除属性选项
export type RemoveAttributeOptions = GetAttributeOptions;

PutMetricOptions

添加指标选项
export interface PutMetricOptions {
/**
* Name of the trace to set its metric.
*
* @since 6.3.0
*/
traceName: string;
/**
* The metric name.
*
* @since 6.3.0
*/
metricName: string;
/**
* The value to set for the metric.
* The given value is floored down to the nearest integer.
*
* @since 6.3.0
*/
num: number;
}

真实来源

真实来源

本页面由插件生成 src/definitions.ts当公共API上游更改时,请重新同步

如果您正在使用 开始使用 来规划仪表板和API操作,连接它与 API概览 为API概览中的实施细节 介绍 为介绍中的实施细节 API密钥 为API密钥中的实施细节 设备 为设备中的实施细节 套件 为套件的实现细节。