الواجهة التي تمثِّل Trace
Signature:
export interface PerformanceTrace
الطُرق
الطريقة | الوصف |
---|---|
getAttribute(attr) | لاسترداد القيمة التي تم ضبط السمة المخصّصة عليها. |
getAttributes() | تعرض خريطة لجميع السمات المخصّصة لمثيل تتبُّع. |
getMetric(metricName) | تعرض قيمة المقياس المخصّص بهذا الاسم. في حال عدم توفّر مقياس مخصَّص بهذا الاسم، لن يكون الناتج صفرًا. |
incrementMetric(metricName, num) | يضيف هذا الحقل إلى قيمة المقياس المخصّص. إذا لم يتوفّر مقياس مخصَّص بالاسم المقدَّم، يتم إنشاء مقياس بهذا الاسم وقيمة مساوية للرقم المحدّد. وسيتم خفض القيمة إلى عدد صحيح. |
putAttribute(attr, value) | يمكنك ضبط السمة المخصّصة للتتبُّع على قيمة معيّنة. |
putMetric(metricName, num) | يتم ضبط قيمة المقياس المخصّص المحدَّد على رقم معيّن بغض النظر عمّا إذا كان هناك مقياس يحمل هذا الاسم حاليًا في مثيل التتبُّع أم لا. وسيتم خفض القيمة إلى عدد صحيح. |
record(startTime, duration, options) | يتم تسجيل عملية التتبّع من خلال معلَمات معيّنة. يوفّر ذلك طريقة مباشرة لاستخدام بيانات التتبُّع بدون الحاجة إلى البدء أو الإيقاف. ويكون ذلك مفيدًا في حالات الاستخدام التي لا يمكن فيها استخدام بيانات التتبُّع مباشرةً (على سبيل المثال، إذا تم تسجيل المدة قبل تحميل حزمة تطوير البرامج (SDK) للأداء). |
removeAttribute(attr) | إزالة السمة المخصّصة المحدّدة من مثيل التتبُّع. |
start() | لبدء توقيت مثيل التتبُّع. |
stop() | لإيقاف توقيت مثيل التتبُّع وتسجيل بيانات المثيل. |
PerformanceTrace.getAttribute()
لاسترداد القيمة التي تم ضبط السمة المخصّصة عليها.
Signature:
getAttribute(attr: string): string | undefined;
المَعلمات
المعلمة | النوع | الوصف |
---|---|---|
attr | السلسلة | اسم السمة المخصّصة |
المرتجعات:
سلسلة | غير محدّدة
PerformanceTrace.getAttributes()
تعرض خريطة لجميع السمات المخصّصة لمثيل تتبُّع.
Signature:
getAttributes(): {
[key: string]: string;
};
المرتجعات:
{ [key: string]: string; }
PerformanceTrace.getMetric()
تعرض قيمة المقياس المخصّص بهذا الاسم. في حال عدم توفّر مقياس مخصَّص بهذا الاسم، لن يكون الناتج صفرًا.
Signature:
getMetric(metricName: string): number;
المَعلمات
المعلمة | النوع | الوصف |
---|---|---|
اسم المقياس | السلسلة | اسم المقياس المخصّص |
المرتجعات:
رقم
PerformanceTrace.incrementMetric()
يضيف هذا الحقل إلى قيمة المقياس المخصّص. إذا لم يتوفّر مقياس مخصَّص بالاسم المقدَّم، يتم إنشاء مقياس بهذا الاسم وقيمة مساوية للرقم المحدّد. وسيتم خفض القيمة إلى عدد صحيح.
Signature:
incrementMetric(metricName: string, num?: number): void;
المَعلمات
المعلمة | النوع | الوصف |
---|---|---|
اسم المقياس | السلسلة | اسم المقياس المخصّص. |
الرقم | رقم | الرقم الذي ستتم إضافته إلى قيمة المقياس المخصّص. وإذا لم يتم توفيرها، يتم استخدام القيمة التلقائية وهي واحد. |
المرتجعات:
فراغ
PerformanceTrace.putAttribute()
يمكنك ضبط السمة المخصّصة للتتبُّع على قيمة معيّنة.
Signature:
putAttribute(attr: string, value: string): void;
المَعلمات
المعلمة | النوع | الوصف |
---|---|---|
attr | السلسلة | اسم السمة المخصّصة |
القيمة | السلسلة | قيمة السمة المخصّصة |
المرتجعات:
فراغ
PerformanceTrace.putMetric()
يتم ضبط قيمة المقياس المخصّص المحدَّد على رقم محدَّد بغض النظر عمّا إذا كان هناك مقياس يحمل هذا الاسم حاليًا في مثيل التتبُّع أم لا. وسيتم خفض القيمة إلى عدد صحيح.
Signature:
putMetric(metricName: string, num: number): void;
المَعلمات
المعلمة | النوع | الوصف |
---|---|---|
اسم المقياس | السلسلة | اسم المقياس المخصّص |
الرقم | رقم | القيمة إلى للمقياس المخصّص. |
المرتجعات:
فراغ
PerformanceTrace.record()
يتم تسجيل عملية التتبّع من خلال مَعلمات محدَّدة. يوفّر ذلك طريقة مباشرة لاستخدام بيانات التتبُّع بدون الحاجة إلى البدء أو الإيقاف. ويكون ذلك مفيدًا في حالات الاستخدام التي لا يمكن فيها استخدام بيانات التتبُّع مباشرةً (على سبيل المثال، إذا تم تسجيل المدة قبل تحميل حزمة تطوير البرامج (SDK) للأداء).
Signature:
record(startTime: number, duration: number, options?: {
metrics?: {
[key: string]: number;
};
attributes?: {
[key: string]: string;
};
}): void;
المَعلمات
المعلمة | النوع | الوصف |
---|---|---|
startTime | رقم | تتبع وقت بدء الفترة منذ البداية بالمللي ثانية. |
المدة | رقم | مدة آثار الأنشطة بالمللي ثانية. |
خيارات | { المقاييس?: { [key: string]: number; }; ؟: { [key: string]: string; }; } | كائن يمكن أن يحتوي بشكل اختياري على خرائط للمقاييس المخصّصة والسمات المخصّصة. |
المرتجعات:
فراغ
PerformanceTrace.removeAttribute()
إزالة السمة المخصّصة المحدّدة من مثيل التتبُّع.
Signature:
removeAttribute(attr: string): void;
المَعلمات
المعلمة | النوع | الوصف |
---|---|---|
attr | السلسلة | اسم السمة المخصّصة |
المرتجعات:
فراغ
PerformanceTrace.start()
لبدء توقيت مثيل التتبُّع.
Signature:
start(): void;
المرتجعات:
فراغ
PerformanceTrace.stop()
لإيقاف توقيت مثيل التتبُّع وتسجيل بيانات المثيل.
Signature:
stop(): void;
المرتجعات:
فراغ