Panduan Memulai

Instal

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

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

Impor

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

Mulai cepat

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

await FirebasePerformance.startTrace({ traceName: 'trace' });

Contoh: stopTrace

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

await FirebasePerformance.stopTrace({ traceName: 'trace' });

Contoh: incrementMetric

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

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

Kesalahan umum

• Sinkronisasi Native: jalankan npx cap sync setelah upgrade plugin.
• Sumber kebenaran tunggal: percayai src/definitions.ts di repo GitHub.

Ringkasan API

startTrace

Memulai sebuah trace.

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

await FirebasePerformance.startTrace({ traceName: 'trace' });

stopTrace

Menghentikan sebuah trace.

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

await FirebasePerformance.stopTrace({ traceName: 'trace' });

incrementMetric

Menambah nilai metric secara atomik dengan nama yang ditentukan untuk trace yang dipilih sebesar incrementBy nilainya.

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

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

setEnabled

Mengaktifkan atau menonaktifkan monitoring performa. Akan diterapkan saat aplikasi dijalankan berikutnya.

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

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

isEnabled

Menentukan apakah monitoring performa diaktifkan atau dinonaktifkan.

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

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

putAttribute

Menetapkan atribut kustom pada trace ke nilai tertentu.

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

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

getAttribute

Mengembalikan nilai dari custom attribute sebuah trace.

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

const result = await FirebasePerformance.getAttribute({
  traceName: 'trace',
  attribute: 'attribute',
});
console.log(result);

getAttributes

Mengambil semua custom attribute dari sebuah trace beserta nilainya.

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

const result = await FirebasePerformance.getAttributes({ traceName: 'trace' });
console.log(result);

removeAttribute

Menghapus atribut kustom dari trace berdasarkan namanya.

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

await FirebasePerformance.removeAttribute({
  traceName: 'trace',
  attribute: 'attribute',
});

putMetric

Mengatur nilai dari metrik kustom.

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

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

getMetric

Mengambil nilai metrik kustom berdasarkan namanya.

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

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

record

Merekam trace berdasarkan nama dan opsinya.

Hanya tersedia di web.

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

await FirebasePerformance.record({
  traceName: 'trace',
  startTime: 10,
  duration: 1000,
});

Referensi Tipe

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

Sumber Kebenaran

Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, Perangkat untuk detail implementasi di Devices, dan Bundle untuk detail implementasi di Bundles.