seqcli

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.

Erste Schritte

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 <command> [<args>]

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.

Überschreibungen von Umgebungsvariablen

Jeder Einstellungswert kann zur Laufzeit überschrieben werden, indem eine Umgebungsvariable der Form SEQCLI_<setting path> 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.

Verbindung ohne API-Schlüssel herstellen

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
)

Mitwirken

Siehe CONTRIBUTING.md .

Berechtigungen

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.

Verwendung

Alle seqcli -Befehle folgen demselben Muster:

 seqcli <command> [<args>]

Befehlshilfe

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 <command> 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

Verfügbare Befehle

• 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 Dashboards, das gerendert werden soll
-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 lauten die Konfigurationswerte connection.serverUrl und connection.apiKey „us“.