PerformanceTrace interface

رابطی که یک Trace را نشان می دهد .

امضا:

export interface PerformanceTrace 

مواد و روش ها

روش شرح
getAttribute(attr) مقداری را که یک ویژگی سفارشی روی آن تنظیم شده است، بازیابی می کند.
getAttributes() نقشه ای از تمام ویژگی های سفارشی یک نمونه ردیابی را برمی گرداند.
getMetric(metricName) مقدار معیار سفارشی را با آن نام برمی‌گرداند. اگر متریک سفارشی با آن نام وجود نداشته باشد، صفر برمی گردد.
incrementMetric (MetricName, num) به ارزش یک متریک سفارشی می افزاید. اگر یک معیار سفارشی با نام ارائه شده وجود نداشته باشد، یکی با آن نام و مقدار برابر با عدد داده شده ایجاد می کند. مقدار به یک عدد صحیح کاهش می یابد.
putAttribute (attr، مقدار) یک ویژگی سفارشی از یک ردیابی را روی یک مقدار مشخص تنظیم کنید.
putMetric (MetricName, num) مقدار متریک سفارشی مشخص شده را بدون توجه به اینکه معیاری با آن نام قبلاً در نمونه ردیابی وجود دارد یا خیر، روی عدد داده شده تنظیم می کند. مقدار به یک عدد صحیح کاهش می یابد.
رکورد (زمان شروع، مدت زمان، گزینه ها) ردیابی را از پارامترهای داده شده ثبت می کند. این یک راه مستقیم برای استفاده از ردیابی بدون نیاز به شروع / توقف فراهم می کند. این برای موارد استفاده که در آن ردیابی نمی تواند مستقیماً استفاده شود مفید است (مثلاً اگر مدت زمان قبل از بارگیری SDK عملکرد ضبط شده باشد).
removeAttribute(attr) ویژگی سفارشی مشخص شده را از یک نمونه ردیابی حذف می کند.
شروع () زمان‌بندی را برای نمونه ردیابی شروع می‌کند.
متوقف کردن() زمان‌بندی نمونه ردیابی را متوقف می‌کند و داده‌های نمونه را ثبت می‌کند.

PerformanceTrace.getAttribute()

مقداری را که یک ویژگی سفارشی روی آن تنظیم شده است، بازیابی می کند.

امضا:

getAttribute(attr: string): string | undefined;

مولفه های

پارامتر تایپ کنید شرح
attr رشته نام ویژگی سفارشی.

برمی گرداند:

رشته | تعریف نشده

PerformanceTrace.getAttributes()

نقشه ای از تمام ویژگی های سفارشی یک نمونه ردیابی را برمی گرداند.

امضا:

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

برمی گرداند:

{ [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;

مولفه های

پارامتر تایپ کنید شرح
زمان شروع عدد ردیابی زمان شروع از دوره در میلی ثانیه.
مدت زمان عدد مدت زمان ردیابی بر حسب میلی ثانیه
گزینه ها { معیارها؟: { [key: string]: number; }; ویژگی ها؟: { [key: string]: string; }; } یک شی که می تواند به صورت اختیاری نقشه های معیارهای سفارشی و ویژگی های سفارشی را در خود نگه دارد.

برمی گرداند:

خالی

PerformanceTrace.removeAttribute()

ویژگی سفارشی مشخص شده را از یک نمونه ردیابی حذف می کند.

امضا:

removeAttribute(attr: string): void;

مولفه های

پارامتر تایپ کنید شرح
attr رشته نام ویژگی سفارشی.

برمی گرداند:

خالی

PerformanceTrace.start()

زمان‌بندی را برای نمونه ردیابی شروع می‌کند.

امضا:

start(): void;

برمی گرداند:

خالی

PerformanceTrace.stop()

زمان‌بندی نمونه ردیابی را متوقف می‌کند و داده‌های نمونه را ثبت می‌کند.

امضا:

stop(): void;

برمی گرداند:

خالی