seqcli

seqcli

تطبيق سطر أوامر العميل Seq. يدعم التسجيل ( seqcli log )، والبحث ( search )، والتتبع ( tail )، والاستعلام ( query ) وJSON أو استيعاب ملف سجل النص العادي ( ingest )، وغير ذلك الكثير.

ابدء

يتضمن برنامج تثبيت Seq لنظام التشغيل Windows seqcli . بخلاف ذلك، قم بتنزيل الإصدار لنظام التشغيل الخاص بك. أو، إذا كان لديك dotnet مثبتًا، فيمكن تثبيت seqcli كأداة عامة باستخدام:

 dotnet tool install --global seqcli

لتعيين عنوان URL للخادم الافتراضي ومفتاح واجهة برمجة التطبيقات، قم بتشغيل:

 seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key

سيتم تخزين مفتاح API في ملف التكوين SeqCli.json الخاص بك؛ وفي نظام التشغيل Windows، يتم تشفير هذا باستخدام DPAPI؛ في نظام التشغيل Mac/Linux، يتم تخزين المفتاح حاليًا بنص عادي. كبديل لتخزين مفتاح API في التكوين، يمكن تمريره إلى كل أمر عبر وسيطة --apikey= .

seqcli متاح أيضًا كحاوية Docker ضمن datalust/seqcli :

 docker run --rm datalust/seqcli:latest  []

للاتصال بـ Seq في حاوية عامل إرساء على الجهاز المحلي، استخدم عنوان IP الخاص بالجهاز (وليس المضيف المحلي) أو حدد شبكة مضيف عامل الإرساء باستخدام --net host .

استخدم شبكات ووحدات تخزين Docker لجعل الملفات المحلية والحاويات الأخرى قابلة للوصول إلى seqcli داخل الحاوية الخاصة بها.

تجاوزات متغير البيئة

يمكن تجاوز كل قيمة إعداد في وقت التشغيل عن طريق تحديد متغير بيئة من النموذج SEQCLI_ ، حيث يحتوي على عنصر واحد لكل مقطع منقط من اسم الإعداد، مفصولاً بشرطات سفلية.

على سبيل المثال، يمكن تجاوز الإعداد connection.serverUrl باستخدام المتغير SEQCLI_CONNECTION_SERVERURL .

الاتصال بدون مفتاح API

إذا كنت تقوم بأتمتة إعداد Seq، فمن المحتمل ألا يكون لديك مفتاح واجهة برمجة التطبيقات حتى الآن لاستخدام seqcli . أثناء التكوين الأولي لخادم Seq، يمكنك تحديد firstRun.adminUsername و firstRun.adminPasswordHash (أو متغيرات البيئة المكافئة SEQ_FIRSTRUN_ADMINUSERNAME و SEQ_FIRSTRUN_ADMINPASSWORDHASH ) لتعيين اسم مستخدم وكلمة مرور أوليين لحساب المسؤول. يمكنك استخدامها لإنشاء مفتاح API، ثم استخدام الرمز المميز لمفتاح API مع أوامر seqcli المتبقية.

يقبل أمر seqcli apikey create --connect-username و --connect-password-stdin ، ويطبع رمز مفتاح API الجديد إلى STDOUT (يتم استخدام بناء جملة PowerShell أدناه):

 $user = "admin"
$pw = "thepassword"
$token = (
  echo $pw |
  seqcli apikey create `
    -t CLI `
    --permissions="Read,Write,Project,Organization,System" `
    --connect-username $user --connect-password-stdin
)

المساهمة

انظر CONTRIBUTING.md .

الأذونات

عند الاتصال بمفتاح API، يتم تحديد العمليات المسموح بها من خلال الأذونات المعينة لمفتاح API هذا.

لتحديد الإذن المطلوب لأمر ما، تحقق من عمود "طلب الإذن" لعملية واجهة برمجة تطبيقات الخادم المكافئة. على سبيل المثال، يستخدم الأمر apikey create نقطة نهاية POST api/apikeys ، والتي تتطلب إذن Write .

الاستخدام

تتبع جميع أوامر seqcli نفس النمط:

 seqcli  []

مساعدة الأوامر

يمكن عرض القائمة الكاملة للأوامر المدعومة عن طريق تشغيل:

 seqcli help

لإظهار معلومات الاستخدام لأمر معين، قم بتشغيل seqcli help ، على سبيل المثال:

 seqcli help apikey create

يعمل هذا أيضًا مع مجموعات الأوامر؛ لسرد جميع أوامر apikey الفرعية، قم بتشغيل:

 seqcli help apikey

الأوامر المتاحة

• apikey
  • apikey create — إنشاء مفتاح واجهة برمجة التطبيقات (API) للتشغيل الآلي أو الاستيعاب.
  • apikey list — قائمة بمفاتيح واجهة برمجة التطبيقات المتاحة.
  • apikey remove — إزالة مفتاح API من الخادم.
  • apikey update — تحديث مفتاح API موجود.
• app
  • app define - قم بإنشاء تعريف تطبيق للمكون الإضافي .NET [SeqApp] .
  • app install — تثبيت حزمة التطبيق.
  • app list - قائمة حزم التطبيقات المثبتة.
  • app run - استضافة البرنامج الإضافي .NET [SeqApp] .
  • app uninstall — إلغاء تثبيت حزمة التطبيق.
  • app update — تحديث حزمة تطبيق مثبتة.
• appinstance
  • appinstance create — إنشاء مثيل لتطبيق مثبت.
  • appinstance list - قائمة مثيلات التطبيقات المثبتة.
  • appinstance remove — إزالة مثيل التطبيق من الخادم.
  • appinstance update — تحديث مثيل التطبيق الموجود.
• bench - قياس أداء الاستعلام.
• config - عرض وتعيين الحقول في ملف SeqCli.json ؛ تشغيل بدون وسائط لسرد كافة الحقول.
• dashboard
  • dashboard list — قائمة لوحات المعلومات.
  • dashboard remove — إزالة لوحة المعلومات من الخادم.
  • dashboard render - قم بإنشاء مجموعة نتائج بتنسيق CSV أو JSON من مخطط لوحة المعلومات.
• expressionindex
  • expressionindex create — إنشاء فهرس تعبير.
  • expressionindex list - قائمة فهارس التعبير.
  • expressionindex remove — إزالة فهرس التعبير من الخادم.
• feed
  • feed create — إنشاء موجز NuGet.
  • feed list — قائمة خلاصات NuGet.
  • feed remove — إزالة خلاصة NuGet من الخادم.
  • feed update - تحديث خلاصة NuGet الموجودة.
• help - عرض معلومات حول الأوامر المتاحة.
• index
  • index list - قائمة الفهارس.
  • index suppress - قمع الفهرس.
• ingest — إرسال أحداث السجل من ملف أو STDIN .
• license apply — تطبيق ترخيص على خادم Seq.
• log — إرسال حدث سجل منظم إلى الخادم.
• node
  • node demote — بدء خفض رتبة العقدة الرائدة الحالية.
  • node health - تحقق من نقطة النهاية /health الخاصة بعقدة Seq، واطبع رمز حالة HTTP الذي تم إرجاعه، أو "غير قابل للوصول" إذا تعذر الاستعلام عن نقطة النهاية.
  • node list - قائمة العقد في مجموعة Seq.
• print - أحداث مطبوعة بشكل جميل بتنسيق CLEF/JSON، من ملف أو STDIN .
• profile
  • profile create — إنشاء ملف تعريف اتصال أو استبداله.
  • profile list — قائمة ملفات تعريف الاتصال.
  • profile remove — إزالة ملف تعريف الاتصال.
• query - تنفيذ استعلام SQL وتلقي النتائج بتنسيق CSV.
• retention
  • retention create — إنشاء سياسة استبقاء.
  • retention list — قائمة سياسات الاستبقاء.
  • retention remove — إزالة سياسة الاحتفاظ من الخادم.
  • retention update — تحديث سياسة الاحتفاظ الحالية.
• sample
  • sample ingest — تسجيل أحداث العينة في مثيل Seq.
  • sample setup — قم بتكوين مثيل Seq باستخدام نماذج من لوحات المعلومات والإشارات والمستخدمين وما إلى ذلك.
• search - استرداد أحداث السجل التي تطابق عامل تصفية معين.
• setting
  • setting clear — مسح إعداد الخادم القابل للتكوين في وقت التشغيل.
  • setting names — اطبع أسماء جميع الإعدادات المدعومة.
  • setting set — تغيير إعداد الخادم القابل للتكوين في وقت التشغيل.
  • setting show - طباعة القيمة الحالية لإعداد خادم قابل للتكوين في وقت التشغيل.
• signal
  • signal create — إنشاء إشارة.
  • signal import — استيراد الإشارات بتنسيق JSON محدد بسطر جديد.
  • signal list — قائمة الإشارات المتاحة.
  • signal remove — إزالة الإشارة من الخادم.
  • signal update — تحديث إشارة موجودة.
• tail - أحداث سجل الدفق التي تطابق عامل التصفية.
• template
  • template export — تصدير الكيانات إلى ملفات القالب.
  • template import — استيراد الكيانات من ملفات القالب.
• user
  • user create — إنشاء مستخدم.
  • user list — قائمة المستخدمين.
  • user remove — إزالة مستخدم من الخادم.
  • user update - تحديث مستخدم موجود.
• version — اطبع الإصدار الحالي القابل للتنفيذ.
• workspace
  • workspace create — إنشاء مساحة عمل.
  • workspace list — قائمة مساحات العمل المتاحة.
  • workspace remove — إزالة مساحة عمل من الخادم.
  • workspace update — تحديث مساحة عمل موجودة.

apikey create

قم بإنشاء مفتاح API للتشغيل الآلي أو الاستيعاب.

مثال:

 seqcli apikey create -t 'Test API Key' -p Environment=Test

خيار	وصف
-t , --title=VALUE	عنوان لمفتاح API
--token=VALUE	رمز مفتاح API المخصص مسبقًا؛ افتراضيًا، سيتم إنشاء رمز مميز جديد وكتابته في STDOUT
-p , --property=NAME=VALUE	حدد خصائص الاسم/القيمة، على سبيل المثال -p Customer=C123 -p Environment=Production
--filter=VALUE	مرشح لتطبيقه على الأحداث الواردة
--minimum-level=VALUE	الحد الأدنى لمستوى/خطورة الحدث الذي يجب قبوله؛ الافتراضي هو قبول كافة الأحداث
--use-server-timestamps	تجاهل الطوابع الزمنية التي يوفرها العميل واستخدم قيم ساعة الخادم
--permissions=VALUE	قائمة مفصولة بفواصل من الأذونات لتفويض مفتاح API؛ الأذونات الصالحة هي Ingest (افتراضي) و Read و Write و Project و System
--connect-username=VALUE	اسم مستخدم للتواصل معه، وهو مفيد بشكل أساسي عند إعداد مفتاح واجهة برمجة التطبيقات الأول؛ تسمح الخوادم ذات الاشتراك "الفردي" فقط بطلب واحد متزامن مع هذا الخيار
--connect-password=VALUE	عند تحديد connect-username ، كلمة المرور المقابلة
--connect-password-stdin	عند تحديد connect-username ، اقرأ كلمة المرور المقابلة من STDIN
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)

apikey list

قائمة مفاتيح API المتاحة.

مثال:

 seqcli apikey list

خيار	وصف
-t , --title=VALUE	عنوان مفتاح (مفاتيح) واجهة برمجة التطبيقات المطلوب إدراجها
-i , --id=VALUE	معرف مفتاح API واحد لإدراجه
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

apikey remove

قم بإزالة مفتاح API من الخادم.

مثال:

 seqcli apikey remove -t 'Test API Key'

خيار	وصف
-t , --title=VALUE	عنوان مفتاح (مفاتيح) واجهة برمجة التطبيقات المراد إزالتها
-i , --id=VALUE	معرف مفتاح API واحد المراد إزالته
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

apikey update

قم بتحديث مفتاح API موجود.

مثال:

 seqcli apikey update --json '{...}'

خيار	وصف
--json=VALUE	مفتاح API المحدث بتنسيق JSON؛ يمكن إنتاج هذا باستخدام seqcli apikey list --json
--json-stdin	اقرأ مفتاح API المحدث كـ JSON من STDIN
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

app define

قم بإنشاء تعريف تطبيق للمكون الإضافي .NET [SeqApp] .

مثال:

 seqcli app define -d "./bin/Debug/netstandard2.2"

خيار	وصف
-d , --directory=VALUE	الدليل الذي يحتوي على تجميعات .NET Standard؛ الافتراضية إلى الدليل الحالي
--type=VALUE	اسم نوع المكون الإضافي [SeqApp]؛ الإعدادات الافتراضية لمسح التجميعات لنوع واحد مميز بهذه السمة
--indented	قم بتنسيق التعريف على أسطر متعددة مع المسافة البادئة

app install

قم بتثبيت حزمة التطبيق.

مثال:

 seqcli app install --package-id 'Seq.App.JsonArchive'

خيار	وصف
--package-id=VALUE	معرف حزمة التطبيق المراد تثبيته
--version=VALUE	إصدار الحزمة المراد تثبيته؛ الافتراضي هو تثبيت الإصدار الأحدث
--feed-id=VALUE	معرف موجز NuGet لتثبيت الحزمة منه؛ قد يتم حذفه إذا تم تكوين خلاصة واحدة فقط
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)

app list

قائمة حزم التطبيقات المثبتة.

مثال:

 seqcli app list

خيار	وصف
--package-id=VALUE	معرف حزمة التطبيق (التطبيقات) المطلوب إدراجها
-i , --id=VALUE	معرف تطبيق واحد لإدراجه
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

app run

قم باستضافة البرنامج الإضافي .NET [SeqApp] .

مثال:

 seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]

خيار	وصف
-d , --directory=VALUE	الدليل الذي يحتوي على تجميعات .NET Standard؛ الافتراضية إلى الدليل الحالي
--type=VALUE	اسم نوع المكون الإضافي [SeqApp]؛ الإعدادات الافتراضية لمسح التجميعات لنوع واحد مميز بهذه السمة
-p , --property=NAME=VALUE	حدد إعدادات الاسم/القيمة للتطبيق، على سبيل المثال -p [email protected] -p Subject="Alert!"
--storage=VALUE	دليل يمكن تخزين البيانات الخاصة بالتطبيق فيه؛ الافتراضية إلى الدليل الحالي
-s , --server=VALUE	عنوان URL لخادم Seq، المستخدم فقط لتكوين التطبيق (لم يتم إجراء أي اتصال بالخادم)؛ افتراضيًا، سيتم استخدام قيمة connection.serverUrl
--server-instance=VALUE	اسم مثيل خادم Seq، المستخدم فقط لتكوين التطبيق؛ الإعدادات الافتراضية لعدم وجود اسم المثيل
-t , --title=VALUE	عنوان مثيل التطبيق، يُستخدم فقط لتكوين التطبيق؛ الافتراضي هو عنوان العنصر النائب.
--id=VALUE	معرف مثيل التطبيق، يُستخدم فقط لتكوين التطبيق؛ الإعدادات الافتراضية لمعرف العنصر النائب.
--read-env	قراءة تكوين التطبيق وإعداداته من متغيرات البيئة، كما هو محدد في https://docs.datalust.co/docs/seq-apps-in-other-languages؛ يتجاهل جميع الخيارات باستثناء --directory و --type

app uninstall

قم بإلغاء تثبيت حزمة التطبيق.

مثال:

 seqcli app uninstall --package-id 'Seq.App.JsonArchive'

خيار	وصف
--package-id=VALUE	معرف الحزمة لحزمة التطبيق المراد إلغاء تثبيته
-i , --id=VALUE	معرف حزمة تطبيق واحدة المراد إلغاء تثبيتها
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

app update

قم بتحديث حزمة التطبيق المثبتة.

مثال:

 seqcli app update -n 'HTML Email'

خيار	وصف
-i , --id=VALUE	معرف تطبيق واحد مثبت للتحديث
-n ، --name=VALUE	اسم التطبيق المثبت للتحديث
--all	تحديث كافة التطبيقات المثبتة؛ غير متوافق مع -i أو -n
--version=VALUE	إصدار الحزمة المراد التحديث إليه؛ الافتراضي هو التحديث إلى الإصدار الأحدث في الخلاصة المرتبطة
--force	قم بتحديث التطبيق حتى لو كان الإصدار المستهدف مثبتًا بالفعل
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)

appinstance create

إنشاء مثيل لتطبيق مثبت.

مثال:

 seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]

خيار	وصف
-t , --title=VALUE	عنوان لمثيل التطبيق
--app=VALUE	معرف حزمة التطبيق المثبتة لإنشاء مثيل لها
-p , --property=NAME=VALUE	حدد إعدادات الاسم/القيمة للتطبيق، على سبيل المثال -p [email protected] -p Subject="Alert!"
--stream[=VALUE]	دفق الأحداث الواردة إلى مثيل التطبيق هذا أثناء استيعابها؛ يقبل بشكل اختياري تعبير الإشارة الذي يحد من الأحداث التي يجب بثها، على سبيل المثال signal-1,signal-2
--overridable=VALUE	حدد أسماء الإعدادات التي قد يتم تجاوزها من قبل المستخدمين عند استدعاء التطبيق
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)

appinstance list

قائمة مثيلات التطبيقات المثبتة.

مثال:

 seqcli appinstance list

خيار	وصف
-t , --title=VALUE	عنوان مثيل (مثيلات) التطبيق المطلوب إدراجه
-i , --id=VALUE	معرف مثيل تطبيق واحد للقائمة
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

appinstance remove

قم بإزالة مثيل التطبيق من الخادم.

مثال:

 seqcli appinstance remove -t 'Email Ops'

خيار	وصف
-t , --title=VALUE	عنوان مثيل (مثيلات) التطبيق المراد إزالته
-i , --id=VALUE	معرف مثيل تطبيق واحد المراد إزالته
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

appinstance update

قم بتحديث مثيل التطبيق الموجود.

مثال:

 seqcli appinstance update --json '{...}'

خيار	وصف
--json=VALUE	مثيل التطبيق المحدث بتنسيق JSON؛ يمكن إنتاج هذا باستخدام seqcli appinstance list --json
--json-stdin	اقرأ مثيل التطبيق المحدث كـ JSON من STDIN
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

bench

قياس أداء الاستعلام.

خيار	وصف
-r , --runs=VALUE	عدد مرات التنفيذ؛ الافتراضي هو 10
-c , --cases=VALUE	ملف JSON يحتوي على مجموعة الحالات المطلوب تشغيلها. الافتراضي لمجموعة قياسية من الحالات.
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--start=VALUE	تاريخ/وقت ISO 8601 للاستعلام منه
--end=VALUE	تاريخ/وقت ISO 8601 للاستعلام عنه
--reporting-server=VALUE	عنوان خادم Seq لإرسال نتائج البدلاء إليه
--reporting-apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بخادم التقارير
--description=VALUE	وصف اختياري لتشغيل اختبار مقاعد البدلاء
--with-ingestion	هل يجب أن يتضمن المعيار إرسال الأحداث إلى Seq
--with-queries	هل يجب أن يتضمن المعيار الاستعلام عن Seq

config

عرض وتعيين الحقول في ملف SeqCli.json ؛ تشغيل بدون وسائط لسرد كافة الحقول.

خيار	وصف
-k , --key=VALUE	الحقل، على سبيل المثال، connection.serverUrl
-v , --value=VALUE	قيمة الحقل إذا لم يتم تحديده، فسيقوم الأمر بطباعة القيمة الحالية
-c ، --clear	امسح المجال

dashboard list

قائمة لوحات المعلومات.

مثال:

 seqcli dashboard list

خيار	وصف
-t , --title=VALUE	عنوان لوحة (لوحات) المعلومات المطلوب إدراجها
-i , --id=VALUE	معرف لوحة معلومات واحدة لإدراجها
-o ، --owner=VALUE	معرف المستخدم الذي سيتم إدراج لوحات المعلومات له؛ بشكل افتراضي، يتم إدراج لوحات المعلومات المشتركة
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

dashboard remove

قم بإزالة لوحة المعلومات من الخادم.

مثال:

 seqcli dashboard remove -i dashboard-159

خيار	وصف
-t , --title=VALUE	عنوان لوحة (لوحات) المعلومات المراد إزالتها
-i , --id=VALUE	معرف لوحة معلومات واحدة المراد إزالتها
-o ، --owner=VALUE	معرف المستخدم لإزالة لوحات المعلومات الخاصة به؛ بشكل افتراضي، تتم إزالة لوحات المعلومات المشتركة
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

dashboard render

قم بإنتاج مجموعة نتائج CSV أو JSON من مخطط لوحة المعلومات.

مثال:

 seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h

خيار	وصف
-i , --id=VALUE	معرف لوحة معلومات واحدة لعرضها
-c , --chart=VALUE	عنوان المخطط الموجود على لوحة المعلومات المطلوب عرضه
--last=VALUE	المدة التي يجب أن يتم خلالها عرض المخطط، على سبيل المثال 7d ; سيتم محاذاة هذا إلى حدود الفاصل الزمني؛ يجب تحديد إما --last أو --start و- --end
--by=VALUE	الفاصل الزمني للشريحة الزمنية لبيانات المخطط، كمدة، على سبيل المثال، 1h
--start=VALUE	تاريخ/وقت ISO 8601 للاستعلام منه
--end=VALUE	تاريخ/وقت ISO 8601 للاستعلام عنه
--signal=VALUE	تعبير إشارة أو قائمة بمعرفات الإشارة المتقاطعة المراد تطبيقها، على سبيل المثال signal-1,signal-2
--timeout=VALUE	مهلة التنفيذ بالمللي ثانية
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

expressionindex create

إنشاء فهرس التعبير.

مثال:

 seqcli expressionindex create --expression "ServerName"

خيار	وصف
-e , --expression=VALUE	التعبير للفهرس
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)

expressionindex list

قائمة فهارس التعبير.

مثال:

 seqcli expressionindex list

خيار	وصف
-i , --id=VALUE	معرف فهرس تعبير واحد للقائمة
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

expressionindex remove

إزالة فهرس التعبير من الخادم.

مثال:

 seqcli expressionindex -i expressionindex-2529

خيار	وصف
-i , --id=VALUE	معرف فهرس التعبير المطلوب إزالته
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

feed create

قم بإنشاء خلاصة NuGet.

مثال:

 seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin

خيار	وصف
-n ، --name=VALUE	اسم فريد للخلاصة
-l , --location=VALUE	موقع التغذية قد يكون هذا عنوان URL لخلاصة NuGet v2 أو v3، أو مسار نظام ملفات محلي على خادم Seq
-u ، --username=VALUE	يجب أن يتم توفير اسم المستخدم Seq عند الاتصال بالخلاصة، إذا كانت المصادقة مطلوبة
-p , --password=VALUE	كلمة مرور التغذية، إذا كانت المصادقة مطلوبة؛ لاحظ أن --password-stdin أكثر أمانًا
--password-stdin	اقرأ كلمة مرور الخلاصة من STDIN
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)

feed list

قائمة يغذي NuGet.

مثال:

 seqcli feed list

خيار	وصف
-n ، --name=VALUE	اسم الخلاصة المطلوب إدراجها
-i , --id=VALUE	معرف خلاصة واحدة للقائمة
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

feed remove

قم بإزالة موجز NuGet من الخادم.

مثال:

 seqcli feed remove -n CI

خيار	وصف
-n ، --name=VALUE	اسم الخلاصة المطلوب إزالتها
-i , --id=VALUE	معرف خلاصة واحدة المراد إزالتها
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

feed update

قم بتحديث خلاصة NuGet الموجودة.

مثال:

 seqcli feed update --json '{...}'

خيار	وصف
--json=VALUE	خلاصة NuGet المحدثة بتنسيق JSON؛ يمكن إنتاج هذا باستخدام seqcli feed list --json
--json-stdin	اقرأ خلاصة NuGet المحدثة بتنسيق JSON من STDIN
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

help

عرض معلومات حول الأوامر المتاحة.

مثال:

 seqcli help search

خيار	وصف
-m ، --markdown	إنشاء تخفيض السعر لاستخدامه في الوثائق

index list

قائمة الفهارس.

مثال:

 seqcli index list

خيار	وصف
-i , --id=VALUE	معرف فهرس واحد للقائمة
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

index suppress

قمع الفهرس.

مثال:

 seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748

خيار	وصف
-i , --id=VALUE	معرف الفهرس المطلوب منعه
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

ingest

إرسال أحداث السجل من ملف أو STDIN .

مثال:

'Debug'" -p Environment=Test" style=";text-align:right;direction:rtl">

 seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test

خيار	وصف
-i ، --input=VALUE	الملف (الملفات) المراد استيعابها، بما في ذلك حرف البدل * ؛ إذا لم يتم تحديده، سيتم استخدام STDIN
--invalid-data=VALUE	حدد كيفية معالجة البيانات غير الصالحة: fail (افتراضي) أو ignore
-p , --property=NAME=VALUE	حدد خصائص الاسم/القيمة، على سبيل المثال -p Customer=C123 -p Environment=Production
-x , --extract=VALUE	نمط استخراج يتم تطبيقه على سجلات النص العادي (يتم تجاهله عند تحديد --json )
--json	قراءة الأحداث بتنسيق JSON (الافتراضي يفترض وجود نص عادي)
-f , --filter=VALUE	تصفية التعبير لتحديد مجموعة فرعية من الأحداث
-m , --message=VALUE	رسالة لربطها بالأحداث المتناولة؛ https://messagetemplates.org يتم دعم بناء الجملة
-l , --level=VALUE	المستوى أو الخطورة المرتبطة بالأحداث التي تم تناولها؛ سيؤدي هذا إلى تجاوز أي معلومات مستوى موجودة في الأحداث نفسها
--send-failure=VALUE	حدد كيفية معالجة حالات فشل الاتصال: fail (الافتراضي)، retry ، أو continue ، أو ignore
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey
--batch-size=VALUE	الحد الأقصى لعدد الأحداث التي سيتم إرسالها في كل طلب إلى نقطة نهاية العرض؛ إذا لم يتم تحديد سيتم استخدام قيمة 100

license apply

قم بتطبيق ترخيص على خادم Seq.

مثال:

 seqcli license apply --certificate="license.txt"

خيار	وصف
-c , --certificate=VALUE	ملف الشهادة؛ يجب أن يكون الملف نص UTF-8
--certificate-stdin	اقرأ شهادة الترخيص من STDIN
--automatically-refresh	إذا كان الترخيص مخصصًا للاشتراك، فتحقق بشكل دوري datalust.co وقم بتحديث الشهادة تلقائيًا عند تغيير الاشتراك أو تجديده
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

log

إرسال حدث سجل منظم إلى الخادم.

مثال:

 seqcli log -m 'Hello, {Name}!' -p Name=World -p App=Test

خيار	وصف
-m , --message=VALUE	رسالة لربطها بالحدث (الافتراضي هو عدم إرسال أي رسالة)؛ https://messagetemplates.org يتم دعم بناء الجملة
-l , --level=VALUE	مستوى الحدث أو خطورته (المستوى الافتراضي هو Information )
-t ، --timestamp=VALUE	الطابع الزمني للحدث هو ISO-8601 (سيتم استخدام الطابع الزمني UTC الحالي بشكل افتراضي)
-x , --exception=VALUE	معلومات إضافية حول الاستثناء أو الخطأ لإرسالها، إن وجدت
-p , --property=NAME=VALUE	حدد خصائص الاسم/القيمة، على سبيل المثال -p Customer=C123 -p Environment=Production
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

node demote

البدء في خفض رتبة العقدة الرائدة الحالية.

مثال:

 seqcli node demote --verbose --wait

خيار	وصف
--wait	انتظر حتى يتم تخفيض رتبة القائد قبل الخروج
-y ، --confirm	أجب بـ [y] عندما يُطلب منك المتابعة
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

node health

تحقق من نقطة النهاية /health الخاصة بعقدة Seq، واطبع رمز حالة HTTP الذي تم إرجاعه، أو "غير قابل للوصول" إذا تعذر الاستعلام عن نقطة النهاية.

مثال:

 seqcli node health -s https://seq-2.example.com

خيار	وصف
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

node list

قائمة العقد في مجموعة Seq.

مثال:

 seqcli node list --json

خيار	وصف
-n ، --name=VALUE	اسم عقدة نظام المجموعة المطلوب إدراجها
-i , --id=VALUE	معرف عقدة كتلة واحدة لإدراجها
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.serverUrl
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم؛ افتراضيًا، سيتم استخدام قيمة التكوين connection.apiKey
--profile=VALUE	ملف تعريف الاتصال للاستخدام؛ افتراضيًا، سيتم استخدام قيم التكوين connection.serverUrl و connection.apiKey

print

أحداث مطبوعة بشكل جميل بتنسيق CLEF/JSON، من ملف أو STDIN .

مثال:

 seqcli print -i log-20201028.clef

خيار	وصف
-i ، --input=VALUE	ملف CLEF للقراءة، بما في ذلك حرف البدل * ؛ إذا لم يتم تحديده، سيتم استخدام STDIN
-f , --filter=VALUE	تصفية التعبير لتحديد مجموعة فرعية من الأحداث
--template=VALUE	حدد قالب إخراج للتحكم في تنسيق النص العادي
--invalid-data=VALUE	حدد كيفية معالجة البيانات غير الصالحة: fail (افتراضي) أو ignore
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)

profile create

إنشاء أو استبدال ملف تعريف الاتصال.

مثال:

 seqcli profile create -n Production -s https://seq.example.com -a th15ISanAPIk3y

خيار	وصف
-n ، --name=VALUE	اسم ملف تعريف الاتصال
-s , --server=VALUE	عنوان URL لخادم Seq
-a , --apikey=VALUE	مفتاح API الذي سيتم استخدامه عند الاتصال بالخادم، إذا لزم الأمر

profile list

قائمة ملفات تعريف الاتصال.

مثال:

 seqcli profile list

profile remove

قم بإزالة ملف تعريف الاتصال.

مثال:

 seqcli profile remove -n Production

خيار	وصف
-n ، --name=VALUE	اسم ملف تعريف الاتصال المراد إزالته

query

قم بتنفيذ استعلام SQL واحصل على النتائج بتنسيق CSV.

مثال:

 seqcli query -q "select count(*) from stream group by @Level" --start="2018-02-28T13:00Z"

خيار	وصف
-q , --query=VALUE	الاستعلام المطلوب تنفيذه
--start=VALUE	تاريخ/وقت ISO 8601 للاستعلام منه
--end=VALUE	تاريخ/وقت ISO 8601 للاستعلام عنه
--signal=VALUE	تعبير إشارة أو قائمة بمعرفات الإشارة المتقاطعة المراد تطبيقها، على سبيل المثال signal-1,signal-2
--timeout=VALUE	مهلة التنفيذ بالمللي ثانية
--json	طباعة الإخراج بتنسيق JSON محدد بسطر جديد (الافتراضي هو نص عادي)
--no-color	لا تلوين إخراج النص
--force-color	فرض إخراج مُعاد توجيهه ليكون له لون ANSI (ما لم يتم تحديد --no-color أيضًا)
-s , --server=VALUE	عنوان URL لخادم Seq؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

retention create

إنشاء سياسة الاحتفاظ.

مثال:

 seqcli retention create --after 30d --delete-all-events

خيار	وصف
--after=VALUE	مدة وبعدها ستحذف السياسة الأحداث ، على سبيل المثال 7d
--delete-all-events	يجب أن تحذف السياسة جميع الأحداث (حاليًا الخيار الوحيد المدعوم)
--delete=VALUE	دفق الأحداث الواردة إلى مثيل التطبيق عند تناولها ؛ يقبل اختياريا تعبير الإشارة يحد من الأحداث التي يجب بثها
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )

retention list

قائمة سياسات الاحتفاظ.

مثال:

 seqcli retention list

خيار	وصف
-i ، --id=VALUE	هوية سياسة الاحتفاظ واحدة لإدراجها
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

retention remove

إزالة سياسة الاحتفاظ من الخادم.

مثال:

 seqcli retention remove -i retentionpolicy-17

خيار	وصف
-i ، --id=VALUE	هوية سياسة الاحتفاظ واحدة لإزالتها
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

retention update

تحديث سياسة الاحتفاظ الحالية.

مثال:

 seqcli retention update --json '{...}'

خيار	وصف
--json=VALUE	سياسة الاستبقاء المحدثة بتنسيق JSON ؛ يمكن إنتاج هذا باستخدام seqcli retention list --json
--json-stdin	اقرأ سياسة الاستبقاء المحدثة كـ JSON من STDIN
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

sample ingest

سجل عينة الأحداث في مثيل SEQ.

مثال:

 seqcli sample ingest

خيار	وصف
-y ، --confirm	أجب [y] es عندما تتم مطالبته بالمتابعة
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey
--quiet	لا صدى الأحداث التي تم تناولها إلى STDOUT
--batch-size=VALUE	الحد الأقصى لعدد الأحداث التي يجب إرسالها في كل طلب إلى نقطة نهاية الابتلاع ؛ إذا لم يتم تحديدها ، فسيتم استخدام قيمة 100

sample setup

قم بتكوين مثيل SEQ مع عينة من لوحات المعلومات والإشارات والمستخدمين وما إلى ذلك.

مثال:

 seqcli sample setup

خيار	وصف
-y ، --confirm	أجب [y] es عندما تتم مطالبته بالمتابعة
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

search

استرداد أحداث السجل التي تتطابق مع مرشح معين.

مثال:

 seqcli search -f "@Exception like '%TimeoutException%'" -c 30

خيار	وصف
-f ، --filter=VALUE	مرشح للتطبيق على البحث ، على سبيل المثال Host = 'xmpweb-01.example.com'
-c ، --count=VALUE	الحد الأقصى لعدد الأحداث لاسترداده ؛ الافتراضي هو 1
--start=VALUE	ISO 8601 تاريخ/الوقت للاستعلام من
--end=VALUE	ISO 8601 تاريخ/الوقت للاستعلام عن
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )
--signal=VALUE	تعبير إشارة أو قائمة معرفات الإشارة المتقاطعة لتطبيق ، على سبيل المثال signal-1,signal-2
--request-timeout=VALUE	الوقت المسموح به لاسترداد كل صفحة من الأحداث ، بالمللي ثانية ؛ الافتراضي هو 100000
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

setting clear

قم بمسح إعداد خادم قابل للتشغيل وقت التشغيل.

خيار	وصف
-n ، --name=VALUE	اسم الإعداد ، على سبيل المثال OpenIdConnectClientSecret
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

setting names

اطبع أسماء جميع الإعدادات المدعومة.

setting set

قم بتغيير إعداد الخادم القابل للتكوين وقت التشغيل.

خيار	وصف
-n ، --name=VALUE	اسم الإعداد ، على سبيل المثال OpenIdConnectClientSecret
-v ، --value=VALUE	قيمة الإعداد ، مفصولة الفاصلة إذا تم قبول قيم متعددة
--value-stdin	اقرأ القيمة من STDIN
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

setting show

اطبع القيمة الحالية لإعداد خادم وقت التشغيل القابل للتشكيل.

خيار	وصف
-n ، --name=VALUE	اسم الإعداد ، على سبيل المثال OpenIdConnectClientSecret
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

signal create

إنشاء إشارة.

مثال:

 seqcli signal create -t 'Exceptions' -f "@Exception is not null"

خيار	وصف
-t ، --title=VALUE	عنوان للإشارة
--description=VALUE	وصف للإشارة
-f ، --filter=VALUE	تصفية للربط بالإشارة
-c ، --column=VALUE	عمود للربط بالإشارة ؛ يمكن استخدام هذه الحجة عدة مرات
--group=VALUE	اسم مجموعة صريح للربط بالإشارة ؛ الافتراضي هو استنتاج المجموعة من المرشح
--no-group	حدد أنه لا ينبغي استنتاج أي مجموعة ؛ الافتراضي هو استنتاج المجموعة من المرشح
--protected	حدد أن الإشارة قابلة للتحرير فقط من قبل المسؤولين
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )

signal import

استيراد إشارات في تنسيق JSON NEWLINE.

مثال:

 seqcli signal import -i ./Exceptions.json

خيار	وصف
--merge	تحديث الإشارات التي تحتوي على معرفات تطابق تلك الموجودة في البيانات المستوردة ؛ الافتراضي هو إنشاء إشارات جديدة دائمًا
-i ، --input=VALUE	ملف للاستيراد ؛ إذا لم يتم تحديدها ، فسيتم استخدام STDIN
-o ، --owner=VALUE	معرف المستخدم لاستيراد إشارات ؛ بشكل افتراضي ، الإشارات المشتركة هي استيرادها
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

signal list

قائمة الإشارات المتاحة.

مثال:

 seqcli signal list

خيار	وصف
-t ، --title=VALUE	عنوان الإشارة (الإشارات) لإدراجها
-i ، --id=VALUE	معرف إشارة واحدة لإدراجها
-o ، --owner=VALUE	معرف المستخدم لإدراج إشارات ؛ افتراضيًا ، الإشارات المشتركة هي ListD
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

signal remove

إزالة إشارة من الخادم.

مثال:

 seqcli signal remove -t 'Test Signal'

خيار	وصف
-t ، --title=VALUE	عنوان الإشارة (الإشارات) لإزالته
-i ، --id=VALUE	معرف إشارة واحدة لإزالته
-o ، --owner=VALUE	معرف المستخدم لإزالة الإشارات ؛ بشكل افتراضي ، الإشارات المشتركة هي إزالة
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

signal update

تحديث إشارة موجودة.

مثال:

 seqcli signal update --json '{...}'

خيار	وصف
--json=VALUE	الإشارة المحدثة بتنسيق JSON ؛ يمكن إنتاج هذا باستخدام seqcli signal list --json
--json-stdin	اقرأ الإشارة المحدثة باسم JSON من STDIN
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

tail

دفق أحداث سجل مطابقة مرشح.

خيار	وصف
-f ، --filter=VALUE	مرشح اختياري من جانب الخادم للتطبيق على الدفق ، على سبيل المثال @Level = 'Error'
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )
--signal=VALUE	تعبير إشارة أو قائمة معرفات الإشارة المتقاطعة لتطبيق ، على سبيل المثال signal-1,signal-2
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

template export

تصدير الكيانات في ملفات القالب.

مثال:

 seqcli template export -o ./Templates

خيار	وصف
-o ، --output=VALUE	الدليل الذي يكتب فيه ملفات القالب ؛ يجب أن يكون الدليل موجودًا ؛ سيتم كتابة أي ملفات موجودة بأسماء تتطابق مع القوالب المصدرة ؛ الافتراضي هو .
-i ، --include=VALUE	معرف الإشارة أو لوحة القيادة أو الاستعلام المحفوظ أو مساحة العمل أو سياسة الاحتفاظ بالتصدير ؛ يمكن تحديد هذه الحجة عدة مرات ؛ الافتراضي هو تصدير جميع الكيانات المشتركة
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

template import

استيراد الكيانات من ملفات القالب.

مثال:

 seqcli template import -i ./Templates

خيار	وصف
-i ، --input=VALUE	الدليل الذي يقرأ منه مجموعة ملفات .template ؛ الافتراضي هو .
--state=VALUE	مسار الملف الذي سيستمر في رسم خرائط لأسماء القوالب إلى معرفات الكيانات التي تم إنشاؤها على الخادم المستهدف ، وتجنب التكرارات عند إجراء واردات متعددة ؛ افتراضيًا ، سيتم استخدام import.state في دليل الإدخال
--merge	بالنسبة للقوالب التي لا توجد بها إدخالات في ملف .state ، تحقق أولاً من الكيانات الموجودة بأسماء أو عناوين مطابقة ؛ لا يدعم دمج سياسات الاستبقاء
-g ، --arg=NAME=VALUE	وسيطات القالب ، على سبيل المثال -g ownerId=user-314159
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

user create

إنشاء مستخدم.

مثال:

 seqcli user create -n alice -d 'Alice Example' -r 'User (read/write)' --password-stdin

خيار	وصف
-n ، --name=VALUE	اسم مستخدم فريد للمستخدم
-d ، --display-name=VALUE	اسم طويل الشكل للمساعدة في تحديد المستخدم
-f ، --filter=VALUE	مرشح عرض يحد من الأحداث المرئية للمستخدم
-r ، --role=VALUE	عنوان الدور الذي يمنح أذونات المستخدم على الخادم ؛ إذا لم يتم تحديده ، سيتم تعيين دور المستخدم الجديد الافتراضي
-e ، --email=VALUE	عنوان البريد الإلكتروني للمستخدم (يتيح صورة Gravatar للمستخدم)
-p ، --password=VALUE	كلمة مرور أولية للمستخدم ، إذا كانت مصادقة اسم المستخدم/كلمة المرور قيد الاستخدام ؛ لاحظ أن- --password-stdin أكثر أمانًا
--password-stdin	اقرأ كلمة المرور الأولية للمستخدم من STDIN ، إذا كانت مصادقة اسم المستخدم/كلمة المرور قيد الاستخدام
--no-password-change	لا تجبر المستخدم على تغيير كلمة المرور الخاصة بهم في تسجيل الدخول التالي
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )

user list

قائمة المستخدمين.

مثال:

 seqcli user list

خيار	وصف
-n ، --name=VALUE	اسم المستخدم للمستخدمين
-i ، --id=VALUE	معرف مستخدم واحد لإدراجه
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

user remove

قم بإزالة مستخدم من الخادم.

مثال:

 seqcli user remove -n alice

خيار	وصف
-n ، --name=VALUE	اسم المستخدم للمستخدمين (المشاركون) لإزالته
-i ، --id=VALUE	معرف مستخدم واحد لإزالته
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

user update

تحديث مستخدم موجود.

مثال:

 seqcli user update --json '{...}'

خيار	وصف
--json=VALUE	المستخدم المحدث بتنسيق JSON ؛ يمكن إنتاج هذا باستخدام seqcli user list --json
--json-stdin	اقرأ المستخدم المحدث على أنه JSON من STDIN
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

version

طباعة النسخة القابلة للتنفيذ الحالية.

workspace create

إنشاء مساحة عمل.

مثال:

 seqcli workspace create -t 'My Workspace' -c signal-314159 -c dashboard-628318

خيار	وصف
-t ، --title=VALUE	عنوان مساحة العمل
--description=VALUE	وصف لمساحة العمل
-c ، --content=VALUE	معرف لوحة القيادة أو الإشارة أو الاستعلام المحفوظ ليشمله في مساحة العمل
--protected	حدد أن مساحة العمل قابلة للتحرير فقط من قبل المسؤولين
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )

workspace list

قائمة مساحات العمل المتاحة.

مثال:

 seqcli workspace list

خيار	وصف
-t ، --title=VALUE	عنوان مساحة العمل (ق) لإدراجه
-i ، --id=VALUE	معرف مساحة عمل واحدة لإدراجها
-o ، --owner=VALUE	معرف المستخدم لسرد مساحات العمل ل ؛ بشكل افتراضي ، مساحات العمل المشتركة هي LISTD
--json	طباعة الإخراج في Newline Line-Delited JSON (الافتراضي هو نص عادي)
--no-color	لا تلون إخراج النص
--force-color	تم إعادة توجيه القوة لإعادة توجيه لون ANSI (ما لم يتم --no-color )
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

workspace remove

إزالة مساحة عمل من الخادم.

مثال:

 seqcli workspace remove -t 'My Workspace'

خيار	وصف
-t ، --title=VALUE	عنوان مساحة العمل (ق) لإزالته
-i ، --id=VALUE	معرف مساحة عمل واحدة لإزالته
-o ، --owner=VALUE	معرف المستخدم لإزالة مساحات العمل ؛ بشكل افتراضي ، يتم إزالة مساحات العمل المشتركة
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

workspace update

تحديث مساحة عمل موجودة.

مثال:

 seqcli workspace update --json '{...}'

خيار	وصف
--json=VALUE	مساحة العمل المحدثة بتنسيق JSON ؛ يمكن إنتاج هذا باستخدام seqcli workspace list --json
--json-stdin	اقرأ مساحة العمل المحدثة مثل JSON من STDIN
-s ، --server=VALUE	عنوان URL لخادم SEQ ؛ بشكل افتراضي ، سيتم استخدام قيمة التكوين connection.serverUrl
-a ، --apikey=VALUE	مفتاح API للاستخدام عند الاتصال بالخادم ؛ بشكل افتراضي ، سيتم استخدام قيمة connection.apiKey التكوين
--profile=VALUE	ملف تعريف اتصال للاستخدام ؛ بشكل افتراضي ، سيتم استخدام قيم connection.serverUrl و connection.apiKey

أنماط الاستخراج

يمكن استخدام أمر seqcli ingest لتحليل سجلات النص العادي في أحداث السجل المهيكلة.

seqcli ingest -x " {@t:timestamp} [{@l:level}] {@m:*}{:n}{@x:*} "

حجة -x أعلاه هي نمط استخراج من شأنه تحليل الأحداث مثل:

 2018-02-21 13:29:00.123 +10:00 [ERR] The operation failed
System.DivideByZeroException: Attempt to divide by zero
  at SomeClass.SomeMethod()

بناء الجملة

أنماط الاستخراج لها بناء جملة بسيطة عالية المستوى:

• يتم مطابقة النص الذي يظهر في النمط حرفيًا - لذلك نمط مثل Hello, world! سوف تتطابق مع بيانات التسجيل التي تتكون من هذه التحية فقط ،
• النص بين {curly braces} هو تعبير مطابق يحدد جزءًا من الحدث المراد استخلاصه ، و
• يتم هروب الأقواس الحرفية المجعد عن طريق المضاعفة ، لذلك سوف يتطابق {{ سوف يتطابق مع النص الحرفي { ، و }} } .

تعبيرات المباراة لها النموذج:

 {name:matcher}

كل من الاسم والمطابق اختياري ، ولكن يجب تحديد واحد أو آخر. وبالتالي {:n} يحدد {@t:timestamp} اسمًا لـ @t و timestamp {IPAddress}

الاسم هو اسم الخاصية المراد استخلاصها ؛ هناك أربعة أسماء الممتلكات المدمجة تحصل على معالجة خاصة:

• @t - الطابع الزمني للحدث
• @m - الرسالة النصية المرتبطة بالحدث
• @l - مستوى الحدث
• @x - الاستثناء أو الخلفية المرتبطة بالحدث

يتم إرفاق أسماء الممتلكات الأخرى بحمولة الحدث ، لذلك ستستخرج {Elapsed:dec} خاصية تسمى Elapsed ، باستخدام Matcher dec Decimal.

يتم استهلاك تعبيرات المطابقة بدون اسم من المدخلات ، ولكن لا تتم إضافتها إلى حمولة الحدث.

المطابقات

تحدد المطاعم قطع حدث الإدخال.

هناك حاجة إلى مطابقة مختلفة بحيث يمكن فصل قطعة من النص مثل 200OK إلى خصائص منفصلة ، أي {StatusCode:nat}{Status:alpha} . هنا ، يقوم مطابقة nat (NATURE NUMBER) أيضًا بإكراه النتيجة على قيمة رقمية ، بحيث يتم إرفاقها بحمولة الحدث عدديًا مثل 200 بدلاً من النص "200" .

هناك ثلاثة أنواع من المطاعم:

• الممرات مثل alpha و nat مدمجة في مجلة اسمها .
• المطابقات الخاصة * ، ** وما إلى ذلك ، هم من غير محتوى المحتوى غير الخضراء ؛ سوف تتطابق مع أي نص لأعلى حتى يتطابق عنصر النمط التالي ( * ) ، والمادة المقبلة يتطابق مع العنصرين ، وما إلى ذلك. لقد رأينا هذا في العمل مع العناصر {@m:*}{:n} في المثال - الرسالة هي كل النص حتى الخط الجديد التالي.
• يتم وصف المطاعم المركبة الأكثر تعقيدًا باستخدام التعبير الفرعي. هذه مسبقة مع علامة متساوية = ، مثل {Phone:={:nat}-{:nat}-{:nat}} . سيؤدي ذلك إلى استخراج أجزاء من النص مثل 123-456-7890 في خاصية Phone .

مطابقة	وصف	مثال
* ، ** ، ...	محتوى غير غريدي
alpha	حرف واحد أو أكثر	Abc
alphanum	رسالة أو أكثر أو أكثر	a1b2
dec	عدد عشري	12.345
ident	معرف على طراز C.	countOfMatches
int	عدد صحيح	-123
iso8601dt	وقت تاريخ ISO-8601	2020-01-28T13:50:01.123
level	اسم مستوى التسجيل	INF
line	أي محتوى خط واحد	one line!
n	شخصية أو تسلسل سطر جديد
nat	رقم غير سالب	123
s	شخص واحد أو أكثر من الأحرف أو علامة التبويب
serilogdt	وقت DATETERT في تنسيق تسجيل ملفات serilog الافتراضي	2020-01-28 13:50:01.123 +10:00
syslogdt	وقت DateTere في تنسيق syslog	Dec 8 09:12:13
t	حرف علامة تبويب واحدة
timestamp	وقت البيانات في أي تنسيق معترف به
token	أي تسلسل من أحرف غير وايتيس	1+x$3
trailingident	محتوى متعدد الأمن مع خطوط زائدة بادئة
unixdt	وقت DateTime بتنسيق Time Unix يدعم الثواني (10 أرقام) أو مللي ثانية (12 رقمًا)	1608694199.999
w3cdt	تاريخ تنسيق سجل W3C/الوقت	2019-04-02 05:18:01

يعالج

تتم معالجة أنماط الاستخراج من اليسار إلى اليمين. عند مواجهة أول نمط غير متطابق ، يتوقف الاستخراج ؛ سيتم إرفاق أي نص متبقي لا يمكن مطابقة الحدث الناتج في خاصية @unmatched .

تتم معالجة الأحداث متعددة الخطوط من خلال البحث عن خطوط تبدأ بالعنصر الأول من نمط الاستخراج ليتم استخدامه. هذا يعمل بشكل جيد إذا بدأ السطر الأول من كل حدث بشيء لا لبس فيه مثل طابع زمني iso8601dt ؛ إذا بدأت الخطوط مع بناء جملة أقل تحديدًا ، فقد يتم تجميع العناصر القليلة الأولى من نمط الاستخراج لتحديد بداية الأحداث بشكل أكثر دقة:

 {:=[{@t} {@l}]} {@m:*}

هنا النص الحرفي [ ، رمز طابع زمني ، مساحة مجاورة ، يتم تجميع المستوى والإغلاق ] بحيث تشكل عنصر نمط منطقي واحد لتحديد بداية الأحداث.

عندما يتم دفق السجلات إلى seqcli ingest في الوقت الفعلي ، يتم تطبيق موعد نهائي 10 مللي ثانية ، حيث يجب استلام أي خطوط زائدة تشكل الحدث.

أمثلة

سجلات systemd الذيل

journalctl -f -n 0 |
  seqcli ingest -x " {@t:syslogdt} {host} {ident:*}: {@m:*}{:n} " --invalid-data=ignore

ذيل /var/log/syslog

tail -c 0 -F /var/log/syslog |
  seqcli ingest -x " {@t:syslogdt} {host} {ident:*}: {@m:*}{:n} " 

استيعاب سجل خادم الويب IIS/W3C

هذا المثال يتناول ملفات السجل بالتنسيق:

 # Fields: date time s-ip cs-method cs-uri-stem cs-uri-query s-port cs-username c-ip cs(User-Agent) 
cs(Referer) sc-status sc-substatus sc-win32-status sc-bytes cs-bytes time-taken

يتم لف نمط الاستخراج في المثال لأغراض العرض ، ويجب أن يظهر كل شيء في وسيطة سلسلة واحدة عند الاحتجاج بها.

seqcli ingest -i http.log --invalid-data=ignore -x " {@t:w3cdt} {ServerIP} {@m:={Method} {RequestPath}} 
{Query} {Port:nat} {Username} {ClientIP} {UserAgent} {Referer} {StatusCode:nat} {Substatus:nat} 
{Win32Status:nat} {ResponseBytes:nat} {RequestBytes:nat} {Elapsed}{:n} "

يتم استخدام {@m:= النمط المتداخل لجمع سلسلة فرعية من سطر السجل للعرض كرسالة الحدث.

تحديث الكيانات

تجعل عائلة أوامر seqcli * update من إمكانية إجراء تحديثات تعسفية للعديد من أنواع الكيانات المعقدة.

تتلقى أوامر update ، مثل seqcli signal update الموضحة في المثال أدناه ، تمثيل JSON محدث لكيان عبر STDIN .

هذا يعمل بشكل جيد بشكل خاص مع أدوات مثل jq والقذائف الحديثة مع دعم JSON الأصلي ، مثل PowerShell:

(echo $warnings | ConvertTo-Json) | seqcli signal update --json-stdin PS > seqcli signal list -i signal-m33302 --json {"Title": "Alarms", "Description": "Automatically created", "Filters": [{"De..." style=";text-align:right;direction:rtl">

 PS > $warnings = (seqcli signal list -i signal-m33302 --json | ConvertFrom-Json)

PS > $warnings.Title                                                                                                                
Warnings

PS > $warnings.Title = "Alarms"

PS > (echo $warnings | ConvertTo-Json) | seqcli signal update --json-stdin        

PS > seqcli signal list -i signal-m33302 --json                                 
{"Title": "Alarms", "Description": "Automatically created", "Filters": [{"De...