المشروع والخدمة والبيئة
إعداد مشروع
ثبّت الـ CLI. شغّلlogbrew status --json لقراءة صلاحيات
الوصول في حسابك. إذا لم يكن الوصول صالحًا، يشغّل شخص logbrew login. ولا يمكن
لمفتاح الاستيعاب الخاص بالمشروع أن يسجّل دخولك.
1
أنشئ مشروعًا أو اختره
اعرض مشاريعك أولًا. لا تنشئ مشروعًا إلا إذا لم يكن موجودًا.يكتب الـ CLI مفتاح الاستيعاب في ملف جديد لا يقرؤه إلا مالكه. ولا يطبع المفتاح
ولا مسار الملف أبدًا. إذا لم تكن النتيجة واضحة، فشغّل الأمر نفسه تمامًا مرة
أخرى. لا تغيّر اسم المشروع ولا ملف المفتاح. يعيد الـ CLI استخدام هوية طلبه
المعلّق. وتشرح صفحة البدء السريع طريقة قراءة معرّف المشروع
من النتيجة.لمشروع موجود، احفظ حالة الإعداد:لإنشاء مفتاح استيعاب آخر لمشروع موجود، استخدم
logbrew projects keys create. وتعرض
إرشادات تدوير مفتاح الاستيعاب هذا الأمر.لا يعرض logbrew setup --create-project إلا المساعدة، ولا ينشئ مشروعًا.2
اضبط أسماء الخدمات في الـ SDK
استخدم أسماء من مستودعك وعملية النشر لديك، مثل
api أو worker أو web
أو ios أو checkout-api. اسم الخدمة تسمية، وليس أداة لاختيار المشروع.
مفتاح الاستيعاب هو الذي يختار المشروع. وتغيير اسم الخدمة لا ينقل الأحداث
المخزّنة. إذا لم تجد حدثًا، فتحقّق من المشروع ومفتاح الاستيعاب اللذين
يستخدمهما التطبيق قبل أن تنشئ مشروعًا آخر.3
استخدم بيئات قياسية
استخدم
production وstaging وpreview وlocal. إذا كانت عملية النشر
لديك تستخدم أسماء أخرى، فاستخدمها باتساق. لا يمكن أن يحتوي اسم البيئة على
مسافات أو / أو شرطة مائلة عكسية.4
أرسل حدثًا تجريبيًا واقرأه
اضبط الـ SDK بمفتاح الاستيعاب الخاص بالمشروع، كما تشرح
إرشادات دمج SDK. إنشاء المشروع لا
يثبّت SDK في تطبيقك. أبقِ المفتاح خارج نظام التحكم بالمصدر. اضبط الخدمة
والبيئة والإصدار في التطبيق. أرسل حدثًا آمنًا واحدًا، ثم اقرأه:لكل إشارة قائمتها الخاصة. وقائمة السجلات الفارغة لا تعني أن المشروع لا
يحتوي على مشكلات أو تتبّعات.في لوحة التحكم، اختر المشروع نفسه ونطاقًا زمنيًا يشمل الحدث التجريبي. تأكد
من أن عوامل تصفية الخدمة والبيئة والإصدار تطابق الحدث.
تشخيص إعداد المشروع
اقرأ حالة الإعداد باستخدام أداة تشخيص المشروع (doctor). لا تستنتج حالة الإعداد من الملفات المحلية أو من استعلام سجلات فارغ.status وchecks وnext. ورمز الخروج 0 لا
يعني أن كل الفحوص نجحت. اقرأ كل عنصر في checks. راجع
قراءة تقرير تشخيص المشروع.
استجابة الـ API المباشرة
يستدعي عملاء الـ API المسارGET /api/projects/{project_id}/doctor بمصادقة
الحساب. لا تقبل نقطة النهاية هذه معاملات استعلام ولا نص طلب. لا تستخدم مفتاح
الاستيعاب الخاص بالمشروع لهذه القراءة أبدًا.
تحتوي الاستجابة 200 على هذه المفاتيح: project_id وstate وsetup_status
وsetup_acknowledged وhas_active_ingest_key وfirst_telemetry_seen_at
وlast_seen_at وlast_signal وnext وnext_action. الطوابع الزمنية بصيغة
RFC3339 أو null. وlast_signal ملخص آمن للعرض، وليس إشارة خامًا.
تفحص أداة التشخيص مفتاح الاستيعاب أولًا. المشروع الذي ليس له مفتاح استيعاب نشط
تكون حالته
needs_ingest_key، أيًّا كانت حالة إعداده.
تكون قيمة setup_status إحدى القيم created أو setup_started أو sdk_seen
أو first_telemetry_seen أو active. ولا تكون setup_acknowledged بالقيمة
true إلا مع القيم الثلاث الأخيرة. تعطي created الحالة needs_setup. وتعطي
setup_started وsdk_seen الحالة needs_telemetry. وتعطي
first_telemetry_seen وactive الحالة ready.
إذا استمر فشل القراءة، فأبلغ عن مشكلة. لا تُدرج
بيانات الاعتماد أو الترويسات أو نصوص الإشارات أو بيانات العملاء أو المسارات
المحلية أو الشيفرة المصدرية.
أرشفة مشروع أو حذفه
أرشف المشروع لإزالته من قائمة المشاريع النشطة:--yes. بعد الأرشفة، تتوقف مفاتيح الاستيعاب الخاصة بالمشروع عن
قبول بيانات قياس جديدة. مسار الـ API هو DELETE /api/projects/{project_id}.
ويُرجع 204 دون نص. اعرض المشاريع المؤرشفة باستخدام
GET /api/projects/archived. واستعد مشروعًا باستخدام
POST /api/projects/{project_id}/restore، الذي يُرجع 204 أيضًا.
لا تحذف المشروع نهائيًا إلا عندما تكون متأكدًا:
--confirm. الطلب المقبول يجعل المشروع غير
نشط فورًا ويجدول حذفه النهائي. ولا يمكنك استعادة المشروع بعد ذلك.