PerformanceTrace interface

Interfejs przedstawiający Trace.

Podpis:

export interface PerformanceTrace

Metody

Metoda Opis
getAttribute(attr), Pobiera wartość ustawioną dla atrybutu niestandardowego.
getAttributes() Zwraca mapę wszystkich niestandardowych atrybutów instancji śledzenia.
getMetric(metricName) Zwraca wartość danych niestandardowych o tej nazwie. Jeśli dane niestandardowe o takiej nazwie nie istnieją, zwracają zero.
incrementMetric(metricName; num) Dodaje wartość danych niestandardowych. Jeśli dane niestandardowe o podanej nazwie nie istnieją, zostaną utworzone o tej nazwie i o wartości równej podanej liczbie. Wartość zostanie obniżona do liczby całkowitej.
putAttribute(attr; wartość) Ustaw niestandardowy atrybut logu czasu na określoną wartość.
putMetric(nazwa_danych; num) Ustawia wartość określonych danych niestandardowych na podaną liczbę niezależnie od tego, czy wskaźnik o tej nazwie istnieje już w instancji logu czasu. Wartość zostanie obniżona do liczby całkowitej.
record(startTime, czas trwania, opcje) Rejestruje log czasu na podstawie podanych parametrów. Zapewnia to bezpośredni sposób korzystania ze śledzenia bez konieczności uruchamiania/zatrzymywania. Jest to przydatne w przypadkach, w których nie można bezpośrednio użyć śledzenia (np. gdy czas trwania został przechwycony przed wczytaniem pakietu Performance SDK).
removeAttribute(attr). Usuwa określony atrybut niestandardowy z instancji śledzenia.
start(), Uruchamia czas dla instancji śledzenia.
stop(), Zatrzymuje czas instancji śledzenia i rejestruje dane instancji.

PerformanceTrace.getAttribute()

Pobiera wartość ustawioną dla atrybutu niestandardowego.

Podpis:

getAttribute(attr: string): string | undefined;

Parametry

Parametr Typ Opis
attr ciąg znaków Nazwa atrybutu niestandardowego.

Zwroty:

ciąg znaków | nie zdefiniowano

PerformanceTrace.getAttributes()

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

Podpis:

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

Zwroty:

{ [klucz: ciąg znaków]: ciąg znaków;

PerformanceTrace.getMetric()

Zwraca wartość danych niestandardowych o tej nazwie. Jeśli dane niestandardowe o takiej nazwie nie istnieją, zwracają zero.

Podpis:

getMetric(metricName: string): number;

Parametry

Parametr Typ Opis
nazwadanych ciąg znaków Nazwa danych niestandardowych.

Zwroty:

liczba

PerformanceTrace.incrementMetric()

Dodaje wartość danych niestandardowych. Jeśli dane niestandardowe o podanej nazwie nie istnieją, zostaną utworzone o tej nazwie i o 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
nazwadanych ciąg znaków Nazwa danych niestandardowych.
numer liczba Liczba, która zostanie dodana do wartości danych niestandardowych. Jeśli nie zostanie podana, zostanie użyta domyślna wartość 1.

Zwroty:

nieważne

PerformanceTrace.putAttribute()

Ustaw niestandardowy atrybut logu czasu na określoną wartość.

Podpis:

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

Parametry

Parametr Typ Opis
attr ciąg znaków Nazwa atrybutu niestandardowego.
wartość ciąg znaków Wartość atrybutu niestandardowego.

Zwroty:

nieważne

PerformanceTrace.putMetric()

Ustawia wartość określonych danych niestandardowych na podaną liczbę niezależnie od tego, czy wskaźnik o tej nazwie istnieje już w instancji logu czasu. Wartość zostanie obniżona do liczby całkowitej.

Podpis:

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

Parametry

Parametr Typ Opis
nazwadanych ciąg znaków Nazwa danych niestandardowych.
numer liczba Wartość danych niestandardowych.

Zwroty:

nieważne

PerformanceTrace.record()

Rejestruje log czasu na podstawie podanych parametrów. Zapewnia to bezpośredni sposób korzystania ze śledzenia bez konieczności uruchamiania/zatrzymywania. Jest to przydatne w przypadkach, w których nie można bezpośrednio użyć śledzenia (np. gdy czas trwania został przechwycony przed wczytaniem pakietu Performance SDK).

Podpis:

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

Parametry

Parametr Typ Opis
startTime liczba czas rozpoczęcia śledzenia od początku epoki w milisekach.
czas trwania liczba Czas trwania logu czasu w milisekundach.
opcje { Metryki?: { [key: string]: number; }; ?: { [klucz: ciąg znaków]: ciąg znaków; }; Obiekt, który może opcjonalnie zawierać mapy niestandardowych danych i atrybutów niestandardowych.

Zwroty:

nieważne

PerformanceTrace.removeAttribute()

Usuwa określony atrybut niestandardowy z instancji śledzenia.

Podpis:

removeAttribute(attr: string): void;

Parametry

Parametr Typ Opis
attr ciąg znaków Nazwa atrybutu niestandardowego.

Zwroty:

nieważne

PerformanceTrace.start()

Uruchamia czas dla instancji śledzenia.

Podpis:

start(): void;

Zwroty:

nieważne

PerformanceTrace.stop()

Zatrzymuje czas instancji śledzenia i rejestruje dane instancji.

Podpis:

stop(): void;

Zwroty:

nieważne