Getting Started

설치

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

수입

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

API 개요

startTrace

트레이스 시작.

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

await FirebasePerformance.startTrace({} as StartTraceOptions);

stopTrace

트레이스 종료.

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

await FirebasePerformance.stopTrace({} as StopTraceOptions);

incrementMetric

trace의 선택된 metric에 주어진 이름으로 원자적으로 증가시킵니다. incrementBy __CAPGO_KEEP_0__입니다.

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

await FirebasePerformance.incrementMetric({} as IncrementMetricOptions);

setEnabled

성능 모니터링을 사용하거나 사용하지 않습니다. 앱이 다음으로 시작될 때 적용됩니다.

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

await FirebasePerformance.setEnabled({} as SetEnabledOptions);

isEnabled

성능 모니터링이 사용하거나 사용하지 않는지 결정합니다.

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

await FirebasePerformance.isEnabled();

putAttribute

트레이스에 지정된 값을 사용하여 사용자 지정 속성을 설정합니다.

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

await FirebasePerformance.putAttribute({} as PutAttributeOptions);

getAttribute

트레이스의 사용자 지정 속성의 값을 반환합니다.

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

await FirebasePerformance.getAttribute({} as GetAttributeOptions);

getAttributes

trace의 모든 사용자 지정 속성을 가져옵니다.

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

await FirebasePerformance.getAttributes({} as GetAttributesOptions);

removeAttribute

trace에서 사용자 지정 속성을 제거합니다.

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

await FirebasePerformance.removeAttribute({} as RemoveAttributeOptions);

putMetric

사용자 지정 메트릭의 값을 설정합니다.

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

await FirebasePerformance.putMetric({} as PutMetricOptions);

getMetric

사용자 지정 메트릭의 값을 가져옵니다.

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

await FirebasePerformance.getMetric({} as GetMetricOptions);

record

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

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

await FirebasePerformance.record({} as RecordOptions);

__CAPGO_KEEP_4__

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이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하기

__CAPGO_KEEP_0__를 사용 중이라면 Getting Started API와의 연결을 통해 대시보드 및 API 운영을 계획하세요. API 개요 API 개요에서 구현 세부 정보를 확인하세요. Introduction Introduction에서 구현 세부 정보를 확인하세요. API 키 API 키에서 구현 세부 정보를 확인하세요. Devices Devices에서 구현 세부 정보를 확인하세요. Bundles __CAPGO_KEEP_0__ 구현 세부 사항입니다.