الانتقال إلى المحتوى الرئيسي
تقرأ واجهة سطر الأوامر (CLI) في LogBrew السجلات والمشكلات والتتبّعات والإجراءات من الطرفية. ويمكنها أيضًا تحديث حالة المشكلة. استخدم --json للحصول على مخرجات منظّمة تناسب البرامج النصية ووكلاء الذكاء الاصطناعي. استبدل كل عنصر نائب بين قوسين زاويين قبل أن تشغّل أي أمر. استخدم معرّفات المشاريع والمشكلات والتتبّعات التي أرجعها LogBrew.

تثبيت CLI

اختر طريقة تثبيت واحدة. macOS أو Linux:
Windows (PowerShell):
Homebrew:
npm:
Cargo:
على Windows، يمكنك أيضًا تثبيت ملف MSI من أحدث إصدار.
يحتاج Cargo إلى Rust 1.87 أو أحدث. أما الطرق الأخرى فتثبّت ملفًا تنفيذيًا أصليًا ولا تحتاج إلى Rust.

تحديث CLI

لا يحدّث CLI نفسه تلقائيًا. استخدم الطريقة نفسها التي ثبّتها بها. Homebrew:
npm:
Cargo:
إذا ثبّتها بمثبّت الصدفة (shell) أو PowerShell، فشغّل المثبّت مرة أخرى. ثم اقرأ رقم النسخة، وقارنه مع أحدث إصدار:
يعرض JSON الحقول ok وname وversion وbinary وos وarch.

تسجيل الدخول والتحقق من الجلسة

اقرأ الحساب المستخدم في الطرفية الحالية:
إذا أظهر whoami الحساب المتوقع، فتابع. وإلا، فسجّل الدخول. يُكمل شخص تسجيل الدخول لدى المزوّد في المتصفح. ويجب على وكيل البرمجة أن يطلب من شخص تنفيذ هذه الخطوة.
المزوّد هو github (الافتراضي) أو gitlab أو bitbucket أو google. على جهاز لا يمكنه فتح متصفح، مثل جلسة SSH أو حاوية أو مهمة CI، استخدم تسجيل الدخول عبر جهاز آخر:
يطبع CLI رابطًا ورمزًا قصيرًا. افتح الرابط على أي جهاز، مثل هاتفك أو حاسوبك المحمول. تأكد من أن الصفحة تعرض الرمز نفسه، ثم وافق. ينتظر CLI مدة تصل إلى 10 دقائق. وإذا تعذّر فتح متصفح، يستخدم CLI تسجيل الدخول عبر جهاز آخر تلقائيًا. ويعمل --no-open مثل --device. مع --json، يطبع CLI الرابط والرمز في سطر JSON واحد، ثم يطبع النتيجة في سطر JSON ثانٍ. ويمكن لوكيل البرمجة أن يعطي الرابط والرمز لشخص ثم ينتظر. بعد تسجيل الدخول، شغّل status وwhoami مرة أخرى. لا تضع بيانات اعتماد الحساب في موجّه (prompt) أو تقرير أو ملف مصدري.

إعداد مشروع

انتقل إلى المجلد الذي يحتوي على ملف الحزمة أو ملف البناء الخاص بالتطبيق. في المستودع الموحّد (monorepo)، اختر تطبيقًا واحدًا أو خدمة واحدة. ثم شغّل:
يختار أمر الإعداد مشروعًا أو ينشئه، ويثبّت SDK، ويكتب مفتاح الاستيعاب في ملف env، ويضيف شيفرة التهيئة. ويعرض كل تغيير في الملفات ويطلب منك التأكيد. ثم يرسل حدثًا تجريبيًا يقرؤه LogBrew. راجع الإعداد بأمر واحد. تضيف الوكلاء والسكربتات --yes --json. وتضيف هذه الخيارات خطوات أخرى:

التخطيط لإعداد SDK

لقراءة خطة الإعداد دون أي تغيير، شغّل:
اقرأ detected وinstall_ready وinstall_plan وnext. تحدد الخطة بيئة التشغيل وإطار العمل ومدير الحزم وأمر التثبيت. لا يثبّت CLI أي حزم ولا يغيّر أي ملفات. وتعطي الأوامر logbrew init وinstall وconfigure وsdk الخطة نفسها.
ضع مفتاح استيعاب المشروع في إعدادات الـ SDK. لا تستخدم أبدًا بيانات اعتماد الحساب مفتاحًا للـ SDK. وأبقِ مفاتيح الاستيعاب خارج نظام إدارة الشيفرة المصدرية.
راجع دمج SDK لمعرفة الخطوات الخاصة بكل بيئة تشغيل. شغّل logbrew examples لعرض قائمة قصيرة بالأوامر الشائعة.

قراءة المشاريع وإنشاؤها وإعدادها

اعرض المشاريع النشطة في حسابك:
اختر معرّف مشروع من النتيجة، واستخدمه للمفاتيح والقراءات. لإنشاء مفتاح استيعاب لمشروع موجود، اختر ملفًا جديدًا خارج نظام إدارة الشيفرة المصدرية. يكتب CLI المفتاح في هذا الملف الذي لا يقرؤه إلا مالكه. ولا يطبع المفتاح أو مسار الملف.
تحتوي نتيجة JSON على status وproject_id وingest_key وchecks وnext. ويحتوي ingest_key على id وlabel وkind وcreated_at وexpires_at الخاصة بالمفتاح. لاستبدال مفتاح، راجع تدوير مفتاح الاستيعاب. لإبطال مفتاح، استخدم قيمة id الخاصة به من تلك النتيجة:
يتوقف المفتاح عن العمل عند طلبه التالي. ينشئ هذا الأمر بيانات اعتماد. قبل أن تشغّله، تأكد من أن المشروع صحيح. إذا لم تكن النتيجة مؤكدة، فشغّل الأمر نفسه مرة أخرى. سيعيد CLI حينها استخدام المحاولة المعلّقة. استخدم --abandon-retry فقط لبدء محاولة جديدة. لإنشاء مشروع جديد، اتبع البدء السريع. يستخدم logbrew projects create "<name>" --ingest-key-file "<private_key_file>"، الذي يخزّن المفتاح الأول بالطريقة نفسها. شغّل logbrew setup --create-project لقراءة تعليمات إنشاء المشروع. هذا الأمر لا ينشئ مشروعًا. بعد أي خطوة إعداد، يمكنك تسجيلها للمشروع. قيمة --source هي api أو cli أو sdk:
ثم اقرأ جاهزية المشروع:
رمز الخروج 0 لا يعني أن كل الفحوص نجحت. اقرأ status في التقرير وكل فحص على حدة. راجع مرجع تقرير التشخيص.

قراءة استخدام الحساب

اقرأ الاستخدام والحدود. هذا لا يغيّر حالة الحساب أو الفوترة.
يعطي logbrew account usage --json النتيجة نفسها. تعرض الاستجابة الخطة، وحالة الحصة، وتاريخ إعادة التعيين، وإجمالي الاستخدام حسب المشروع وحسب نوع بيانات القياس، والخطوة التالية. تشمل الحقول plan وstate وreset_at وby_project وby_stream وnext.

تحقيقات شائعة

صفِّ كل قراءة حسب المشروع. أضف عوامل تصفية الإصدار أو البيئة أو الوقت أو الخطورة عندما يدعمها الأمر. راجع عوامل التصفية.

المشكلات في إصدار معيّن

طلب واحد فاشل

سجلات إصدار معيّن

المشكلات المُسندة إليك

مشاهدة الأحداث المباشرة

استخدم watch لرؤية الأحداث الجديدة أثناء اختبار تغيير ما. اضغط Ctrl+C للإيقاف.
يبث watch مخرجات JSON فقط. ومن دون --json، يتوقف الأمر مع خطأ. أضف logs أو issues أو actions لمشاهدة نوع واحد، مثل logbrew watch logs --json. لا يدعم watch التتبّعات أو الـ Spans. لا يحتوي watch على عامل تصفية للمشروع أو الإصدار أو البيئة. لمشروع واحد، استخدم القراءات السابقة. راجع المتابعة المباشرة لمعرفة الموارد وعوامل التصفية المدعومة.

افهم المشكلة قبل تغيير الشيفرة

اقرأ السياق قبل أن تقترح إصلاحًا.
1

قراءة المشكلة

2

قراءة التتبّع

نفّذ هذه الخطوة فقط إذا كان للمشكلة معرّف تتبّع. المشكلة التي ليس لها تتبّع تظل صالحة.
3

قراءة الشرح

للسجل، استخدم logbrew explain log "<log_id>" --json. وللإجراء، استخدم logbrew explain action "<action_id>" --json.
4

الحلّ بعد التحقق

لتغيير الحالة أو الأولوية أو المسؤول لعدد كبير من المشكلات، راجع تغيير حالة المشكلة وأولويتها وإدارة المشكلات.

مخرجات JSON

  • ضع --json قبل الأمر أو بعده، مثل logbrew --json status أو logbrew status --json.
  • اقرأ رمز الخروج قبل أن تستخدم المخرجات.
  • تحتوي أخطاء JSON على ok وerror وmessage وnext. انتهاء المهلة لا يثبت أن عملية الكتابة فشلت. قبل أن تكرر عملية كتابة، اقرأ قواعد إعادة المحاولة الخاصة بها.
  • لا تعتمد في الأتمتة على مخرجات من دون --json، فقد تتغير.
راجع قراءة النتائج والأخطاء لمعرفة رموز الخروج وأمثلة الأخطاء.