PerformanceTrace interface

הממשק המייצג Trace .

חֲתִימָה:

export interface PerformanceTrace

שיטות

שיטה תיאור
getAttribute(attr) מאחזר את הערך שאליו מוגדרת תכונה מותאמת אישית.
getAttributes() מחזירה מפה של כל התכונות המותאמות אישית של מופע מעקב.
getMetric(metricName) מחזירה את הערך של המדד המותאם אישית בשם זה. אם מדד מותאם אישית בשם זה לא קיים יחזיר אפס.
incrementMetric(metricName, num) מוסיף לערך של מדד מותאם אישית. אם מדד מותאם אישית עם השם שסופק לא קיים, הוא יוצר אחד עם השם הזה והערך שווה למספר הנתון. הערך יורד למספר שלם.
putAttribute(attr, value) הגדר תכונה מותאמת אישית של מעקב לערך מסוים.
putMetric(metricName, num) מגדיר את הערך של המדד המותאם אישית שצוין למספר הנתון ללא קשר אם ערך בשם זה כבר קיים במופע המעקב או לא. הערך יורד למספר שלם.
שיא (זמן התחלה, משך, אפשרויות) רושם מעקב מפרמטרים נתונים. זה מספק דרך ישירה להשתמש ב-Trace ללא צורך להתחיל/לעצור. זה שימושי עבור מקרי שימוש שבהם לא ניתן להשתמש ישירות במעקב (למשל אם משך הזמן נקלט לפני טעינת ה-SDK של הביצועים).
removeAttribute(attr) מסיר את התכונה המותאמת אישית שצוינה ממופע מעקב.
הַתחָלָה() מתחיל את התזמון עבור מופע המעקב.
תפסיק() עוצר את התזמון של מופע המעקב ומתעד את הנתונים של המופע.

PerformanceTrace.getAttribute()

מאחזר את הערך שאליו מוגדרת תכונה מותאמת אישית.

חֲתִימָה:

getAttribute(attr: string): string | undefined;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
attr חוּט שם המאפיין המותאם אישית.

החזרות:

מחרוזת | לא מוגדר

PerformanceTrace.getAttributes()

מחזירה מפה של כל התכונות המותאמות אישית של מופע מעקב.

חֲתִימָה:

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

החזרות:

{ [מפתח: מחרוזת]: מחרוזת; }

PerformanceTrace.getMetric()

מחזירה את הערך של המדד המותאם אישית בשם זה. אם מדד מותאם אישית בשם זה לא קיים יחזיר אפס.

חֲתִימָה:

getMetric(metricName: string): number;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
metricName חוּט שם המדד המותאם אישית.

החזרות:

מספר

PerformanceTrace.incrementMetric()

מוסיף לערך של מדד מותאם אישית. אם מדד מותאם אישית עם השם שסופק לא קיים, הוא יוצר אחד עם השם הזה והערך שווה למספר הנתון. הערך יורד למספר שלם.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
metricName חוּט שם המדד המותאם אישית.
מספר מספר המספר שיש להוסיף לערך של המדד המותאם אישית. אם לא מסופק, הוא משתמש בערך ברירת מחדל של אחד.

החזרות:

בָּטֵל

PerformanceTrace.putAttribute()

הגדר תכונה מותאמת אישית של מעקב לערך מסוים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
attr חוּט שם המאפיין המותאם אישית.
ערך חוּט ערך המאפיין המותאם אישית.

החזרות:

בָּטֵל

PerformanceTrace.putMetric()

מגדיר את הערך של המדד המותאם אישית שצוין למספר הנתון ללא קשר אם ערך בשם זה כבר קיים במופע המעקב או לא. הערך יורד למספר שלם.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
metricName חוּט שם המדד המותאם אישית.
מספר מספר הערך של המדד המותאם אישית.

החזרות:

בָּטֵל

PerformanceTrace.record()

רושם עקבות מפרמטרים נתונים. זה מספק דרך ישירה להשתמש במעקב ללא צורך בהתחלה/עצירה. זה שימושי למקרי שימוש שבהם לא ניתן להשתמש ישירות במעקב (למשל אם משך הזמן נקלט לפני טעינת ה-SDK של הביצועים).

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שעת התחלה מספר מעקב אחר זמן ההתחלה מאז התקופה באלפיות שניות.
מֶשֶׁך מספר משך העקיבה באלפיות שניות.
אפשרויות { metrics?: { [מפתח: מחרוזת]: מספר; }; attributes?: { [מפתח: מחרוזת]: מחרוזת; }; } אובייקט שיכול להחזיק מפות של מדדים מותאמים אישית ותכונות מותאמות אישית.

החזרות:

בָּטֵל

PerformanceTrace.removeAttribute()

מסיר את התכונה המותאמת אישית שצוינה ממופע מעקב.

חֲתִימָה:

removeAttribute(attr: string): void;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
attr חוּט שם המאפיין המותאם אישית.

החזרות:

בָּטֵל

PerformanceTrace.start()

מתחיל את התזמון עבור מופע המעקב.

חֲתִימָה:

start(): void;

החזרות:

בָּטֵל

PerformanceTrace.stop()

עוצר את התזמון של מופע המעקב ומתעד את הנתונים של המופע.

חֲתִימָה:

stop(): void;

החזרות:

בָּטֵל