أنواع مفاتيح المشروع
ينتمي كل مفتاح مشروع إلى مشروع واحد. ويحدد نوعه ما يستطيع فعله. اختر النوع بالخيار--kind عند تشغيل logbrew projects keys create.
الأنواع
sdk وserver وcli وbrowser مفاتيح استيعاب. اختر النوع الذي
يدل على مكان تشغيل المفتاح. استخدم browser للشيفرة التي تعمل في المتصفح. لا
تضع مفتاح القراءة أبدًا في شيفرة المتصفح أو تطبيق الهاتف المحمول أو حزمة عامة.
وصول الحساب أمر مختلف. يمنح logbrew login أداة CLI وصول حسابك. لا تستخدم وصول
الحساب أبدًا في إعدادات الـ SDK. ولا يستطيع مفتاح القراءة تسجيل الدخول إلى CLI
أو لوحة التحكم.
اقرأ الحدث التجريبي
1
أنشئ مفتاح قراءة
تحتاج إلى وصول الحساب في هذه الخطوة. شغّل يكتب CLI المفتاح في ملف جديد لا يقرؤه إلا مالكه. ولا يطبع المفتاح أو مسار
الملف أبدًا.
logbrew status --json وتأكد من
أنه يُبلغ عن وصول مصادَق عليه إلى الحساب.--ingest-key-file هو خيار الملف لكل أنواع المفاتيح. ويجب ألا
يكون ملف الوجهة موجودًا.نقطة تحقق: تحتوي النتيجة على status: "created" وingest_key.kind: "read".
دوّن ingest_key.id، فستحتاج إليه لإبطال المفتاح.2
أرسل حدثًا تجريبيًا
أرسل سجلًا تجريبيًا آمنًا واحدًا من تطبيقك بمفتاح استيعاب المشروع. اتبع خطوات
بيئة التشغيل الخاصة بك في البدء السريع أو
إرشادات دمج SDK. لاختبار المشكلات أيضًا، أرسل
خطأً تجريبيًا معالَجًا واحدًا.نقطة تحقق: يُبلغ الـ SDK عن حالة
2xx. وهذا يعني أن LogBrew قبِل الطلب.
انتقل إلى الخطوة التالية.3
اقرأ الحدث
حمّل مفتاح القراءة في تعيد كل قراءة بيانات مشروع المفتاح فقط، لذلك لا تحتاج إلى
LOGBREW_TOKEN لجلسة الطرفية هذه فقط. ثم اقرأ المشروع:--project. أضف
--service أو --environment أو --release لمطابقة الحدث التجريبي.نقطة تحقق: يظهر السجل التجريبي مع الخدمة والبيئة والإصدار. ويظهر الخطأ
التجريبي على شكل مشكلة. وهذا يعني أن LogBrew خزّن الأحداث وأنك تستطيع قراءتها.عند الانتهاء، شغّل unset LOGBREW_TOKEN. سيعود CLI بعدها إلى استخدام وصول
حسابك.4
أبطل مفتاح القراءة
أبطل المفتاح عندما لا تعود بحاجة إليه. تحتاج هذه الخطوة إلى وصول الحساب، لذلك
ألغِ تعيين نقطة تحقق: تحتوي النتيجة على
LOGBREW_TOKEN أولًا.status: "revoked". ويتوقف المفتاح عن العمل
عند طلبه التالي.امنح مهمة CI أو وكيلًا وصول القراءة
خصّص مفتاح قراءة لمهمة CI أو وكيل برمجة يقرأ مشروعًا واحدًا. خزّن المفتاح في مخزن الأسرار الخاص بنظام CI أو بيئة الوكيل. واجعله متاحًا باسمLOGBREW_TOKEN.
لا تضع المفتاح في موجّه أو مستودع أو مخرجات أمر.
بعد ذلك، يمكن للمهمة أو الوكيل تشغيل قراءات مثل logbrew issues --json
وlogbrew issue "<issue_id>" --json وlogbrew read trace "<trace_id>". أما
أوامر المشروع والمفاتيح والحساب فتحتاج إلى وصول الحساب. يرسل عملاء API المفتاح
كرمز Bearer إلى قراءات بيانات القياس في Telemetry API.
استخدم مفتاحًا واحدًا لكل مهمة أو وكيل. عندها يمكنك إبطال مفتاح واحد دون التأثير
في المفاتيح الأخرى.
تعافَ من قراءة فاشلة
إذا ظلت بيانات القياس مفقودة، فاستخدم
فحوص أول بيانات قياس.
لاستبدال مفتاح استيعاب، راجع تدوير مفتاح الاستيعاب.
