استخدم
--json في سير عمل الوكلاء. احفظ بيانات الاعتماد في إعدادات محلية محمية.
ولا تمرّر بين الأشخاص والأدوات والوكلاء إلا أسماء المتغيرات.قبل أن تبدأ
جهّز ما يلي:- Node.js 18 أو أحدث.
- LogBrew CLI بالنسخة v0.1.30 أو أحدث.
jq.- Bash أو Zsh.
- مجلد حزمة لتطبيق Node.js يعمل على جهة الخادم.
quickstart-node، والبيئة development، والإصدار
quickstart@1. أبقِ هذا الاختبار منفصلًا عن بيئة الإنتاج. لبيئة تشغيل أخرى، استخدم
إرشادات دمج SDK.
إرسال أول سجل وقراءته
1
قراءة حالة الحساب
ثبّت CLI بالأمر الموجود في إرشادات استخدام CLI. ثم اقرأ حالة
الحساب فيها.نقطة تحقق: تُبلغ الحالة عن وصول مصادَق عليه إلى الحساب. إذا لم يحدث ذلك،
يشغّل شخص
logbrew login مرة واحدة. ثم شغّل logbrew status --json مرة
أخرى. يجب ألا يبدأ الوكيل تسجيل دخول جديدًا عندما تعمل المصادقة الحالية.2
إنشاء مشروع واحد من CLI
اختر ملفًا جديدًا في مجلد لا يصل إليه إلا مالكه. يكتب CLI مفتاح استيعاب
المشروع في هذا الملف قبل أن يُبلغ عن النجاح. ولا يطبع المفتاح أو مسار ملفه
أبدًا.إنشاء المشروع يغيّر حالة الحساب. يجب ألا يكون الملف الوجهة موجودًا. إذا لم
تكن النتيجة واضحة، فشغّل الأمر نفسه تمامًا مرة أخرى. يعيد CLI استخدام هوية
الطلب المعلّق. استخدم
--abandon-retry فقط لبدء محاولة مختلفة.نقطة تحقق: تُبلغ المخرجات عن status: "created"، وحالة إعداد
created، ونوع مفتاح الاستيعاب. المشروع موجود والمفتاح محفوظ. لكن هذا لا
يثبت تسليم بيانات القياس عن بُعد. راجع
المشاريع.3
تثبيت Node.js SDK
4
إرسال سجل SDK آمن واحد
أرسل علامتَي الإصدار والبيئة مع سجل لا تضع في الحدث بيانات اعتماد أو ترويسات أو نصوص طلبات أو بيانات عملاء أو
مسارات محلية.نقطة تحقق: يطبع البرنامج النصي
info واحد لا يحتوي إلا على قيم نائبة.
يُضبط المفتاح لعملية Node.js هذه فقط. وتوضع هوية التطبيق في context.كل تشغيل ينشئ معرّفات أحداث جديدة. إذا أعاد الـ SDK محاولة التسليم في التشغيل
نفسه، فإنه يرسل نص الطلب نفسه بالمعرّفات نفسها. ولا يخزّن LogBrew الحدث المقبول
مرة ثانية عندما تعيد محاولةٌ إرساله."ok":true مع status_code من فئة
2xx. وتكون قيمة attempts أكبر من 1 بعد إعادة المحاولة. الإرسال الناجح
ليس آخر فحص.إذا فشل التسليم، يخرج البرنامج النصي بالرمز 1 ويطبع خطأ JSON قصيرًا، مثل
{"ok":false,"error":"unauthenticated"}. ولا يطبع نص الطلب أو المفتاح.
مفتاح المشروع المرفوض يسبب unauthenticated. وتسجيل الدخول الجديد في CLI لا
يحل ذلك.5
قراءة تقرير تشخيص المشروع (doctor)
يستخدم CLI وصوله المحفوظ إلى الحساب في هذه القراءة. لا تستخدم مفتاح استيعاب
المشروع.نقطة تحقق: يحتوي التقرير على
status: "ready". واقرأ أيضًا كل عنصر في
checks. رمز الخروج 0 لا يثبت أن كل الفحوص نجحت. لأي حالة أخرى، اتبع
next ومرجع تقرير التشخيص.
والمشروع الذي حالته ready لا يثبت أن هذا السجل التجريبي وصل.6
قراءة السجل التجريبي
استخدم المشروع والإصدار والبيئة من دفعة الـ SDK.نقطة تحقق: يظهر
LogBrew quickstart check لهذا المشروع والإصدار
والبيئة. وهذا يثبت تسليم السجل التجريبي فقط.قراءة نتيجة الاختبار
يرسل المثال ثلاثة أحداث، واحد منها فقط سجل. وتعطي علامتا الإصدار والبيئة السياق للسجل.
أبقِ الاختبار بمستوى
info. لا تغيّره إلى error ليسهل العثور عليه. استخدم
بدلًا من ذلك عوامل تصفية المشروع والوقت. راجع
قيم الخطورة.
يطبع السطر console.log نتيجة التسليم في الطرفية. ويرسل الاستدعاء client.log
السجل إلى LogBrew. يطبع التسليم الأول الناجح ما يلي:
--project
في CLI الأحداث.
ليس لهذا السجل سياق تتبّع، لأن المثال لا ينشئ Span طلب. وهذا لا يعني أن السجل
فشل. قراءة CLI لقطة لحظية. شغّلها مرة أخرى لقراءة الأحداث اللاحقة، أو استخدم
logbrew watch logs --json لبث مباشر.
قرارات التعافي الشائعة
إذا ظلت بيانات القياس مفقودة، فاستخدم
فحوص أول بيانات قياس.
إذا لم تساعد هذه الفحوص، فأبلغ عن مشكلة.
لا ترفق بيانات اعتماد أو بيانات قياس خامًا أو بيانات عملاء أو مسارات محلية أو
شيفرة مصدرية.
الانتقال إلى تطبيقك
- أنشئ العميل مرة واحدة في شيفرة إعداد تطبيقك.
- حدّد نسخ الـ SDK بدقة في ملفات الحزم. واختبر الترقيات خارج بيئة الإنتاج.
- حمّل مفتاح الاستيعاب من إعدادات الأسرار الحالية لديك. دوّر المفتاح بعد أي كشف محتمل. راجع تدوير مفتاح الاستيعاب.
- استخدم أسماء ثابتة للخدمة والبيئة والإصدار من إعدادات النشر. راجع الإصدارات.
- اكتب رسائل سجل تذكر العملية ونتيجتها، مثل
Report generation completed. أبقِ القيم الخاصة خارج الرسالة. ولا تنسخ طلبًا كاملًا أو قيد مستخدم كاملًا في سجل. - اجعل لكل سجل في التطبيق مُرسِلًا واحدًا لتجنب القيود المكررة. حدّد عملية الدمج التي ترسل كل قيد حاليًا قبل أن تضيف LogBrew.
- قبل الطرح في بيئة الإنتاج، أرسل حدثًا آمنًا واحدًا عبر مسار الشيفرة الحقيقي واقرأه مرة أخرى. تحقق من رسالته وخدمته وإصداره وبيئته. المثال المستقل لا يختبر مسار الشيفرة في تطبيقك.
المشاريع
اقرأ حالة الإعداد، وأدِر مفاتيح استيعاب المشروع.
دمج SDK
اختر حزمة SDK المناسبة لبيئة التشغيل لديك.
التحقيق في مشكلة
اتبع أدلة التتبّع والسجلات المرتبطة لمشكلة واحدة.
الإبلاغ عن مشكلة
أرسل بلاغ دعم آمنًا وخاصًا.
