PerformanceTrace interface

Interfejs reprezentujący Trace .

Podpis:

export interface PerformanceTrace 

Metody

metoda Opis
pobierzAtrybut(atrybut) Pobiera wartość, na którą ustawiono atrybut niestandardowy.
pobierzAtrybuty() Zwraca mapę wszystkich atrybutów niestandardowych instancji śledzenia.
getMetric(nazwa metryki) Zwraca wartość metryki niestandardowej o tej nazwie. Jeśli niestandardowa metryka o tej nazwie nie istnieje, zwróci zero.
inkrementMetryka(nazwa metryki, liczba) Zwiększa wartość metryki niestandardowej. Jeśli metryka niestandardowa o podanej nazwie nie istnieje, tworzy ją o tej nazwie i wartości równej podanej liczbie. Wartość zostanie obniżona do liczby całkowitej.
putAttribute(atrybut, wartość) Ustaw niestandardowy atrybut śledzenia na określoną wartość.
putMetric(nazwa metryki, liczba) Ustawia wartość określonej metryki niestandardowej na podaną liczbę niezależnie od tego, czy metryka o tej nazwie już istnieje w instancji śledzenia, czy nie. Wartość zostanie obniżona do liczby całkowitej.
rekord (czas rozpoczęcia, czas trwania, opcje) Rejestruje ślad z podanych parametrów. Zapewnia to bezpośredni sposób użycia śledzenia bez konieczności uruchamiania/zatrzymywania. Jest to przydatne w przypadkach użycia, w których nie można bezpośrednio użyć śledzenia (np. jeśli czas trwania został przechwycony przed załadowaniem zestawu SDK wydajności).
usuńAtrybut(atrybut) Usuwa określony atrybut niestandardowy z instancji śledzenia.
początek() Uruchamia chronometraż dla instancji śledzenia.
zatrzymywać się() Zatrzymuje chronometraż instancji śledzenia i rejestruje dane instancji.

PerformanceTrace.getAttribute()

Pobiera wartość, na którą ustawiono atrybut niestandardowy.

Podpis:

getAttribute(attr: string): string | undefined;

Parametry

Parametr Typ Opis
atr strunowy Nazwa atrybutu niestandardowego.

Zwroty:

ciąg | nieokreślony

PerformanceTrace.getAttributes()

Zwraca mapę wszystkich atrybutów niestandardowych instancji śledzenia.

Podpis:

getAttributes(): {
        [key: string]: string;
    };

Zwroty:

{ [klucz: ciąg]: ciąg; }

PerformanceTrace.getMetric()

Zwraca wartość metryki niestandardowej o tej nazwie. Jeśli niestandardowa metryka o tej nazwie nie istnieje, zwróci zero.

Podpis:

getMetric(metricName: string): number;

Parametry

Parametr Typ Opis
Nazwa metryki strunowy Nazwa metryki niestandardowej.

Zwroty:

numer

PerformanceTrace.inkrementMetric()

Zwiększa wartość metryki niestandardowej. Jeśli metryka niestandardowa o podanej nazwie nie istnieje, tworzy ją o tej nazwie i wartości równej podanej liczbie. Wartość zostanie obniżona do liczby całkowitej.

Podpis:

incrementMetric(metricName: string, num?: number): void;

Parametry

Parametr Typ Opis
Nazwa metryki strunowy Nazwa metryki niestandardowej.
liczba numer Liczba, która ma zostać dodana do wartości metryki niestandardowej. Jeśli nie zostanie podany, używa wartości domyślnej wynoszącej jeden.

Zwroty:

próżnia

PerformanceTrace.putAttribute()

Ustaw niestandardowy atrybut śledzenia na określoną wartość.

Podpis:

putAttribute(attr: string, value: string): void;

Parametry

Parametr Typ Opis
atr strunowy Nazwa atrybutu niestandardowego.
wartość strunowy Wartość atrybutu niestandardowego.

Zwroty:

próżnia

PerformanceTrace.putMetric()

Ustawia wartość określonej metryki niestandardowej na podaną liczbę, niezależnie od tego, czy metryka o tej nazwie już istnieje w instancji śledzenia, czy nie. Wartość zostanie obniżona do liczby całkowitej.

Podpis:

putMetric(metricName: string, num: number): void;

Parametry

Parametr Typ Opis
Nazwa metryki strunowy Nazwa metryki niestandardowej.
liczba numer Wartość metryki niestandardowej.

Zwroty:

próżnia

PerformanceTrace.record()

Rejestruje ślad z podanych parametrów. Zapewnia to bezpośredni sposób korzystania z funkcji śledzenia bez konieczności uruchamiania/zatrzymywania. Jest to przydatne w przypadkach użycia, w których nie można bezpośrednio użyć śledzenia (np. jeśli czas trwania został przechwycony przed załadowaniem zestawu SDK wydajności).

Podpis:

record(startTime: number, duration: number, options?: {
        metrics?: {
            [key: string]: number;
        };
        attributes?: {
            [key: string]: string;
        };
    }): void;

Parametry

Parametr Typ Opis
czas rozpoczęcia numer czas rozpoczęcia śledzenia od epoki w milisekundach.
czas trwania numer Czas trwania śledzenia w milisekundach.
opcje { metryki?: { [klucz: ciąg znaków]: liczba; }; atrybuty?: { [klucz: ciąg]: ciąg; }; } Obiekt, który opcjonalnie może przechowywać mapy niestandardowych metryk i atrybutów niestandardowych.

Zwroty:

próżnia

PerformanceTrace.removeAttribute()

Usuwa określony atrybut niestandardowy z instancji śledzenia.

Podpis:

removeAttribute(attr: string): void;

Parametry

Parametr Typ Opis
atr strunowy Nazwa atrybutu niestandardowego.

Zwroty:

próżnia

PerformanceTrace.start()

Uruchamia chronometraż dla instancji śledzenia.

Podpis:

start(): void;

Zwroty:

próżnia

PerformanceTrace.stop()

Zatrzymuje chronometraż instancji śledzenia i rejestruje dane instancji.

Podpis:

stop(): void;

Zwroty:

próżnia