14 jours d'essai gratuit illimité. Pas de carte de crédit requise

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la commande suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Import

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

Démarrage rapide

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

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

Exemple : arrêter la trace

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

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

Exemple : incrémenter la métrique

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

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

Problèmes courants

• Sync natif: exécutez npx cap sync Après mises à jour du plugin.
• Source de vérité: trust src/definitions.ts au référentiel GitHub.

API : Présentation

startTrace

Démarrer une trace.

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

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

stopTrace

Arrête une trace.

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

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

incrementMetric

Atomiquement incrémente la métrique avec le nom spécifié pour la trace sélectionnée par incrementBy la valeur.

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

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

setEnabled

Active ou désactive la surveillance de la performance. Cela sera appliqué à la prochaine démarrage de l'application.

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

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

isEnabled

Détermine si la surveillance de la performance est activée ou désactivée.

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

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

putAttribute

Définit une attribut personnalisé d'une trace à une valeur spécifique.

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

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

getAttribute

Renvoie la valeur d'un attribut personnalisé d'une trace.

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

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

getAttributes

Obtient tous les attributs personnalisés d'une trace avec leurs valeurs.

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

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

removeAttribute

Supprime un attribut personnalisé d'une trace en fonction de son nom.

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

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

putMetric

Définit la valeur d'une métrique personnalisée.

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

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

getMetric

Récupère la valeur d'une métrique personnalisée par son nom.

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

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

record

Enregistre une trace donnée son nom et ses options.

Disponible uniquement sur le web.

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

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

Référence de type

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

Vérité Fondamentale

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the synchronisation lorsque l’API publique change en amont.

Continuez de Getting Started

Si vous utilisez Getting Started Getting Started pour planifier le tableau de bord et les opérations API, connectez-l’avec API Overview pour les détails d'implémentation dans API Overview Introduction pour les détails d'implémentation dans l'Introduction, API Clés pour les détails d'implémentation dans API Clés, Appareils pour les détails d'implémentation dans les appareils, et Bundles pour les détails d'implémentation dans Appareils, et