seqcli
Die Seq-Client-Befehlszeilen-App. Unterstützt Protokollierung ( seqcli log
), Suche ( search
), Tailing ( tail
), Abfragen ( query
) und JSON- oder Klartext-Protokolldateiaufnahme ( ingest
) und vieles mehr.
Das Seq-Installationsprogramm für Windows enthält seqcli
. Andernfalls laden Sie die Version für Ihr Betriebssystem herunter. Wenn Sie dotnet
installiert haben, kann seqcli
auch als globales Tool installiert werden mit:
dotnet tool install --global seqcli
Führen Sie Folgendes aus, um eine Standard-Server-URL und einen API-Schlüssel festzulegen:
seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key
Der API-Schlüssel wird in Ihrer SeqCli.json
-Konfigurationsdatei gespeichert. unter Windows erfolgt die Verschlüsselung per DPAPI; Unter Mac/Linux wird der Schlüssel derzeit im Klartext gespeichert. Alternativ zum Speichern des API-Schlüssels in der Konfiguration kann er über das Argument --apikey=
an jeden Befehl übergeben werden.
seqcli
ist auch als Docker-Container unter datalust/seqcli
verfügbar:
docker run --rm datalust/seqcli:latest []
Um eine Verbindung zu Seq in einem Docker-Container auf dem lokalen Computer herzustellen, verwenden Sie die IP-Adresse des Computers (nicht localhost) oder geben Sie das Docker-Host-Netzwerk mit --net host
an.
Verwenden Sie Docker-Netzwerke und -Volumes, um seqcli
innerhalb seines Containers lokalen Dateien und andere Container zugänglich zu machen.
Jeder Einstellungswert kann zur Laufzeit überschrieben werden, indem eine Umgebungsvariable der Form SEQCLI_
angegeben wird, die ein Element für jedes gepunktete Segment des Einstellungsnamens enthält, getrennt durch Unterstriche.
Beispielsweise kann die Einstellung connection.serverUrl
mit der Variablen SEQCLI_CONNECTION_SERVERURL
überschrieben werden.
Wenn Sie die Seq-Einrichtung automatisieren, verfügen Sie wahrscheinlich noch nicht über einen API-Schlüssel, den seqcli
verwenden kann. Während der anfänglichen Seq-Serverkonfiguration können Sie firstRun.adminUsername
und firstRun.adminPasswordHash
(oder die entsprechenden Umgebungsvariablen SEQ_FIRSTRUN_ADMINUSERNAME
und SEQ_FIRSTRUN_ADMINPASSWORDHASH
) angeben, um einen anfänglichen Benutzernamen und ein Kennwort für das Administratorkonto festzulegen. Sie können damit einen API-Schlüssel erstellen und dann das API-Schlüsseltoken mit den verbleibenden seqcli
-Befehlen verwenden.
Der Befehl seqcli apikey create
akzeptiert --connect-username
und --connect-password-stdin
und gibt das neue API-Schlüsseltoken auf STDOUT
aus (die PowerShell-Syntax wird unten verwendet):
$user = "admin"
$pw = "thepassword"
$token = (
echo $pw |
seqcli apikey create `
-t CLI `
--permissions="Read,Write,Project,Organization,System" `
--connect-username $user --connect-password-stdin
)
Siehe CONTRIBUTING.md
.
Bei der Verbindung mit einem API-Schlüssel werden die zulässigen Vorgänge durch die diesem API-Schlüssel zugewiesenen Berechtigungen bestimmt.
Um die für einen Befehl erforderliche Berechtigung zu ermitteln, überprüfen Sie die Spalte „Berechtigungsbedarf“ des entsprechenden Server-API-Vorgangs. Beispielsweise verwendet der Befehl apikey create
den POST api/apikeys
, der die Write
erfordert.
Alle seqcli
-Befehle folgen demselben Muster:
seqcli []
Die vollständige Liste der unterstützten Befehle kann angezeigt werden, indem Sie Folgendes ausführen:
seqcli help
Um Nutzungsinformationen für einen bestimmten Befehl anzuzeigen, führen Sie seqcli help
aus, zum Beispiel:
seqcli help apikey create
Dies funktioniert auch für Befehlsgruppen; Führen Sie Folgendes aus, um alle apikey
-Unterbefehle aufzulisten:
seqcli help apikey
apikey
apikey create
– Erstellen Sie einen API-Schlüssel für die Automatisierung oder Aufnahme.apikey list
– Verfügbare API-Schlüssel auflisten.apikey remove
– Einen API-Schlüssel vom Server entfernen.apikey update
– Aktualisieren Sie einen vorhandenen API-Schlüssel.app
app define
– Generieren Sie eine App-Definition für ein .NET [SeqApp]
-Plug-in.app install
– Installieren Sie ein App-Paket.app list
– Installierte App-Pakete auflisten.app run
– Hosten Sie ein .NET [SeqApp]
-Plug-in.app uninstall
– Deinstallieren Sie ein App-Paket.app update
– Aktualisieren Sie ein installiertes App-Paket.appinstance
appinstance create
– Erstellen Sie eine Instanz einer installierten App.appinstance list
– Instanzen installierter Apps auflisten.appinstance remove
– Entfernen einer App-Instanz vom Server.appinstance update
– Aktualisieren Sie eine vorhandene App-Instanz.bench
– Abfrageleistung messen.config
– Felder in der Datei SeqCli.json
anzeigen und festlegen; Ohne Argumente ausführen, um alle Felder aufzulisten.dashboard
dashboard list
– Dashboards auflisten.dashboard remove
– Entfernen Sie ein Dashboard vom Server.dashboard render
– Erstellt einen CSV- oder JSON-Ergebnissatz aus einem Dashboard-Diagramm.expressionindex
expressionindex create
– Erstellen Sie einen Ausdrucksindex.expressionindex list
– Ausdrucksindizes auflisten.expressionindex remove
– Einen Ausdrucksindex vom Server entfernen.feed
feed create
– Erstellen Sie einen NuGet-Feed.feed list
– NuGet-Feeds auflisten.feed remove
– Entfernen Sie einen NuGet-Feed vom Server.feed update
– Aktualisieren eines vorhandenen NuGet-Feeds.help
– Informationen zu verfügbaren Befehlen anzeigen.index
index list
– Indizes auflisten.index suppress
– Unterdrückt einen Index.ingest
– Protokollereignisse aus einer Datei oder STDIN
senden.license apply
– Wenden Sie eine Lizenz auf den Seq-Server an.log
– Senden Sie ein strukturiertes Protokollereignis an den Server.node
node demote
– Beginnen Sie mit der Herabstufung des aktuellen Führungsknotens.node health
– Prüfen Sie den /health
Endpunkt eines Seq-Knotens und geben Sie den zurückgegebenen HTTP-Statuscode aus, oder „Unerreichbar“, wenn der Endpunkt nicht abgefragt werden konnte.node list
– Knoten im Seq-Cluster auflisten.print
– Ereignisse im CLEF/JSON-Format aus einer Datei oder STDIN
hübsch drucken.profile
profile create
– Erstellen oder ersetzen Sie ein Verbindungsprofil.profile list
– Verbindungsprofile auflisten.profile remove
– Ein Verbindungsprofil entfernen.query
– Führen Sie eine SQL-Abfrage aus und erhalten Sie Ergebnisse im CSV-Format.retention
retention create
– Erstellen Sie eine Aufbewahrungsrichtlinie.retention list
– Aufbewahrungsrichtlinien auflisten.retention remove
– Entfernen Sie eine Aufbewahrungsrichtlinie vom Server.retention update
– Aktualisieren Sie eine vorhandene Aufbewahrungsrichtlinie.sample
sample ingest
– Beispielereignisse in einer Seq-Instanz protokollieren.sample setup
– Konfigurieren Sie eine Seq-Instanz mit Beispiel-Dashboards, Signalen, Benutzern usw.search
– Protokollereignisse abrufen, die einem bestimmten Filter entsprechen.setting
setting clear
– Löscht eine zur Laufzeit konfigurierbare Servereinstellung.setting names
– Drucken Sie die Namen aller unterstützten Einstellungen.setting set
– Ändern Sie eine zur Laufzeit konfigurierbare Servereinstellung.setting show
– Gibt den aktuellen Wert einer zur Laufzeit konfigurierbaren Servereinstellung aus.signal
signal create
– Ein Signal erstellen.signal import
– Importieren Sie Signale im durch Zeilenumbrüche getrennten JSON-Format.signal list
– Verfügbare Signale auflisten.signal remove
– Ein Signal vom Server entfernen.signal update
– Ein vorhandenes Signal aktualisieren.tail
– Streamen Sie Protokollereignisse, die einem Filter entsprechen.template
template export
– Entitäten in Vorlagendateien exportieren.template import
– Importieren Sie Entitäten aus Vorlagendateien.user
user create
– Erstellen Sie einen Benutzer.user list
– Benutzer auflisten.user remove
– Einen Benutzer vom Server entfernen.user update
– Aktualisieren Sie einen vorhandenen Benutzer.version
– Drucken Sie die aktuelle ausführbare Version.workspace
workspace create
– Erstellen Sie einen Arbeitsbereich.workspace list
– Verfügbare Arbeitsbereiche auflisten.workspace remove
– Einen Arbeitsbereich vom Server entfernen.workspace update
– Aktualisieren Sie einen vorhandenen Arbeitsbereich.apikey create
Erstellen Sie einen API-Schlüssel für die Automatisierung oder Aufnahme.
Beispiel:
seqcli apikey create -t 'Test API Key' -p Environment=Test
Option | Beschreibung |
---|---|
-t , --title=VALUE | Ein Titel für den API-Schlüssel |
--token=VALUE | Ein vorab zugewiesenes API-Schlüsseltoken; Standardmäßig wird ein neues Token generiert und auf STDOUT geschrieben |
-p , --property=NAME=VALUE | Geben Sie Namens-/Werteigenschaften an, z. B. -p Customer=C123 -p Environment=Production |
--filter=VALUE | Ein Filter, der auf eingehende Ereignisse angewendet werden soll |
--minimum-level=VALUE | Die zu akzeptierende Mindestereignisstufe/-schwere; Standardmäßig werden alle Ereignisse akzeptiert |
--use-server-timestamps | Vom Client bereitgestellte Zeitstempel verwerfen und Serveruhrwerte verwenden |
--permissions=VALUE | Eine durch Kommas getrennte Liste von Berechtigungen, die an den API-Schlüssel delegiert werden sollen; Gültige Berechtigungen sind Ingest (Standard), Read , Write , Project und System |
--connect-username=VALUE | Ein Benutzername zum Herstellen einer Verbindung, der vor allem beim Einrichten des ersten API-Schlüssels nützlich ist. Server mit einem „Individual“-Abonnement erlauben mit dieser Option nur eine gleichzeitige Anfrage |
--connect-password=VALUE | Wenn connect-username angegeben wird, ein entsprechendes Passwort |
--connect-password-stdin | Wenn connect-username angegeben ist, lesen Sie das entsprechende Passwort aus STDIN |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
apikey list
Verfügbare API-Schlüssel auflisten.
Beispiel:
seqcli apikey list
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel der aufzulistenden API-Schlüssel |
-i , --id=VALUE | Die ID eines einzelnen aufzulistenden API-Schlüssels |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
apikey remove
Entfernen Sie einen API-Schlüssel vom Server.
Beispiel:
seqcli apikey remove -t 'Test API Key'
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel des/der zu entfernenden API-Schlüssel(s). |
-i , --id=VALUE | Die ID eines einzelnen API-Schlüssels, der entfernt werden soll |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
apikey update
Aktualisieren Sie einen vorhandenen API-Schlüssel.
Beispiel:
seqcli apikey update --json '{...}'
Option | Beschreibung |
---|---|
--json=VALUE | Der aktualisierte API-Schlüssel im JSON-Format; Dies kann mit seqcli apikey list --json erstellt werden |
--json-stdin | Lesen Sie den aktualisierten API-Schlüssel als JSON von STDIN |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
app define
Generieren Sie eine App-Definition für ein .NET [SeqApp]
-Plug-in.
Beispiel:
seqcli app define -d "./bin/Debug/netstandard2.2"
Option | Beschreibung |
---|---|
-d , --directory=VALUE | Das Verzeichnis, das .NET Standard-Assemblys enthält; Standardmäßig wird das aktuelle Verzeichnis verwendet |
--type=VALUE | Der [SeqApp]-Plug-in-Typname; Standardmäßig werden Assemblys nach einem einzelnen Typ durchsucht, der mit diesem Attribut markiert ist |
--indented | Formatieren Sie die Definition über mehrere Zeilen mit Einrückung |
app install
Installieren Sie ein App-Paket.
Beispiel:
seqcli app install --package-id 'Seq.App.JsonArchive'
Option | Beschreibung |
---|---|
--package-id=VALUE | Die Paket-ID der zu installierenden App |
--version=VALUE | Die zu installierende Paketversion; Standardmäßig wird die neueste Version installiert |
--feed-id=VALUE | Die ID des NuGet-Feeds, von dem aus das Paket installiert werden soll; kann weggelassen werden, wenn nur ein Feed konfiguriert ist |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
app list
Installierte App-Pakete auflisten.
Beispiel:
seqcli app list
Option | Beschreibung |
---|---|
--package-id=VALUE | Die Paket-ID der aufzulistenden App(s). |
-i , --id=VALUE | Die ID einer einzelnen aufzulistenden App |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
app run
Hosten Sie ein .NET [SeqApp]
-Plug-in.
Beispiel:
seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]
Option | Beschreibung |
---|---|
-d , --directory=VALUE | Das Verzeichnis, das .NET Standard-Assemblys enthält; Standardmäßig wird das aktuelle Verzeichnis verwendet |
--type=VALUE | Der [SeqApp]-Plug-in-Typname; Standardmäßig werden Assemblys nach einem einzelnen Typ durchsucht, der mit diesem Attribut markiert ist |
-p , --property=NAME=VALUE | Geben Sie Namens-/Werteinstellungen für die App an, z. B. -p [email protected] -p Subject="Alert!" |
--storage=VALUE | Ein Verzeichnis, in dem App-spezifische Daten gespeichert werden können; Standardmäßig wird das aktuelle Verzeichnis verwendet |
-s , --server=VALUE | Die URL des Seq-Servers, die nur für die App-Konfiguration verwendet wird (es wird keine Verbindung zum Server hergestellt); Standardmäßig wird der Wert connection.serverUrl verwendet |
--server-instance=VALUE | Der Instanzname des Seq-Servers, der nur für die App-Konfiguration verwendet wird; Standardmäßig ist kein Instanzname angegeben |
-t , --title=VALUE | Der App-Instanztitel, der nur für die App-Konfiguration verwendet wird; Standardmäßig wird ein Platzhaltertitel verwendet. |
--id=VALUE | Die App-Instanz-ID, die nur für die App-Konfiguration verwendet wird; Standardmäßig wird eine Platzhalter-ID verwendet. |
--read-env | App-Konfiguration und -Einstellungen aus Umgebungsvariablen lesen, wie in https://docs.datalust.co/docs/seq-apps-in-other-Language angegeben; ignoriert alle Optionen außer --directory und --type |
app uninstall
Deinstallieren Sie ein App-Paket.
Beispiel:
seqcli app uninstall --package-id 'Seq.App.JsonArchive'
Option | Beschreibung |
---|---|
--package-id=VALUE | Die Paket-ID des zu deinstallierenden App-Pakets |
-i , --id=VALUE | Die ID eines einzelnen App-Pakets, das deinstalliert werden soll |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
app update
Aktualisieren Sie ein installiertes App-Paket.
Beispiel:
seqcli app update -n 'HTML Email'
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID einer einzelnen installierten App, die aktualisiert werden soll |
-n , --name=VALUE | Der Name der installierten App, die aktualisiert werden soll |
--all | Aktualisieren Sie alle installierten Apps. nicht kompatibel mit -i oder -n |
--version=VALUE | Die Paketversion, auf die aktualisiert werden soll; Standardmäßig wird im zugehörigen Feed auf die neueste Version aktualisiert |
--force | Aktualisieren Sie die App, auch wenn die Zielversion bereits installiert ist |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
appinstance create
Erstellen Sie eine Instanz einer installierten App.
Beispiel:
seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]
Option | Beschreibung |
---|---|
-t , --title=VALUE | Ein Titel für die App-Instanz |
--app=VALUE | Die ID des installierten App-Pakets, das instanziiert werden soll |
-p , --property=NAME=VALUE | Geben Sie Namens-/Werteinstellungen für die App an, z. B. -p [email protected] -p Subject="Alert!" |
--stream[=VALUE] | Streamen Sie eingehende Ereignisse während der Aufnahme an diese App-Instanz. Akzeptiert optional einen Signalausdruck, der einschränkt, welche Ereignisse gestreamt werden sollen, zum Beispiel signal-1,signal-2 |
--overridable=VALUE | Geben Sie Einstellungsnamen an, die von Benutzern beim Aufrufen der App überschrieben werden können |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
appinstance list
Listen Sie Instanzen installierter Apps auf.
Beispiel:
seqcli appinstance list
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel der aufzulistenden App-Instanz(en). |
-i , --id=VALUE | Die ID einer einzelnen aufzulistenden App-Instanz |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
appinstance remove
Entfernen Sie eine App-Instanz vom Server.
Beispiel:
seqcli appinstance remove -t 'Email Ops'
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel der zu entfernenden App-Instanz(en). |
-i , --id=VALUE | Die ID einer einzelnen App-Instanz, die entfernt werden soll |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
appinstance update
Aktualisieren Sie eine vorhandene App-Instanz.
Beispiel:
seqcli appinstance update --json '{...}'
Option | Beschreibung |
---|---|
--json=VALUE | Die aktualisierte App-Instanz im JSON-Format; Dies kann mit seqcli appinstance list --json erstellt werden |
--json-stdin | Lesen Sie die aktualisierte App-Instanz als JSON von STDIN |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
bench
Messen Sie die Abfrageleistung.
Option | Beschreibung |
---|---|
-r , --runs=VALUE | Die Anzahl der auszuführenden Läufe; Der Standardwert ist 10 |
-c , --cases=VALUE | Eine JSON-Datei, die die auszuführenden Fälle enthält. Standardmäßig wird ein Standardsatz von Fällen verwendet. |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--start=VALUE | ISO 8601-Datum/Uhrzeit für die Abfrage |
--end=VALUE | ISO 8601-Datum/Uhrzeit für die Abfrage |
--reporting-server=VALUE | Die Adresse eines Seq-Servers, an den Bench-Ergebnisse gesendet werden sollen |
--reporting-apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Berichtsserver verwendet werden soll |
--description=VALUE | Optionale Beschreibung des Prüfstandtestlaufs |
--with-ingestion | Sollte der Benchmark das Senden von Ereignissen an Seq |
--with-queries | Sollte der Benchmark die Abfrage von Seq |
config
Felder in der Datei SeqCli.json
anzeigen und festlegen; Ohne Argumente ausführen, um alle Felder aufzulisten.
Option | Beschreibung |
---|---|
-k , --key=VALUE | Das Feld, zum Beispiel connection.serverUrl |
-v , --value=VALUE | Der Feldwert; Wenn nicht angegeben, gibt der Befehl den aktuellen Wert aus |
-c , --clear | Leeren Sie das Feld |
dashboard list
Dashboards auflisten.
Beispiel:
seqcli dashboard list
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel der aufzulistenden Dashboards |
-i , --id=VALUE | Die ID eines einzelnen aufzulistenden Dashboards |
-o , --owner=VALUE | Die ID des Benutzers, für den Dashboards aufgelistet werden sollen; Standardmäßig werden freigegebene Dashboards aufgelistet |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
dashboard remove
Entfernen Sie ein Dashboard vom Server.
Beispiel:
seqcli dashboard remove -i dashboard-159
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel der zu entfernenden Dashboards |
-i , --id=VALUE | Die ID eines einzelnen zu entfernenden Dashboards |
-o , --owner=VALUE | Die ID des Benutzers, für den Dashboards entfernt werden sollen; Standardmäßig werden freigegebene Dashboards entfernt |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
dashboard render
Erstellen Sie einen CSV- oder JSON-Ergebnissatz aus einem Dashboard-Diagramm.
Beispiel:
seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID eines einzelnen zu rendernden Dashboards |
-c , --chart=VALUE | Der Titel eines Diagramms im Dashboard, das gerendert werden soll |
--last=VALUE | Eine Dauer, über die das Diagramm gerendert werden soll, z. B. 7d ; dies wird an einer Intervallgrenze ausgerichtet; entweder --last oder --start und --end müssen angegeben werden |
--by=VALUE | Das Zeitintervall für die Diagrammdaten als Dauer, z. B. 1h |
--start=VALUE | ISO 8601-Datum/Uhrzeit für die Abfrage |
--end=VALUE | ISO 8601-Datum/Uhrzeit für die Abfrage |
--signal=VALUE | Ein Signalausdruck oder eine Liste sich überschneidender Signal-IDs, die angewendet werden sollen, zum Beispiel signal-1,signal-2 |
--timeout=VALUE | Das Ausführungszeitlimit in Millisekunden |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
expressionindex create
Erstellen Sie einen Ausdrucksindex.
Beispiel:
seqcli expressionindex create --expression "ServerName"
Option | Beschreibung |
---|---|
-e , --expression=VALUE | Der zu indizierende Ausdruck |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
expressionindex list
Ausdrucksindizes auflisten.
Beispiel:
seqcli expressionindex list
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID eines einzelnen aufzulistenden Ausdrucksindex |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
expressionindex remove
Entfernen Sie einen Ausdrucksindex vom Server.
Beispiel:
seqcli expressionindex -i expressionindex-2529
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID eines zu entfernenden Ausdrucksindex |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
feed create
Erstellen Sie einen NuGet-Feed.
Beispiel:
seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin
Option | Beschreibung |
---|---|
-n , --name=VALUE | Ein eindeutiger Name für den Feed |
-l , --location=VALUE | Der Feed-Standort; Dies kann eine NuGet v2- oder v3-Feed-URL oder ein lokaler Dateisystempfad auf dem Seq-Server sein |
-u , --username=VALUE | Der Benutzername Seq sollte beim Herstellen einer Verbindung zum Feed angegeben werden, wenn eine Authentifizierung erforderlich ist |
-p , --password=VALUE | Ein Feed-Passwort, falls eine Authentifizierung erforderlich ist; Beachten Sie, dass --password-stdin sicherer ist |
--password-stdin | Lesen Sie das Feed-Passwort von STDIN |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
feed list
NuGet-Feeds auflisten.
Beispiel:
seqcli feed list
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Name des aufzulistenden Feeds |
-i , --id=VALUE | Die ID eines einzelnen aufzulistenden Feeds |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
feed remove
Entfernen Sie einen NuGet-Feed vom Server.
Beispiel:
seqcli feed remove -n CI
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Name des zu entfernenden Feeds |
-i , --id=VALUE | Die ID eines einzelnen Feeds, der entfernt werden soll |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
feed update
Aktualisieren Sie einen vorhandenen NuGet-Feed.
Beispiel:
seqcli feed update --json '{...}'
Option | Beschreibung |
---|---|
--json=VALUE | Der aktualisierte NuGet-Feed im JSON-Format; Dies kann mit seqcli feed list --json erstellt werden |
--json-stdin | Lesen Sie den aktualisierten NuGet-Feed als JSON von STDIN |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
help
Informationen zu verfügbaren Befehlen anzeigen.
Beispiel:
seqcli help search
Option | Beschreibung |
---|---|
-m , --markdown | Generieren Sie einen Abschlag zur Verwendung in der Dokumentation |
index list
Listenindizes.
Beispiel:
seqcli index list
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID eines einzelnen aufzulistenden Index |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
index suppress
Unterdrücken Sie einen Index.
Beispiel:
seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID eines zu unterdrückenden Index |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
ingest
Senden Sie Protokollereignisse aus einer Datei oder STDIN
.
Beispiel:
seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test
Option | Beschreibung |
---|---|
-i , --input=VALUE | Zu erfassende Datei(en), einschließlich des Platzhalters * ; Wenn nicht angegeben, wird STDIN verwendet |
--invalid-data=VALUE | Geben Sie an, wie mit ungültigen Daten umgegangen wird: fail (Standard) oder ignore |
-p , --property=NAME=VALUE | Geben Sie Namens-/Werteigenschaften an, z. B. -p Customer=C123 -p Environment=Production |
-x , --extract=VALUE | Ein Extraktionsmuster zur Anwendung auf Nur-Text-Protokolle (wird ignoriert, wenn --json angegeben ist) |
--json | Lesen Sie die Ereignisse als JSON (die Standardeinstellung geht von reinem Text aus) |
-f , --filter=VALUE | Filterausdruck zur Auswahl einer Teilmenge von Ereignissen |
-m , --message=VALUE | Eine Nachricht, die den aufgenommenen Ereignissen zugeordnet werden soll; Die https://messagetemplates.org-Syntax wird unterstützt |
-l , --level=VALUE | Der Grad oder Schweregrad, der den aufgenommenen Ereignissen zugeordnet werden soll; Dadurch werden alle in den Ereignissen selbst vorhandenen Ebeneninformationen überschrieben |
--send-failure=VALUE | Geben Sie an, wie Verbindungsfehler gehandhabt werden: fail (Standard), retry “, continue “ oder ignore |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
--batch-size=VALUE | Die maximale Anzahl von Ereignissen, die in jeder Anfrage an den Aufnahmeendpunkt gesendet werden sollen; Wenn nichts angegeben wird, wird ein Wert von 100 verwendet |
license apply
Wenden Sie eine Lizenz auf den Seq-Server an.
Beispiel:
seqcli license apply --certificate="license.txt"
Option | Beschreibung |
---|---|
-c , --certificate=VALUE | Zertifikatsdatei; Die Datei muss UTF-8-Text sein |
--certificate-stdin | Lesen Sie das Lizenzzertifikat von STDIN |
--automatically-refresh | Wenn es sich bei der Lizenz um ein Abonnement handelt, überprüfen Sie regelmäßig datalust.co und aktualisieren Sie das Zertifikat automatisch, wenn das Abonnement geändert oder erneuert wird |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
log
Senden Sie ein strukturiertes Protokollereignis an den Server.
Beispiel:
seqcli log -m 'Hello, {Name}!' -p Name=World -p App=Test
Option | Beschreibung |
---|---|
-m , --message=VALUE | Eine Nachricht, die dem Ereignis zugeordnet werden soll (standardmäßig wird keine Nachricht gesendet); Die https://messagetemplates.org-Syntax wird unterstützt |
-l , --level=VALUE | Die Stufe oder der Schweregrad des Ereignisses (der Standardwert ist Information ). |
-t , --timestamp=VALUE | Der Ereigniszeitstempel als ISO-8601 (der aktuelle UTC-Zeitstempel wird standardmäßig verwendet) |
-x , --exception=VALUE | Zusätzliche zu sendende Ausnahme- oder Fehlerinformationen, falls vorhanden |
-p , --property=NAME=VALUE | Geben Sie Namens-/Werteigenschaften an, z. B. -p Customer=C123 -p Environment=Production |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
node demote
Beginnen Sie mit der Herabstufung des aktuellen Führungsknotens.
Beispiel:
seqcli node demote --verbose --wait
Option | Beschreibung |
---|---|
--wait | Warten Sie, bis der Anführer herabgestuft wurde, bevor Sie den Raum verlassen |
-y , --confirm | Antworten Sie mit „Ja“, wenn Sie zum Fortfahren aufgefordert werden |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
node health
Prüfen Sie den /health
Endpunkt eines Seq-Knotens und geben Sie den zurückgegebenen HTTP-Statuscode oder „Unerreichbar“ aus, wenn der Endpunkt nicht abgefragt werden konnte.
Beispiel:
seqcli node health -s https://seq-2.example.com
Option | Beschreibung |
---|---|
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
node list
Knoten im Seq-Cluster auflisten.
Beispiel:
seqcli node list --json
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Name des aufzulistenden Clusterknotens |
-i , --id=VALUE | Die ID eines einzelnen aufzulistenden Clusterknotens |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird der Konfigurationswert connection.serverUrl verwendet |
-a , --apikey=VALUE | Der API-Schlüssel, der beim Herstellen einer Verbindung zum Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die Konfigurationswerte connection.serverUrl und connection.apiKey verwendet |
print
Pretty-Print-Ereignisse im CLEF/JSON-Format aus einer Datei oder STDIN
.
Beispiel:
seqcli print -i log-20201028.clef
Option | Beschreibung |
---|---|
-i , --input=VALUE | Zu lesende CLEF-Datei, einschließlich des Platzhalters * ; Wenn nicht angegeben, wird STDIN verwendet |
-f , --filter=VALUE | Filterausdruck zur Auswahl einer Teilmenge von Ereignissen |
--template=VALUE | Geben Sie eine Ausgabevorlage an, um die Nur-Text-Formatierung zu steuern |
--invalid-data=VALUE | Geben Sie an, wie mit ungültigen Daten umgegangen wird: fail (Standard) oder ignore |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
profile create
Erstellen oder ersetzen Sie ein Verbindungsprofil.
Beispiel:
seqcli profile create -n Production -s https://seq.example.com -a th15ISanAPIk3y
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Name des Verbindungsprofils |
-s , --server=VALUE | Die URL des Seq-Servers |
-a , --apikey=VALUE | Der API-Schlüssel, der bei Bedarf beim Herstellen einer Verbindung zum Server verwendet werden soll |
profile list
Verbindungsprofile auflisten.
Beispiel:
seqcli profile list
profile remove
Entfernen Sie ein Verbindungsprofil.
Beispiel:
seqcli profile remove -n Production
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Name des zu entfernenden Verbindungsprofils |
query
Führen Sie eine SQL-Abfrage aus und erhalten Sie Ergebnisse im CSV-Format.
Beispiel:
seqcli query -q "select count(*) from stream group by @Level" --start="2018-02-28T13:00Z"
Option | Beschreibung |
---|---|
-q , --query=VALUE | Die auszuführende Abfrage |
--start=VALUE | ISO 8601-Datum/Uhrzeit für die Abfrage |
--end=VALUE | ISO 8601-Datum/Uhrzeit für die Abfrage |
--signal=VALUE | Ein Signalausdruck oder eine Liste sich überschneidender Signal-IDs, die angewendet werden sollen, zum Beispiel signal-1,signal-2 |
--timeout=VALUE | Das Ausführungszeitlimit in Millisekunden |
--json | Druckausgabe im durch Zeilenumbrüche getrennten JSON (Standard ist Nur-Text) |
--no-color | Färben Sie die Textausgabe nicht ein |
--force-color | Umgeleitete Ausgabe mit ANSI-Farbe erzwingen (sofern nicht auch --no-color angegeben ist) |
-s , --server=VALUE | Die URL des Seq-Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
retention create
Erstellen Sie eine Aufbewahrungsrichtlinie.
Beispiel:
seqcli retention create --after 30d --delete-all-events
Option | Beschreibung |
---|---|
--after=VALUE | Eine Dauer, nach der die Richtlinie Ereignisse löscht, z. B. 7d |
--delete-all-events | Die Richtlinie sollte alle Ereignisse löschen (derzeit die einzige unterstützte Option) |
--delete=VALUE | Stream eingehende Ereignisse zu dieser App -Instanz, sobald sie aufgenommen werden; Akzeptiert optional einen Signalausdruck, der begrenzt ist, welche Ereignisse gestreamt werden sollen |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
retention list
Listenerhaltepolitik auflisten.
Beispiel:
seqcli retention list
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID einer einzelnen Aufbewahrungsrichtlinie zur Auflistung |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
retention remove
Entfernen Sie eine Aufbewahrungsrichtlinie vom Server.
Beispiel:
seqcli retention remove -i retentionpolicy-17
Option | Beschreibung |
---|---|
-i , --id=VALUE | Die ID einer einzelnen Aufbewahrungsrichtlinie zum Entfernen |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
retention update
Aktualisieren Sie eine vorhandene Aufbewahrungsrichtlinie.
Beispiel:
seqcli retention update --json '{...}'
Option | Beschreibung |
---|---|
--json=VALUE | Die aktualisierte Aufbewahrungsrichtlinie im JSON -Format; Dies kann mit seqcli retention list --json -erstellt werden |
--json-stdin | Lesen Sie die aktualisierte Aufbewahrungsrichtlinie als JSON von STDIN |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
sample ingest
Protokollieren Sie Beispielereignisse in eine SEQ -Instanz.
Beispiel:
seqcli sample ingest
Option | Beschreibung |
---|---|
-y , --confirm | Antwort [y] es, wenn er aufgefordert wird, fortzufahren |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
--quiet | Wiederholen Sie keine Echo -Ereignisse in STDOUT |
--batch-size=VALUE | Die maximale Anzahl von Ereignissen zum Senden jeder Anfrage an den Einnahmeendpunkt; Wenn nicht angegeben wird, wird ein Wert von 100 verwendet |
sample setup
Konfigurieren Sie eine SEQ -Instanz mit Beispiel -Dashboards, Signalen, Benutzern usw.
Beispiel:
seqcli sample setup
Option | Beschreibung |
---|---|
-y , --confirm | Antwort [y] es, wenn er aufgefordert wird, fortzufahren |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
search
Rufen Sie Protokollereignisse ab, die einem bestimmten Filter entsprechen.
Beispiel:
seqcli search -f "@Exception like '%TimeoutException%'" -c 30
Option | Beschreibung |
---|---|
-f , --filter=VALUE | Ein Filter für die Suche, z. B. Host = 'xmpweb-01.example.com' |
-c , --count=VALUE | Die maximale Anzahl von Ereignissen zum Abrufen; Der Standard ist 1 |
--start=VALUE | ISO 8601 Datum/Uhrzeit zum Abfragen von |
--end=VALUE | ISO 8601 Datum/Uhrzeit zur Abfrage nach |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
--signal=VALUE | Ein Signalausdruck oder eine Liste von überarbeiteten Signal-IDs, die angewendet werden, z. B. signal-1,signal-2 |
--request-timeout=VALUE | Die Zeit, die es ermöglichte, jede Seite von Ereignissen in Millisekunden abzurufen; Der Standard ist 100000 |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
setting clear
Löschen Sie eine renn-konfigurierbare Servereinstellung.
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Einstellungsname, zum Beispiel OpenIdConnectClientSecret |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
setting names
Drucken Sie die Namen aller unterstützten Einstellungen aus.
setting set
Ändern Sie eine renn-konfigurierbare Servereinstellung.
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Einstellungsname, zum Beispiel OpenIdConnectClientSecret |
-v , --value=VALUE | Der gesetzliche Einstellwert ist getrennt, wenn mehrere Werte akzeptiert werden |
--value-stdin | Lesen Sie den Wert von STDIN |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
setting show
Drucken Sie den aktuellen Wert einer rennzeitkonfigurierbaren Servereinstellung.
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Einstellungsname, zum Beispiel OpenIdConnectClientSecret |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
signal create
Erstellen Sie ein Signal.
Beispiel:
seqcli signal create -t 'Exceptions' -f "@Exception is not null"
Option | Beschreibung |
---|---|
-t , --title=VALUE | Ein Titel für das Signal |
--description=VALUE | Eine Beschreibung für das Signal |
-f , --filter=VALUE | Filter, um mit dem Signal zu assoziieren |
-c , --column=VALUE | Säule, um mit dem Signal zu assoziieren; Dieses Argument kann mehrmals verwendet werden |
--group=VALUE | Ein expliziter Gruppenname, der mit dem Signal assoziiert ist; Der Standardwert soll die Gruppe aus dem Filter schließen |
--no-group | Geben Sie an, dass keine Gruppe abgeleitet werden sollte; Der Standardwert soll die Gruppe aus dem Filter schließen |
--protected | Geben Sie an, dass das Signal nur von Administratoren bearbeitet werden kann |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
signal import
Importiersignale im Newline-delimitierten JSON-Format.
Beispiel:
seqcli signal import -i ./Exceptions.json
Option | Beschreibung |
---|---|
--merge | Aktualisieren Sie Signale mit IDs, die den importierten Daten entsprechen. Die Standardeinstellung besteht darin, immer neue Signale zu erstellen |
-i , --input=VALUE | Datei zum Importieren; Wenn nicht angegeben, wird STDIN verwendet |
-o , --owner=VALUE | Die ID des Benutzer, um Signale für zu importieren; Standardmäßig werden freigegebene Signale importiert |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
signal list
Listen Sie verfügbare Signale auf.
Beispiel:
seqcli signal list
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel der Signal (en) auflistet |
-i , --id=VALUE | Die ID eines einzelnen Signals zur Liste |
-o , --owner=VALUE | Die ID des Benutzers, Signale für aufzulisten; Standardmäßig sind freigegebene Signale ListD |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
signal remove
Entfernen Sie ein Signal vom Server.
Beispiel:
seqcli signal remove -t 'Test Signal'
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel der Signal (en) zu entfernen |
-i , --id=VALUE | Die ID eines einzelnen Signals zum Entfernen |
-o , --owner=VALUE | Die ID des Benutzers, Signale für zu entfernen; Standardmäßig werden freigegebene Signale entfernt |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
signal update
Aktualisieren Sie ein vorhandenes Signal.
Beispiel:
seqcli signal update --json '{...}'
Option | Beschreibung |
---|---|
--json=VALUE | Das aktualisierte Signal im JSON -Format; Dies kann mit seqcli signal list --json -erstellt werden |
--json-stdin | Lesen Sie das aktualisierte Signal als JSON von STDIN |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
tail
Stream -Protokollereignisse, die einem Filter entsprechen.
Option | Beschreibung |
---|---|
-f , --filter=VALUE | Ein optionaler serverseitiger Filter, der auf den Stream angewendet wird, z. B. @Level = 'Error' |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
--signal=VALUE | Ein Signalausdruck oder eine Liste von überarbeiteten Signal-IDs, die angewendet werden, z. B. signal-1,signal-2 |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
template export
Entitäten in Vorlagendateien exportieren.
Beispiel:
seqcli template export -o ./Templates
Option | Beschreibung |
---|---|
-o , --output=VALUE | Das Verzeichnis, in dem Vorlagendateien geschrieben werden sollen; Das Verzeichnis muss existieren; Alle vorhandenen Dateien mit Namen, die den exportierten Vorlagen entsprechen, werden überschrieben. Der Standard ist . |
-i , --include=VALUE | Die ID eines Signal-, Dashboard-, gespeicherten Abfrage-, Arbeitsbereichs- oder Aufbewahrungsrichtlinie zum Export; Dieses Argument kann mehrmals angegeben werden; Der Ausfall besteht darin, alle gemeinsam genutzten Einheiten zu exportieren |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
template import
Entitäten aus Vorlagendateien importieren.
Beispiel:
seqcli template import -i ./Templates
Option | Beschreibung |
---|---|
-i , --input=VALUE | Das Verzeichnis, aus dem das Satz von .template -Dateien gelesen werden kann; Der Standard ist . |
--state=VALUE | Der Pfad einer Datei, die eine Zuordnung von Vorlagennamen in die IDs der erstellten Entitäten auf dem Zielserver anhält, wodurch Duplikate vermieden werden, wenn mehrere Importe ausgeführt werden. Standardmäßig wird import.state im Eingabeverzeichnis verwendet |
--merge | Für Vorlagen ohne Einträge in der .state -Datei suchen Sie zunächst nach vorhandenen Entitäten mit passenden Namen oder Titeln. unterstützt keine Verschmelzung der Retentionspolitik |
-g , --arg=NAME=VALUE | Vorlagenargumente, z -g ownerId=user-314159 |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
user create
Erstellen Sie einen Benutzer.
Beispiel:
seqcli user create -n alice -d 'Alice Example' -r 'User (read/write)' --password-stdin
Option | Beschreibung |
---|---|
-n , --name=VALUE | Ein einzigartiger Benutzername für den Benutzer |
-d , --display-name=VALUE | Ein Langform-Name, der bei der Identifizierung des Benutzers helfen kann |
-f , --filter=VALUE | Ein Ansichtsfilter, der die für den Benutzer sichtbaren Ereignisse einschränkt |
-r , --role=VALUE | Der Titel einer Rolle, die die Benutzerberechtigungen auf dem Server gewährt; Wenn nicht angegeben, wird die standardmäßige neue Benutzerrolle zugewiesen |
-e , --email=VALUE | Die E -Mail -Adresse des Benutzers (aktiviert ein Gravatar -Bild für den Benutzer) |
-p , --password=VALUE | Ein erstes Kennwort für den Benutzer, wenn die Authentifizierung von Benutzernamen/Kennwort verwendet wird. Beachten Sie, dass --password-stdin sicherer ist |
--password-stdin | Lesen Sie das erste Passwort für den Benutzer von STDIN , wenn die Authentifizierung von Benutzernamen/Kennwort verwendet wird |
--no-password-change | Zwingen Sie den Benutzer nicht, sein Passwort bei der nächsten Anmeldung zu ändern |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
user list
Benutzer auflisten.
Beispiel:
seqcli user list
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Benutzername der Benutzer (en) auflisten |
-i , --id=VALUE | Die ID eines einzelnen Benutzers zur Auflistung |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
user remove
Entfernen Sie einen Benutzer vom Server.
Beispiel:
seqcli user remove -n alice
Option | Beschreibung |
---|---|
-n , --name=VALUE | Der Benutzername der Benutzer (en) zu entfernen |
-i , --id=VALUE | Die ID eines einzelnen Benutzers zu entfernen |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
user update
Aktualisieren Sie einen vorhandenen Benutzer.
Beispiel:
seqcli user update --json '{...}'
Option | Beschreibung |
---|---|
--json=VALUE | Der aktualisierte Benutzer im JSON -Format; Dies kann mithilfe seqcli user list --json erstellt werden |
--json-stdin | Lesen Sie den aktualisierten Benutzer als JSON von STDIN |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
version
Drucken Sie die aktuelle ausführbare Version.
workspace create
Erstellen Sie einen Arbeitsbereich.
Beispiel:
seqcli workspace create -t 'My Workspace' -c signal-314159 -c dashboard-628318
Option | Beschreibung |
---|---|
-t , --title=VALUE | Ein Titel für den Arbeitsbereich |
--description=VALUE | Eine Beschreibung für den Arbeitsbereich |
-c , --content=VALUE | Die ID eines Dashboards, eines Signals oder einer gespeicherten Abfrage, die in den Arbeitsbereich aufgenommen wird |
--protected | Geben Sie an, dass der Arbeitsbereich nur von Administratoren bearbeitet werden kann |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
workspace list
Listen Sie verfügbare Arbeitsbereiche auf.
Beispiel:
seqcli workspace list
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel des Arbeitsbereichs auflistet |
-i , --id=VALUE | Die ID eines einzelnen Arbeitsbereichs zur Liste |
-o , --owner=VALUE | Die ID des Benutzer, die Arbeitsbereiche für auflisten; Standardmäßig sind freigegebene Arbeitsbereiche ListD |
--json | Druckausgabe in Newline-delimitiertem JSON (der Standard ist ein einfacher Text) |
--no-color | Färben Sie die Textausgabe nicht |
--force-color | Erkrankung der Ausgabe umgeleitet, um die ANSI-Farbe zu haben (es sei denn, --no-color ist auch angegeben) |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
workspace remove
Entfernen Sie einen Arbeitsbereich vom Server.
Beispiel:
seqcli workspace remove -t 'My Workspace'
Option | Beschreibung |
---|---|
-t , --title=VALUE | Der Titel des Arbeitsbereichs (en) zu entfernen |
-i , --id=VALUE | Die ID eines einzelnen Arbeitsbereichs zum Entfernen |
-o , --owner=VALUE | Die ID des Benutzers zum Entfernen von Arbeitsbereichen für; Standardmäßig werden freigegebene Arbeitsbereiche entfernt |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
workspace update
Aktualisieren Sie einen vorhandenen Arbeitsbereich.
Beispiel:
seqcli workspace update --json '{...}'
Option | Beschreibung |
---|---|
--json=VALUE | Der aktualisierte Arbeitsbereich im JSON -Format; Dies kann mit seqcli workspace list --json -erstellt werden |
--json-stdin | Lesen Sie den aktualisierten Arbeitsbereich als JSON von STDIN |
-s , --server=VALUE | Die URL des SEQ -Servers; Standardmäßig wird die connection.serverUrl -Konfigurationswert verwendet |
-a , --apikey=VALUE | Die API -Taste, die bei der Verbindung mit dem Server verwendet werden soll; Standardmäßig wird der Konfigurationswert connection.apiKey verwendet |
--profile=VALUE | Ein zu verwendendes Verbindungsprofil; Standardmäßig werden die connection.serverUrl und connection.apiKey -Konfigurationswerte verwendet |
Der Befehl seqcli ingest
kann zum Parsen von Klartextprotokollen in strukturierte Protokollereignisse verwendet werden.
seqcli ingest -x " {@t:timestamp} [{@l:level}] {@m:*}{:n}{@x:*} "
Das obige Argument -x
ist ein Extraktionsmuster , das Ereignisse analysiert wie:
2018-02-21 13:29:00.123 +10:00 [ERR] The operation failed
System.DivideByZeroException: Attempt to divide by zero
at SomeClass.SomeMethod()
Extraktionsmuster haben eine einfache Syntax auf hoher Ebene:
Hello, world!
Wird Protokollierungsanweisungen übereinstimmen, die nur aus diesem Gruß bestehen,{curly braces}
ist ein Übereinstimmungsausdruck , der einen Teil des zu extrahierenden Ereignisses identifiziert und{{
{ {
{ }}
übereinstimmt }
.Übereinstimmende Ausdrücke haben die Form:
{name:matcher}
Sowohl der Name als auch der Match sind optional, aber entweder der eine oder der andere müssen angegeben werden. Daher gibt {@t:timestamp}
einen Namen von @t
und Value timestamp
an, {IPAddress}
nur einen Namen angibt, und {:n}
nur einen Wert (in diesem Fall der integrierte Newline-Matcher).
Der Name ist der zu extrahierende Eigenschaftsname; Es gibt vier eingebaute Immobiliennamen, die eine besondere Handhabung erhalten:
@t
- Der Zeitstempel der Veranstaltung@m
- Die mit dem Ereignis zugeordnete Textnachricht@l
- Das Ereignisstufe@x
- Die Ausnahme oder Backtrace, die dem Ereignis zugeordnet ist Andere Eigenschaftsnamen werden der Ereignisnutzlast beigefügt, daher extrahiert {Elapsed:dec}
eine Eigenschaft namens Elapsed
dec
-Dezimal -Matcher.
Übereinstimmende Ausdrücke ohne Namen werden aus der Eingabe konsumiert, aber der Ereignisnutzlast nicht hinzugefügt.
Matcher identifizieren Brocken des Eingabeereignisses.
Es werden verschiedene Matcher benötigt, damit ein Textstück wie 200OK
in separate Eigenschaften unterteilt werden kann, dh {StatusCode:nat}{Status:alpha}
. Hier zwingt der nat
-Match (natürliche Zahl) das Ergebnis auch zu einem numerischen Wert, so dass er numerisch als 200
statt als Text "200"
an die Ereignisnutzlast beigefügt ist.
Es gibt drei Arten von Mattern:
alpha
und nat
werden benannte Spieler eingebaut.*
, **
und so sind nicht greedische Inhalte . Diese stimmen zu jedem Text überein, bis das nächste Musterelement ( *
), die nächsten beiden Elemente übereinstimmt und so. Wir haben dies in Aktion mit den Elementen {@m:*}{:n}
im Beispiel gesehen - die Nachricht ist der gesamte Text bis zur nächsten Newline.=
wie {Phone:={:nat}-{:nat}-{:nat}}
vorangestellt. Dadurch werden Textbrocken wie 123-456-7890
in die Phone
ausgezeichnet.Match | Beschreibung | Beispiel |
---|---|---|
* , ** , ... | Nicht-Greedy-Inhalt | |
alpha | Ein oder mehrere Buchstaben | Abc |
alphanum | Ein oder mehrere Buchstaben oder Zahlen | a1b2 |
dec | Eine Dezimalzahl | 12.345 |
ident | Ein C-Identifikator im C-Stil | countOfMatches |
int | Eine Ganzzahl | -123 |
iso8601dt | An ISO-8601 Datum | 2020-01-28T13:50:01.123 |
level | Ein Name für Protokollierungsniveaus | INF |
line | Jeder einzelne Inhalt | one line! |
n | Ein Newline -Zeichen oder eine Newline -Sequenz | |
nat | Eine nichtnegative Zahl | 123 |
s | Ein oder mehrere Speicherplatz- oder Registerkartenzeichen | |
serilogdt | Eine DateTime im Standard -SERILOG -Datei -Protokollierungsformat | 2020-01-28 13:50:01.123 +10:00 |
syslogdt | Eine DateTime im Syslog -Format | Dec 8 09:12:13 |
t | Ein einzelner Registerkartenzeichen | |
timestamp | Eine datetime in einem anerkannten Format | |
token | Jede Sequenz von Nicht-Whitespace-Zeichen | 1+x$3 |
trailingident | Multilingehalt mit eingedrungenen nachverfolgenden Linien | |
unixdt | Ein DateTime im Unix-Zeitformat, das Sekunden (10-stellige) oder Millisekunden (12-stellige) unterstützt | 1608694199.999 |
w3cdt | Ein W3C -Protokollformatdatum/Zeitpaar | 2019-04-02 05:18:01 |
Extraktionsmuster werden von links nach rechts verarbeitet. Wenn das erste nicht übereinstimmende Muster auftritt, stoppt die Extraktion; Jeder verbleibende Text, der nicht übereinstimmt, wird dem resultierenden Ereignis in einer @unmatched
-Immobilie angeschlossen.
Multi-Line-Ereignisse werden durch die Suche nach Zeilen behandelt, die mit dem ersten Element des zu verwendenden Extraktionsmusters beginnen. Dies funktioniert gut, wenn die erste Zeile jedes Ereignisses mit etwas Eindeutigem wie einem iso8601dt
-Zeitstempel beginnt. Wenn die Linien mit weniger spezifischer Syntax beginnen, können die ersten Elemente des Extraktionsmusters gruppiert werden, um den Beginn von Ereignissen genauer zu identifizieren:
{:=[{@t} {@l}]} {@m:*}
Hier der wörtliche Text [
ein Zeitstempel -Token, angrenzender Raum
, Level und Schließen ]
sind alle gruppiert, damit sie ein einzelnes logisches Musterelement darstellen, um den Beginn von Ereignissen zu identifizieren.
Wenn Protokolle in Echtzeit in seqcli ingest
gestreamt werden, wird eine Frist von 10 ms angewendet, innerhalb derer die nachverfolgenden Linien empfangen werden müssen.
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} "
In diesem Beispiel werden Protokolldateien im Format aufgenommen:
# 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
Das Extraktionsmuster ist für Anzeigezwecke in das Beispiel eingewickelt und muss beim Aufrufen in einem String -Argument erscheinen.
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} "
Ein verschachteltes {@m:=
Muster wird verwendet, um eine Substring der Protokollzeile für die Anzeige als Nachricht des Ereignisses zu sammeln.
Die Befehlsfamilie von seqcli * update
ermöglicht es, beliebige Aktualisierungen für viele komplexe Entitätstypen durchzuführen.
Die update
wie das im folgende Beispiel gezeigte seqcli signal update
erhalten eine aktualisierte JSON -Darstellung eines Entität über STDIN
.
Dies funktioniert besonders gut mit Tools wie jq
und modernen Muscheln mit einheimischer JSON -Unterstützung, wie beispielsweise 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...