seqcli

seqcli

แอปบรรทัดคำสั่งไคลเอ็นต์ Seq รองรับการบันทึก ( seqcli log ) การค้นหา ( search ) tailing ( tail ) การสืบค้น ( query ) และ JSON หรือการนำเข้าไฟล์บันทึกข้อความธรรมดา ( ingest ) และอื่นๆ อีกมากมาย

เริ่มต้นใช้งาน

โปรแกรมติดตั้ง Seq สำหรับ Windows รวมถึง seqcli . มิฉะนั้น ให้ดาวน์โหลดเวอร์ชันสำหรับระบบปฏิบัติการของคุณ หรือหากคุณติดตั้ง dotnet ไว้ ก็สามารถติดตั้ง seqcli เป็นเครื่องมือส่วนกลางได้โดยใช้:

 dotnet tool install --global seqcli

หากต้องการตั้งค่า URL เซิร์ฟเวอร์เริ่มต้นและคีย์ API ให้รัน:

 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 ของเครื่อง (ไม่ใช่ localhost) หรือระบุเครือข่ายโฮสต์นักเทียบท่าด้วย --net host

ใช้เครือข่าย Docker และวอลุ่มเพื่อทำให้ไฟล์ในเครื่องและคอนเทนเนอร์อื่นๆ เข้าถึง seqcli ภายในคอนเทนเนอร์ได้

การแทนที่ตัวแปรสภาพแวดล้อม

ค่าการตั้งค่าแต่ละค่าสามารถแทนที่ได้ขณะรันไทม์โดยการระบุตัวแปรสภาพแวดล้อมในรูปแบบ SEQCLI_<setting path> โดยที่ประกอบด้วยหนึ่งองค์ประกอบสำหรับแต่ละส่วนที่เป็นเส้นประของชื่อการตั้งค่า โดยคั่นด้วยเครื่องหมายขีดล่าง

ตัวอย่างเช่น การตั้งค่า connection.serverUrl สามารถแทนที่ด้วยตัวแปร SEQCLI_CONNECTION_SERVERURL

การเชื่อมต่อโดยไม่ต้องใช้คีย์ API

หากคุณตั้งค่า Seq โดยอัตโนมัติ มีโอกาสที่คุณจะยังไม่มีคีย์ API เพื่อให้ 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 นั้น

ในการพิจารณาสิทธิ์ที่จำเป็นสำหรับคำสั่ง ให้ตรวจสอบคอลัมน์ 'ความต้องการสิทธิ์' ของการดำเนินการ 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 - แสดงรายการคีย์ API ที่มีอยู่
  • 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 — กิจกรรม Pretty-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	ชื่อผู้ใช้สำหรับเชื่อมต่อ ซึ่งมีประโยชน์เป็นหลักเมื่อตั้งค่าคีย์ API แรก เซิร์ฟเวอร์ที่มีการสมัครสมาชิก 'ส่วนบุคคล' อนุญาตเพียงหนึ่งคำขอพร้อมกันด้วยตัวเลือกนี้
--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	ชื่อของคีย์ API ที่จะแสดงรายการ
-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	ชื่อของคีย์ API ที่จะลบ
-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	ID ของผู้ใช้ที่จะแสดงรายการแดชบอร์ด โดยค่าเริ่มต้น แดชบอร์ดที่ใช้ร่วมกันจะแสดงรายการ
--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	ID ของผู้ใช้ที่จะลบแดชบอร์ดสำหรับ; ตามค่าเริ่มต้น แดชบอร์ดที่ใช้ร่วมกันจะถูกลบออก
-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 จะเป็นของเรา