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 <command> [<args>]
للاتصال بـ Seq في حاوية عامل إرساء على الجهاز المحلي، استخدم عنوان IP الخاص بالجهاز (وليس المضيف المحلي) أو حدد شبكة مضيف عامل الإرساء باستخدام --net host
.
استخدم شبكات ووحدات تخزين Docker لجعل الملفات المحلية والحاويات الأخرى قابلة للوصول إلى seqcli
داخل الحاوية الخاصة بها.
يمكن تجاوز كل قيمة إعداد في وقت التشغيل عن طريق تحديد متغير بيئة من النموذج SEQCLI_<setting path>
، حيث يحتوي على عنصر واحد لكل مقطع منقط من اسم الإعداد، مفصولاً بشرطات سفلية.
على سبيل المثال، يمكن تجاوز الإعداد connection.serverUrl
باستخدام المتغير SEQCLI_CONNECTION_SERVERURL
.
إذا كنت تقوم بأتمتة إعداد 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 <command> [<args>]
يمكن عرض القائمة الكاملة للأوامر المدعومة عن طريق تشغيل:
seqcli help
لإظهار معلومات الاستخدام لأمر معين، قم بتشغيل seqcli help <command>
، على سبيل المثال:
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
.
مثال:
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 هي نحن |