L'interfaccia che rappresenta una Trace
.
Firma:
export interface PerformanceTrace
Metodi
Metodo | Descrizione |
---|---|
getAttributo(attr) | Recupera il valore su cui è impostato un attributo personalizzato. |
ottieniAttributi() | Restituisce una mappa di tutti gli attributi personalizzati di un'istanza di traccia. |
getMetric(nomemetrica) | Restituisce il valore della metrica personalizzata con quel nome. Se una metrica personalizzata con quel nome non esiste, restituirà zero. |
incrementoMetric(metricName, num) | Aggiunge valore a una metrica personalizzata. Se una metrica personalizzata con il nome fornito non esiste, ne crea una con quel nome e il valore uguale al numero specificato. Il valore verrà ridotto a un numero intero. |
putAttribute(attr, valore) | Imposta un attributo personalizzato di una traccia su un determinato valore. |
putMetric(nomemetrico, num) | Imposta il valore della metrica personalizzata specificata sul numero specificato indipendentemente dal fatto che sull'istanza di traccia esista già o meno una metrica con quel nome. Il valore verrà ridotto a un numero intero. |
record(startTime, durata, opzioni) | Registra una traccia da determinati parametri. Ciò fornisce un modo diretto per utilizzare la traccia senza la necessità di avviare/interrompere. Ciò è utile per i casi d'uso in cui la traccia non può essere utilizzata direttamente (ad esempio se la durata è stata acquisita prima del caricamento di Performance SDK). |
rimuoviAttributo(attr) | Rimuove l'attributo personalizzato specificato da un'istanza di traccia. |
inizio() | Avvia la temporizzazione per l'istanza di traccia. |
fermare() | Arresta i tempi dell'istanza di traccia e registra i dati dell'istanza. |
PerformanceTrace.getAttribute()
Recupera il valore su cui è impostato un attributo personalizzato.
Firma:
getAttribute(attr: string): string | undefined;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
attr | corda | Nome dell'attributo personalizzato. |
Ritorna:
stringa | non definito
PerformanceTrace.getAttributes()
Restituisce una mappa di tutti gli attributi personalizzati di un'istanza di traccia.
Firma:
getAttributes(): {
[key: string]: string;
};
Ritorna:
{ [chiave: stringa]: stringa; }
PerformanceTrace.getMetric()
Restituisce il valore della metrica personalizzata con quel nome. Se una metrica personalizzata con quel nome non esiste, restituirà zero.
Firma:
getMetric(metricName: string): number;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
metricName | corda | Nome della metrica personalizzata. |
Ritorna:
numero
PerformanceTrace.incrementMetric()
Aggiunge valore a una metrica personalizzata. Se una metrica personalizzata con il nome fornito non esiste, ne crea una con quel nome e il valore uguale al numero specificato. Il valore verrà ridotto a un numero intero.
Firma:
incrementMetric(metricName: string, num?: number): void;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
metricName | corda | Il nome della metrica personalizzata. |
numero | numero | Il numero da aggiungere al valore della metrica personalizzata. Se non fornito, utilizza il valore predefinito pari a uno. |
Ritorna:
vuoto
PerformanceTrace.putAttribute()
Imposta un attributo personalizzato di una traccia su un determinato valore.
Firma:
putAttribute(attr: string, value: string): void;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
attr | corda | Nome dell'attributo personalizzato. |
valore | corda | Valore dell'attributo personalizzato. |
Ritorna:
vuoto
PerformanceTrace.putMetric()
Imposta il valore della metrica personalizzata specificata sul numero specificato indipendentemente dal fatto che sull'istanza di traccia esista già o meno una metrica con quel nome. Il valore verrà ridotto a un numero intero.
Firma:
putMetric(metricName: string, num: number): void;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
metricName | corda | Nome della metrica personalizzata. |
numero | numero | Valore della metrica personalizzata. |
Ritorna:
vuoto
PerformanceTrace.record()
Registra una traccia da determinati parametri. Ciò fornisce un modo diretto per utilizzare la traccia senza la necessità di avviare/interrompere. Ciò è utile per i casi d'uso in cui la traccia non può essere utilizzata direttamente (ad esempio se la durata è stata acquisita prima del caricamento di Performance SDK).
Firma:
record(startTime: number, duration: number, options?: {
metrics?: {
[key: string]: number;
};
attributes?: {
[key: string]: string;
};
}): void;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
Ora di inizio | numero | traccia l'ora di inizio dall'epoca in millisecondi. |
durata | numero | La durata della traccia in millisecondi. |
opzioni | { metriche?: { [chiave: stringa]: numero; }; attributi?: { [chiave: stringa]: stringa; }; } | Un oggetto che può facoltativamente contenere mappe di metriche personalizzate e attributi personalizzati. |
Ritorna:
vuoto
PerformanceTrace.removeAttribute()
Rimuove l'attributo personalizzato specificato da un'istanza di traccia.
Firma:
removeAttribute(attr: string): void;
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
attr | corda | Nome dell'attributo personalizzato. |
Ritorna:
vuoto
PerformanceTrace.start()
Avvia la temporizzazione per l'istanza di traccia.
Firma:
start(): void;
Ritorna:
vuoto
PerformanceTrace.stop()
Arresta i tempi dell'istanza di traccia e registra i dati dell'istanza.
Firma:
stop(): void;
Ritorna:
vuoto