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 []
หากต้องการเชื่อมต่อกับ Seq ในคอนเทนเนอร์นักเทียบท่าบนเครื่องท้องถิ่น ให้ใช้ที่อยู่ IP ของเครื่อง (ไม่ใช่ localhost) หรือระบุเครือข่ายโฮสต์นักเทียบท่าด้วย --net host
ใช้เครือข่าย Docker และวอลุ่มเพื่อทำให้ไฟล์ในเครื่องและคอนเทนเนอร์อื่นๆ เข้าถึง seqcli
ภายในคอนเทนเนอร์ได้
ค่าการตั้งค่าแต่ละค่าสามารถแทนที่ได้ขณะรันไทม์โดยการระบุตัวแปรสภาพแวดล้อมในรูปแบบ SEQCLI_
โดยที่ประกอบด้วยหนึ่งองค์ประกอบสำหรับแต่ละส่วนที่เป็นเส้นประของชื่อการตั้งค่า โดยคั่นด้วยเครื่องหมายขีดล่าง
ตัวอย่างเช่น การตั้งค่า connection.serverUrl
สามารถแทนที่ด้วยตัวแปร SEQCLI_CONNECTION_SERVERURL
หากคุณตั้งค่า 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 []
รายการคำสั่งที่รองรับทั้งหมดสามารถดูได้โดยการรัน:
seqcli help
หากต้องการแสดงข้อมูลการใช้งานสำหรับคำสั่งเฉพาะ ให้รัน seqcli help
เช่น:
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
— สร้างฟีด NuGetfeed list
— แสดงรายการฟีด NuGetfeed remove
— ลบฟีด NuGet ออกจากเซิร์ฟเวอร์feed update
- อัปเดตฟีด NuGet ที่มีอยู่help
— แสดงข้อมูลเกี่ยวกับคำสั่งที่ใช้ได้index
index list
— รายการดัชนีindex suppress
- ระงับดัชนีingest
— ส่งเหตุการณ์บันทึกจากไฟล์หรือ STDIN
license apply
— ใช้ใบอนุญาตกับเซิร์ฟเวอร์ Seqlog
— ส่งเหตุการณ์บันทึกที่มีโครงสร้างไปยังเซิร์ฟเวอร์node
node demote
- เริ่มต้นการลดระดับของโหนดผู้นำปัจจุบันnode health
— ตรวจสอบจุดสิ้นสุด /health
ของโหนด Seq และพิมพ์รหัสสถานะ HTTP ที่ส่งคืน หรือ 'ไม่สามารถเข้าถึงได้' หากไม่สามารถสอบถามจุดสิ้นสุดได้node list
- รายการโหนดในคลัสเตอร์ Seqprint
— กิจกรรม Pretty-print ในรูปแบบ CLEF/JSON จากไฟล์หรือ STDIN
profile
profile create
— สร้างหรือแทนที่โปรไฟล์การเชื่อมต่อprofile list
— แสดงรายการโปรไฟล์การเชื่อมต่อprofile remove
— ลบโปรไฟล์การเชื่อมต่อquery
— ดำเนินการแบบสอบถาม SQL และรับผลลัพธ์ในรูปแบบ CSVretention
retention create
— สร้างนโยบายการเก็บรักษาretention list
— แสดงรายการนโยบายการเก็บรักษาretention remove
— ลบนโยบายการเก็บรักษาออกจากเซิร์ฟเวอร์retention update
— อัปเดตนโยบายการเก็บรักษาที่มีอยู่sample
sample ingest
— บันทึกเหตุการณ์ตัวอย่างลงในอินสแตนซ์ Seqsample 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 |
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]es เมื่อได้รับแจ้งให้ดำเนินการต่อ |
-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 config |
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 config |
--json | พิมพ์เอาต์พุตใน JSON ที่กำหนดใหม่ (ค่าเริ่มต้นคือข้อความธรรมดา) |
--no-color | อย่าสีเอาต์พุตข้อความสี |
--force-color | บังคับให้มีการเปลี่ยนเส้นทางออกเป็นสี ANSI (เว้นแต่ --no-color )) |
retention list
นโยบายการเก็บรักษารายการ
ตัวอย่าง:
seqcli retention list
ตัวเลือก | คำอธิบาย |
---|---|
-i , --id=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 config |
retention remove
ลบนโยบายการเก็บรักษาออกจากเซิร์ฟเวอร์
ตัวอย่าง:
seqcli retention remove -i retentionpolicy-17
ตัวเลือก | คำอธิบาย |
---|---|
-i , --id=VALUE | ID ของนโยบายการเก็บรักษาเดียวเพื่อลบ |
-s , --server=VALUE | URL ของเซิร์ฟเวอร์ SEQ; โดยค่าเริ่มต้นจะใช้ค่าการกำหนดค่า connection.serverUrl |
-a , --apikey=VALUE | คีย์ API ที่จะใช้เมื่อเชื่อมต่อกับเซิร์ฟเวอร์ โดยค่าเริ่มต้นจะใช้ค่าการกำหนด connection.apiKey |
--profile=VALUE | โปรไฟล์การเชื่อมต่อที่จะใช้ โดยค่าเริ่มต้นจะใช้ค่า connection.serverUrl และ connection.apiKey config |
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 config |
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 config |
--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 config |
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 | พิมพ์เอาต์พุตใน 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 config |
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 config |
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 config |
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 config |
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 config |
--json | พิมพ์เอาต์พุตใน JSON ที่กำหนดใหม่ (ค่าเริ่มต้นคือข้อความธรรมดา) |
--no-color | อย่าสีเอาต์พุตข้อความสี |
--force-color | บังคับให้มีการเปลี่ยนเส้นทางออกเป็นสี ANSI (เว้นแต่ --no-color )) |
signal import
นำเข้าสัญญาณในรูปแบบ JSON ที่กำหนดใหม่
ตัวอย่าง:
seqcli signal import -i ./Exceptions.json
ตัวเลือก | คำอธิบาย |
---|---|
--merge | อัปเดตสัญญาณที่มี ID ที่ตรงกับข้อมูลที่นำเข้า ค่าเริ่มต้นคือการสร้างสัญญาณใหม่เสมอ |
-i , --input=VALUE | ไฟล์ที่จะนำเข้า; หากไม่ได้ระบุจะใช้ STDIN |
-o , --owner=VALUE | ID ของผู้ใช้ในการนำเข้าสัญญาณสำหรับ; โดยค่าเริ่มต้นสัญญาณที่ใช้ร่วมกันจะถูกนำเข้า |
-s , --server=VALUE | URL ของเซิร์ฟเวอร์ SEQ; โดยค่าเริ่มต้นจะใช้ค่าการกำหนดค่า connection.serverUrl |
-a , --apikey=VALUE | คีย์ API ที่จะใช้เมื่อเชื่อมต่อกับเซิร์ฟเวอร์ โดยค่าเริ่มต้นจะใช้ค่าการกำหนด connection.apiKey |
--profile=VALUE | โปรไฟล์การเชื่อมต่อที่จะใช้ โดยค่าเริ่มต้นจะใช้ค่า connection.serverUrl และ connection.apiKey config |
signal list
รายการสัญญาณที่มีอยู่
ตัวอย่าง:
seqcli signal list
ตัวเลือก | คำอธิบาย |
---|---|
-t , --title=VALUE | ชื่อของสัญญาณเป็นรายการ |
-i , --id=VALUE | ID ของสัญญาณเดียวในรายการ |
-o , --owner=VALUE | ID ของผู้ใช้เพื่อแสดงรายการสัญญาณสำหรับ; โดยค่าเริ่มต้นสัญญาณที่ใช้ร่วมกันคือ listd |
--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 config |
signal remove
ลบสัญญาณออกจากเซิร์ฟเวอร์
ตัวอย่าง:
seqcli signal remove -t 'Test Signal'
ตัวเลือก | คำอธิบาย |
---|---|
-t , --title=VALUE | ชื่อของสัญญาณที่จะลบ |
-i , --id=VALUE | ID ของสัญญาณเดียวที่จะลบ |
-o , --owner=VALUE | ID ของผู้ใช้เพื่อลบสัญญาณสำหรับ; โดยค่าเริ่มต้นสัญญาณที่ใช้ร่วมกันจะถูกลบออก |
-s , --server=VALUE | URL ของเซิร์ฟเวอร์ SEQ; โดยค่าเริ่มต้นจะใช้ค่าการกำหนดค่า connection.serverUrl |
-a , --apikey=VALUE | คีย์ API ที่จะใช้เมื่อเชื่อมต่อกับเซิร์ฟเวอร์ โดยค่าเริ่มต้นจะใช้ค่าการกำหนด connection.apiKey |
--profile=VALUE | โปรไฟล์การเชื่อมต่อที่จะใช้ โดยค่าเริ่มต้นจะใช้ค่า connection.serverUrl และ connection.apiKey config |
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 config |
tail
สตรีมบันทึกเหตุการณ์ที่ตรงกับตัวกรอง
ตัวเลือก | คำอธิบาย |
---|---|
-f , --filter=VALUE | ตัวกรองฝั่งเซิร์ฟเวอร์เสริมเพื่อใช้กับสตรีมตัวอย่างเช่น @Level = 'Error' |
--json | พิมพ์เอาต์พุตใน 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 config |
template export
เอนทิตีส่งออกไปยังไฟล์เทมเพลต
ตัวอย่าง:
seqcli template export -o ./Templates
ตัวเลือก | คำอธิบาย |
---|---|
-o , --output=VALUE | ไดเรกทอรีที่จะเขียนไฟล์เทมเพลต ไดเรกทอรีจะต้องมีอยู่; ไฟล์ที่มีอยู่ใด ๆ ที่มีชื่อที่ตรงกับเทมเพลตที่ส่งออกจะถูกเขียนทับ ค่าเริ่มต้น . |
-i , --include=VALUE | ID ของสัญญาณ, แดชบอร์ด, แบบสอบถามที่บันทึก, พื้นที่ทำงานหรือนโยบายการเก็บรักษาเพื่อส่งออก; อาร์กิวเมนต์นี้อาจระบุหลายครั้ง ค่าเริ่มต้นคือการส่งออกเอนทิตีที่ใช้ร่วมกันทั้งหมด |
-s , --server=VALUE | URL ของเซิร์ฟเวอร์ SEQ; โดยค่าเริ่มต้นจะใช้ค่าการกำหนดค่า connection.serverUrl |
-a , --apikey=VALUE | คีย์ API ที่จะใช้เมื่อเชื่อมต่อกับเซิร์ฟเวอร์ โดยค่าเริ่มต้นจะใช้ค่าการกำหนด connection.apiKey |
--profile=VALUE | โปรไฟล์การเชื่อมต่อที่จะใช้ โดยค่าเริ่มต้นจะใช้ค่า connection.serverUrl และ connection.apiKey config |
template import
นำเข้าเอนทิตีจากไฟล์เทมเพลต
ตัวอย่าง:
seqcli template import -i ./Templates
ตัวเลือก | คำอธิบาย |
---|---|
-i , --input=VALUE | ไดเรกทอรีที่จะอ่านชุดไฟล์ .template ; ค่าเริ่มต้น . |
--state=VALUE | พา ธ ของไฟล์ที่จะยังคงมีการแมปของชื่อเทมเพลตไปยัง ID ของเอนทิตีที่สร้างขึ้นบนเซิร์ฟเวอร์เป้าหมายหลีกเลี่ยงการทำซ้ำเมื่อนำเข้าหลายครั้ง โดยค่าเริ่มต้น 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 config |
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 config |
--json | พิมพ์เอาต์พุตใน JSON ที่กำหนดใหม่ (ค่าเริ่มต้นคือข้อความธรรมดา) |
--no-color | อย่าสีเอาต์พุตข้อความสี |
--force-color | บังคับให้มีการเปลี่ยนเส้นทางออกเป็นสี ANSI (เว้นแต่ --no-color )) |
user list
ผู้ใช้รายชื่อผู้ใช้
ตัวอย่าง:
seqcli user list
ตัวเลือก | คำอธิบาย |
---|---|
-n , --name=VALUE | ชื่อผู้ใช้ของผู้ใช้ในรายการ |
-i , --id=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 config |
user remove
ลบผู้ใช้ออกจากเซิร์ฟเวอร์
ตัวอย่าง:
seqcli user remove -n alice
ตัวเลือก | คำอธิบาย |
---|---|
-n , --name=VALUE | ชื่อผู้ใช้ของผู้ใช้ที่จะลบ |
-i , --id=VALUE | ID ของผู้ใช้รายเดียวที่จะลบ |
-s , --server=VALUE | URL ของเซิร์ฟเวอร์ SEQ; โดยค่าเริ่มต้นจะใช้ค่าการกำหนดค่า connection.serverUrl |
-a , --apikey=VALUE | คีย์ API ที่จะใช้เมื่อเชื่อมต่อกับเซิร์ฟเวอร์ โดยค่าเริ่มต้นจะใช้ค่าการกำหนด connection.apiKey |
--profile=VALUE | โปรไฟล์การเชื่อมต่อที่จะใช้ โดยค่าเริ่มต้นจะใช้ค่า connection.serverUrl และ connection.apiKey config |
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 config |
version
พิมพ์เวอร์ชันปฏิบัติการปัจจุบัน
workspace create
สร้างพื้นที่ทำงาน
ตัวอย่าง:
seqcli workspace create -t 'My Workspace' -c signal-314159 -c dashboard-628318
ตัวเลือก | คำอธิบาย |
---|---|
-t , --title=VALUE | ชื่อสำหรับพื้นที่ทำงาน |
--description=VALUE | คำอธิบายสำหรับพื้นที่ทำงาน |
-c , --content=VALUE | ID ของแดชบอร์ดสัญญาณหรือแบบสอบถามที่บันทึกไว้เพื่อรวมไว้ในพื้นที่ทำงาน |
--protected | ระบุว่าพื้นที่ทำงานสามารถแก้ไขได้โดยผู้ดูแลระบบเท่านั้น |
-s , --server=VALUE | URL ของเซิร์ฟเวอร์ SEQ; โดยค่าเริ่มต้นจะใช้ค่าการกำหนดค่า connection.serverUrl |
-a , --apikey=VALUE | คีย์ API ที่จะใช้เมื่อเชื่อมต่อกับเซิร์ฟเวอร์ โดยค่าเริ่มต้นจะใช้ค่าการกำหนด connection.apiKey |
--profile=VALUE | โปรไฟล์การเชื่อมต่อที่จะใช้ โดยค่าเริ่มต้นจะใช้ค่า connection.serverUrl และ connection.apiKey config |
--json | พิมพ์เอาต์พุตใน JSON ที่กำหนดใหม่ (ค่าเริ่มต้นคือข้อความธรรมดา) |
--no-color | อย่าสีเอาต์พุตข้อความสี |
--force-color | บังคับให้มีการเปลี่ยนเส้นทางออกเป็นสี ANSI (เว้นแต่ --no-color )) |
workspace list
รายการพื้นที่ทำงานที่มีอยู่
ตัวอย่าง:
seqcli workspace list
ตัวเลือก | คำอธิบาย |
---|---|
-t , --title=VALUE | ชื่อเรื่องของเวิร์กสเปซเพื่อแสดงรายการ |
-i , --id=VALUE | ID ของพื้นที่ทำงานเดียวในรายการ |
-o , --owner=VALUE | ID ของผู้ใช้ในรายการเวิร์กสเปซสำหรับ; โดยค่าเริ่มต้นพื้นที่ทำงานที่ใช้ร่วมกันคือ listd |
--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 config |
workspace remove
ลบพื้นที่ทำงานออกจากเซิร์ฟเวอร์
ตัวอย่าง:
seqcli workspace remove -t 'My Workspace'
ตัวเลือก | คำอธิบาย |
---|---|
-t , --title=VALUE | ชื่อของพื้นที่ทำงานเพื่อลบ |
-i , --id=VALUE | ID ของพื้นที่ทำงานเดียวเพื่อลบ |
-o , --owner=VALUE | ID ของผู้ใช้ในการลบพื้นที่ทำงานสำหรับ; โดยค่าเริ่มต้นพื้นที่ทำงานที่ใช้ร่วมกันจะถูกลบออก |
-s , --server=VALUE | URL ของเซิร์ฟเวอร์ SEQ; โดยค่าเริ่มต้นจะใช้ค่าการกำหนดค่า connection.serverUrl |
-a , --apikey=VALUE | คีย์ API ที่จะใช้เมื่อเชื่อมต่อกับเซิร์ฟเวอร์ โดยค่าเริ่มต้นจะใช้ค่าการกำหนด connection.apiKey |
--profile=VALUE | โปรไฟล์การเชื่อมต่อที่จะใช้ โดยค่าเริ่มต้นจะใช้ค่า connection.serverUrl และ connection.apiKey config |
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 config |
คำสั่ง 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}
ทั้งชื่อและตัวจับคู่เป็นทางเลือก แต่ต้องระบุอย่างใดอย่างหนึ่งหรืออื่น ๆ ดังนั้น {@t:timestamp}
ระบุชื่อของ @t
และค่า timestamp
, {IPAddress}
ระบุชื่อเท่านั้นและ {:n}
ค่าเท่านั้น (ในกรณีนี้ตัวจับคู่ใหม่ในตัว)
ชื่อ คือชื่อคุณสมบัติที่จะสกัด มีชื่ออสังหาริมทรัพย์ในตัวสี่ชื่อที่ได้รับการจัดการพิเศษ:
@t
- การประทับเวลาของกิจกรรม@m
- ข้อความข้อความที่เกี่ยวข้องกับเหตุการณ์@l
- ระดับเหตุการณ์@x
- ข้อยกเว้นหรือ backtrace ที่เกี่ยวข้องกับเหตุการณ์ ชื่อคุณสมบัติอื่น ๆ จะถูกแนบไปกับ payload ของเหตุการณ์ดังนั้น {Elapsed:dec}
จะแยกคุณสมบัติที่เรียกว่า Elapsed
โดยใช้ dec
DECIMAL MATHER
นิพจน์การจับคู่ที่ไม่มีชื่อจะถูกใช้จากอินพุต แต่จะไม่เพิ่มลงในเพย์โหลดของเหตุการณ์
Matchers ระบุชิ้นส่วนของเหตุการณ์อินพุต
จำเป็นต้องมีการจับคู่ที่แตกต่างกันเพื่อให้ชิ้นส่วนของข้อความเช่น 200OK
สามารถแยกออกเป็นคุณสมบัติแยกต่างหากเช่น {StatusCode:nat}{Status:alpha}
ที่นี่ตัวจับคู่ nat
(Natural Number) ยังบีบบังคับผลลัพธ์เป็นค่าตัวเลขเพื่อให้มันถูกแนบกับเหตุการณ์ payload ตัวเลขเป็น 200
แทนที่จะเป็นข้อความ "200"
มีการจับคู่สามประเภท:
alpha
และ nat
เป็นตัวจับคู่ใน ตัว*
, **
และ so-on เป็นรายการจับคู่ เนื้อหาที่ไม่ใช่ทรี สิ่งเหล่านี้จะตรงกับข้อความใด ๆ จนกระทั่งองค์ประกอบรูปแบบถัดไปตรงกับ ( *
), สององค์ประกอบถัดไปตรงกับและ so-on เราเห็นสิ่งนี้ดำเนินการกับองค์ประกอบ {@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 | DateTime ในรูปแบบการบันทึกไฟล์ Serilog เริ่มต้น | 2020-01-28 13:50:01.123 +10:00 |
syslogdt | DateTime ในรูปแบบ syslog | Dec 8 09:12:13 |
t | อักขระแท็บเดียว | |
timestamp | dateTime ในรูปแบบใด ๆ ที่ได้รับการยอมรับ | |
token | ลำดับของอักขระที่ไม่ใช่ไวท์สเปซใด ๆ | 1+x$3 |
trailingident | เนื้อหาหลายเส้นที่มีสายต่อท้าย | |
unixdt | DateTime ในรูปแบบเวลา UNIX ที่รองรับวินาที (10 หลัก) หรือมิลลิวินาที (12 หลัก) | 1608694199.999 |
w3cdt | คู่วันที่/วันที่บันทึก W3C | 2019-04-02 05:18:01 |
รูปแบบการสกัดถูกประมวลผลจากซ้ายไปขวา เมื่อพบรูปแบบการไม่จับคู่ครั้งแรกการสกัดจะหยุดลง ข้อความที่เหลือใด ๆ ที่ไม่สามารถจับคู่จะถูกแนบกับเหตุการณ์ผลลัพธ์ในคุณสมบัติ @unmatched
เหตุการณ์หลายบรรทัดได้รับการจัดการโดยมองหาบรรทัดที่เริ่มต้นด้วยองค์ประกอบแรกของรูปแบบการสกัดที่จะใช้ วิธีนี้ใช้งานได้ดีหากบรรทัดแรกของแต่ละเหตุการณ์เริ่มต้นด้วยสิ่งที่ไม่คลุมเครือเช่นการประทับเวลา iso8601dt
; หากเส้นเริ่มต้นด้วยไวยากรณ์ที่เฉพาะเจาะจงน้อยกว่าองค์ประกอบแรกของรูปแบบการสกัดอาจถูกจัดกลุ่มเพื่อระบุจุดเริ่มต้นของเหตุการณ์ที่แม่นยำยิ่งขึ้น:
{:=[{@t} {@l}]} {@m:*}
นี่คือข้อความที่แท้จริง [
, โทเค็นการประทับเวลา, พื้นที่ที่อยู่ติดกัน
ระดับและการปิด ]
ล้วนถูกจัดกลุ่มเพื่อให้เป็นองค์ประกอบรูปแบบตรรกะเดียวเพื่อระบุจุดเริ่มต้นของเหตุการณ์
เมื่อบันทึกจะถูกสตรีมลงใน seqcli ingest
แบบเรียลไทม์จะมีการใช้กำหนดเวลา 10 มิลลิวินาทีซึ่งจะต้องได้รับกำหนดเวลาใด ๆ
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} "
ตัวอย่างนี้กินไฟล์บันทึกในรูปแบบ:
# 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
และ Modern Shells ที่มีการสนับสนุน JSON พื้นเมืองเช่น PowerShell:
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...