Getting Started

설치

AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요:

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

그다음에 다음 명령어를 사용하세요:

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

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:

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

import

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

API 개요

startTrace

추적 시작

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' });

incrementMetric

선택한 추적에서 주어진 이름의 메트릭을 원자적으로 증가시킵니다. incrementBy 값.

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

await FirebasePerformance.incrementMetric({
  traceName: 'trace',
  metricName: 'metric',
});

setEnabled

성능 모니터링을 사용하거나 사용하지 않도록 설정합니다. 앱이 다음으로 시작할 때 적용됩니다.

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

await FirebasePerformance.setEnabled({ enabled: true });

isEnabled

성능 모니터링이 사용중인지 사용하지중인지 여부를 결정합니다.

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

const result = await FirebasePerformance.isEnabled();
console.log(result);

putAttribute

트레이스에 사용자 정의 속성을 지정한 값으로 설정합니다.

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

await FirebasePerformance.putAttribute({
  traceName: 'trace',
  attribute: "experiment",
  value: "A",
});

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',
});

putMetric

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

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

await FirebasePerformance.putMetric({
  traceName: 'trace',
  metricName: 'metric',
  num: 1,
});

getMetric

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

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

const result = await FirebasePerformance.getMetric({
  traceName: 'trace',
  metricName: 'metric',
});
console.log(result);

record

기록 이름과 옵션을 기준으로 trace를 기록합니다.

웹에서만 사용 가능합니다.

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

Getting Started에서 계속하세요

만약에 시작하기 계획 대시보드와 API 연산을 위해 API 개요 API 개요 Introduction 에서 구현 세부 정보를 확인하세요. API 키 API 키 구현 세부 사항에 대해 Devices 에서 구현 세부 정보를 확인하세요. 플러그인 플러그인 구현 세부 사항에 대한 정보입니다.