seqcli
L'application de ligne de commande du client Seq. Prend en charge la journalisation ( seqcli log
), la recherche ( search
), la queue ( tail
), les requêtes ( query
) et l'ingestion de fichiers journaux JSON ou en texte brut ( ingest
), et bien plus encore.
Le programme d'installation Seq pour Windows inclut seqcli
. Sinon, téléchargez la version correspondant à votre système d'exploitation. Ou, si dotnet
est installé, seqcli
peut être installé en tant qu'outil global en utilisant :
dotnet tool install --global seqcli
Pour définir une URL de serveur et une clé API par défaut, exécutez :
seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key
La clé API sera stockée dans votre fichier de configuration SeqCli.json
; sous Windows, celui-ci est crypté à l'aide de DPAPI ; sur Mac/Linux, la clé est actuellement stockée en texte brut. Au lieu de stocker la clé API dans la configuration, elle peut être transmise à chaque commande via l'argument --apikey=
.
seqcli
est également disponible en tant que conteneur Docker sous datalust/seqcli
:
docker run --rm datalust/seqcli:latest <command> [<args>]
Pour vous connecter à Seq dans un conteneur Docker sur la machine locale, utilisez l'adresse IP de la machine (et non localhost) ou spécifiez la mise en réseau de l'hôte Docker avec --net host
.
Utilisez les réseaux et les volumes Docker pour rendre les fichiers locaux et autres conteneurs accessibles à seqcli
dans son conteneur.
Chaque valeur de paramètre peut être remplacée au moment de l'exécution en spécifiant une variable d'environnement de la forme SEQCLI_<setting path>
, où contient un élément pour chaque segment en pointillés du nom du paramètre, séparé par des traits de soulignement.
Par exemple, le paramètre connection.serverUrl
peut être remplacé par la variable SEQCLI_CONNECTION_SERVERURL
.
Si vous automatisez la configuration de Seq, il est probable que vous n'ayez pas encore de clé API à utiliser pour seqcli
. Lors de la configuration initiale du serveur Seq, vous pouvez spécifier firstRun.adminUsername
et firstRun.adminPasswordHash
(ou les variables d'environnement équivalentes SEQ_FIRSTRUN_ADMINUSERNAME
et SEQ_FIRSTRUN_ADMINPASSWORDHASH
) pour définir un nom d'utilisateur et un mot de passe initiaux pour le compte administrateur. Vous pouvez les utiliser pour créer une clé API, puis utiliser le jeton de clé API avec les commandes seqcli
restantes.
La commande seqcli apikey create
accepte --connect-username
et --connect-password-stdin
et imprime le nouveau jeton de clé API sur STDOUT
(la syntaxe PowerShell est utilisée ci-dessous) :
$user = "admin"
$pw = "thepassword"
$token = (
echo $pw |
seqcli apikey create `
-t CLI `
--permissions="Read,Write,Project,Organization,System" `
--connect-username $user --connect-password-stdin
)
Voir CONTRIBUTING.md
.
Lors de la connexion avec une clé API, les opérations autorisées sont déterminées par les autorisations attribuées à cette clé API.
Pour déterminer l'autorisation requise pour une commande, vérifiez la colonne « Demande d'autorisation » de l'opération API du serveur équivalente. Par exemple, la commande apikey create
utilise le point de terminaison POST api/apikeys
, qui nécessite l'autorisation Write
.
Toutes les commandes seqcli
suivent le même modèle :
seqcli <command> [<args>]
La liste complète des commandes prises en charge peut être consultée en exécutant :
seqcli help
Pour afficher les informations d'utilisation d'une commande spécifique, exécutez seqcli help <command>
, par exemple :
seqcli help apikey create
Cela fonctionne également pour les groupes de commandes ; pour lister toutes les sous-commandes apikey
, exécutez :
seqcli help apikey
apikey
apikey create
— Créez une clé API pour l'automatisation ou l'ingestion.apikey list
— Répertorie les clés API disponibles.apikey remove
— Supprimez une clé API du serveur.apikey update
— Mettez à jour une clé API existante.app
app define
— Générez une définition d'application pour un plug-in .NET [SeqApp]
.app install
: installez un package d'application.app list
— Répertorie les packages d'applications installés.app run
— Hébergez un plug-in .NET [SeqApp]
.app uninstall
: désinstallez un package d'application.app update
: mettez à jour un package d'application installé.appinstance
appinstance create
— Créez une instance d'une application installée.appinstance list
— Répertorie les instances des applications installées.appinstance remove
— Supprimez une instance d'application du serveur.appinstance update
— Mettez à jour une instance d'application existante.bench
— Mesurez les performances des requêtes.config
— Afficher et définir les champs dans le fichier SeqCli.json
; exécuter sans argument pour lister tous les champs.dashboard
dashboard list
— Répertoriez les tableaux de bord.dashboard remove
— Supprimez un tableau de bord du serveur.dashboard render
— Produisez un ensemble de résultats CSV ou JSON à partir d'un graphique de tableau de bord.expressionindex
expressionindex create
— Crée un index d'expression.expressionindex list
— Répertorie les index d’expression.expressionindex remove
— Supprime un index d'expression du serveur.feed
feed create
— Créez un flux NuGet.feed list
— Répertorie les flux NuGet.feed remove
— Supprimez un flux NuGet du serveur.feed update
— Mettez à jour un flux NuGet existant.help
— Afficher des informations sur les commandes disponibles.index
index list
— Répertorie les index.index suppress
— Supprime un index.ingest
— Envoyez les événements du journal à partir d'un fichier ou STDIN
.license apply
— Appliquez une licence au serveur Seq.log
— Envoyez un événement de journal structuré au serveur.node
node demote
— Commencer la rétrogradation du nœud leader actuel.node health
— Sondez le point de terminaison /health
d'un nœud Seq et imprimez le code d'état HTTP renvoyé, ou « Inaccessible » si le point de terminaison n'a pas pu être interrogé.node list
— Répertoriez les nœuds du cluster Seq.print
— Imprimez joliment les événements au format CLEF/JSON, à partir d'un fichier ou STDIN
.profile
profile create
— Créez ou remplacez un profil de connexion.profile list
— Répertorie les profils de connexion.profile remove
— Supprime un profil de connexion.query
— Exécutez une requête SQL et recevez les résultats au format CSV.retention
retention create
— Créez une stratégie de rétention.retention list
— Répertoriez les politiques de rétention.retention remove
— Supprimez une stratégie de rétention du serveur.retention update
: mettez à jour une stratégie de rétention existante.sample
sample ingest
: enregistrez des exemples d'événements dans une instance Seq.sample setup
: configurez une instance Seq avec des exemples de tableaux de bord, de signaux, d'utilisateurs, etc.search
— Récupérez les événements du journal qui correspondent à un filtre donné.setting
setting clear
— Supprimez un paramètre de serveur configurable au moment de l'exécution.setting names
— Imprimez les noms de tous les paramètres pris en charge.setting set
— Modifiez un paramètre de serveur configurable au moment de l'exécution.setting show
— Imprime la valeur actuelle d'un paramètre de serveur configurable à l'exécution.signal
signal create
— Crée un signal.signal import
— Importez des signaux au format JSON délimité par des nouvelles lignes.signal list
— Répertorie les signaux disponibles.signal remove
— Supprime un signal du serveur.signal update
— Mettre à jour un signal existant.tail
— Diffusez les événements du journal correspondant à un filtre.template
template export
— Exportez des entités dans des fichiers modèles.template import
— Importez des entités à partir de fichiers modèles.user
user create
— Créer un utilisateur.user list
— Répertoriez les utilisateurs.user remove
— Supprime un utilisateur du serveur.user update
— Mettre à jour un utilisateur existant.version
— Imprime la version actuelle de l'exécutable.workspace
workspace create
— Créez un espace de travail.workspace list
— Répertorie les espaces de travail disponibles.workspace remove
— Supprimez un espace de travail du serveur.workspace update
— Mettez à jour un espace de travail existant.apikey create
Créez une clé API pour l'automatisation ou l'ingestion.
Exemple:
seqcli apikey create -t 'Test API Key' -p Environment=Test
Option | Description |
---|---|
-t , --title=VALUE | Un titre pour la clé API |
--token=VALUE | Un jeton de clé API pré-attribué ; par défaut, un nouveau jeton sera généré et écrit dans STDOUT |
-p , --property=NAME=VALUE | Spécifiez les propriétés nom/valeur, par exemple -p Customer=C123 -p Environment=Production |
--filter=VALUE | Un filtre à appliquer aux événements entrants |
--minimum-level=VALUE | Le niveau/gravité minimum de l'événement à accepter ; la valeur par défaut est d'accepter tous les événements |
--use-server-timestamps | Supprimer les horodatages fournis par le client et utiliser les valeurs d'horloge du serveur |
--permissions=VALUE | Une liste d'autorisations séparées par des virgules à déléguer à la clé API ; les autorisations valides sont Ingest (par défaut), Read , Write , Project et System |
--connect-username=VALUE | Un nom d'utilisateur avec lequel se connecter, utile principalement lors de la configuration de la première clé API ; les serveurs avec un abonnement 'Individuel' n'autorisent qu'une seule requête simultanée avec cette option |
--connect-password=VALUE | Lorsque connect-username est spécifié, un mot de passe correspondant |
--connect-password-stdin | Lorsque connect-username est spécifié, lisez le mot de passe correspondant depuis STDIN |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
apikey list
Répertoriez les clés API disponibles.
Exemple:
seqcli apikey list
Option | Description |
---|---|
-t , --title=VALUE | Le titre de la ou des clés API à lister |
-i , --id=VALUE | L'identifiant d'une seule clé API à répertorier |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
apikey remove
Supprimez une clé API du serveur.
Exemple:
seqcli apikey remove -t 'Test API Key'
Option | Description |
---|---|
-t , --title=VALUE | Le titre de la ou des clés API à supprimer |
-i , --id=VALUE | L'identifiant d'une seule clé API à supprimer |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
apikey update
Mettez à jour une clé API existante.
Exemple:
seqcli apikey update --json '{...}'
Option | Description |
---|---|
--json=VALUE | La clé API mise à jour au format JSON ; cela peut être produit en utilisant seqcli apikey list --json |
--json-stdin | Lire la clé API mise à jour au format JSON depuis STDIN |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
app define
Générez une définition d'application pour un plug-in .NET [SeqApp]
.
Exemple:
seqcli app define -d "./bin/Debug/netstandard2.2"
Option | Description |
---|---|
-d , --directory=VALUE | Le répertoire contenant les assemblys .NET Standard ; par défaut le répertoire courant |
--type=VALUE | Le nom du type de plug-in [SeqApp] ; par défaut, l'analyse des assemblys pour un seul type marqué avec cet attribut |
--indented | Formater la définition sur plusieurs lignes avec indentation |
app install
Installez un package d'application.
Exemple:
seqcli app install --package-id 'Seq.App.JsonArchive'
Option | Description |
---|---|
--package-id=VALUE | L'identifiant du package de l'application à installer |
--version=VALUE | La version du package à installer ; la valeur par défaut est d'installer la dernière version |
--feed-id=VALUE | L’identifiant du flux NuGet à partir duquel installer le package ; peut être omis si un seul flux est configuré |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
app list
Répertoriez les packages d’applications installés.
Exemple:
seqcli app list
Option | Description |
---|---|
--package-id=VALUE | L'identifiant du package de la ou des applications à répertorier |
-i , --id=VALUE | L'identifiant d'une seule application à répertorier |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
app run
Hébergez un plug-in .NET [SeqApp]
.
Exemple:
seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]
Option | Description |
---|---|
-d , --directory=VALUE | Le répertoire contenant les assemblys .NET Standard ; par défaut le répertoire courant |
--type=VALUE | Le nom du type de plug-in [SeqApp] ; par défaut, l'analyse des assemblys pour un seul type marqué avec cet attribut |
-p , --property=NAME=VALUE | Spécifiez les paramètres de nom/valeur pour l'application, par exemple -p [email protected] -p Subject="Alert!" |
--storage=VALUE | Un répertoire dans lequel les données spécifiques à l'application peuvent être stockées ; par défaut le répertoire courant |
-s , --server=VALUE | L'URL du serveur Seq, utilisée uniquement pour la configuration de l'application (aucune connexion n'est établie avec le serveur) ; par défaut, la valeur connection.serverUrl sera utilisée |
--server-instance=VALUE | Le nom d'instance du serveur Seq, utilisé uniquement pour la configuration de l'application ; par défaut, aucun nom d'instance |
-t , --title=VALUE | Le titre de l'instance d'application, utilisé uniquement pour la configuration de l'application ; par défaut, il s'agit d'un titre d'espace réservé. |
--id=VALUE | L'identifiant de l'instance d'application, utilisé uniquement pour la configuration de l'application ; par défaut, il s'agit d'un identifiant d'espace réservé. |
--read-env | Lisez la configuration et les paramètres de l'application à partir des variables d'environnement, comme spécifié dans https://docs.datalust.co/docs/seq-apps-in-other-linguals ; ignore toutes les options sauf --directory et --type |
app uninstall
Désinstallez un package d’application.
Exemple:
seqcli app uninstall --package-id 'Seq.App.JsonArchive'
Option | Description |
---|---|
--package-id=VALUE | L'identifiant du package d'application à désinstaller |
-i , --id=VALUE | L'identifiant d'un seul package d'application à désinstaller |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
app update
Mettez à jour un package d’application installé.
Exemple:
seqcli app update -n 'HTML Email'
Option | Description |
---|---|
-i , --id=VALUE | L'identifiant d'une seule application installée à mettre à jour |
-n , --name=VALUE | Le nom de l'application installée à mettre à jour |
--all | Mettez à jour toutes les applications installées ; non compatible avec -i ou -n |
--version=VALUE | La version du package vers laquelle mettre à jour ; la valeur par défaut est de mettre à jour vers la dernière version dans le flux associé |
--force | Mettez à jour l'application même si la version cible est déjà installée |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
appinstance create
Créez une instance d'une application installée.
Exemple:
seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]
Option | Description |
---|---|
-t , --title=VALUE | Un titre pour l'instance d'application |
--app=VALUE | L'identifiant du package d'application installé à instancier |
-p , --property=NAME=VALUE | Spécifiez les paramètres de nom/valeur pour l'application, par exemple -p [email protected] -p Subject="Alert!" |
--stream[=VALUE] | Diffusez les événements entrants sur cette instance d'application au fur et à mesure de leur ingestion ; accepte éventuellement une expression de signal limitant les événements à diffuser, par exemple signal-1,signal-2 |
--overridable=VALUE | Spécifiez les noms de paramètres qui peuvent être remplacés par les utilisateurs lors de l'appel de l'application |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
appinstance list
Répertoriez les instances des applications installées.
Exemple:
seqcli appinstance list
Option | Description |
---|---|
-t , --title=VALUE | Le titre de la ou des instances d'application à répertorier |
-i , --id=VALUE | L'identifiant d'une seule instance d'application à répertorier |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
appinstance remove
Supprimez une instance d'application du serveur.
Exemple:
seqcli appinstance remove -t 'Email Ops'
Option | Description |
---|---|
-t , --title=VALUE | Le titre de la ou des instances d'application à supprimer |
-i , --id=VALUE | L'identifiant d'une seule instance d'application à supprimer |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
appinstance update
Mettez à jour une instance d'application existante.
Exemple:
seqcli appinstance update --json '{...}'
Option | Description |
---|---|
--json=VALUE | L'instance d'application mise à jour au format JSON ; cela peut être produit en utilisant seqcli appinstance list --json |
--json-stdin | Lire l'instance d'application mise à jour au format JSON à partir de STDIN |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
bench
Mesurez les performances des requêtes.
Option | Description |
---|---|
-r , --runs=VALUE | Le nombre d'exécutions à exécuter ; la valeur par défaut est 10 |
-c , --cases=VALUE | Un fichier JSON contenant l'ensemble des cas à exécuter. La valeur par défaut est un ensemble standard de cas. |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--start=VALUE | Date/heure ISO 8601 à partir de laquelle effectuer la requête |
--end=VALUE | Date/heure ISO 8601 à rechercher |
--reporting-server=VALUE | L'adresse d'un serveur Seq auquel envoyer les résultats du banc d'essai |
--reporting-apikey=VALUE | La clé API à utiliser lors de la connexion au serveur de reporting |
--description=VALUE | Description facultative du test au banc |
--with-ingestion | Le benchmark devrait-il inclure l'envoi d'événements à Seq |
--with-queries | Le benchmark devrait-il inclure l'interrogation de Seq |
config
Afficher et définir les champs dans le fichier SeqCli.json
; exécuter sans argument pour lister tous les champs.
Option | Description |
---|---|
-k , --key=VALUE | Le champ, par exemple connection.serverUrl |
-v , --value=VALUE | La valeur du champ ; si non spécifié, la commande imprimera la valeur actuelle |
-c , --clear | Dégagez le terrain |
dashboard list
Répertorier les tableaux de bord.
Exemple:
seqcli dashboard list
Option | Description |
---|---|
-t , --title=VALUE | Le titre du ou des tableaux de bord à lister |
-i , --id=VALUE | L'identifiant d'un seul tableau de bord à lister |
-o , --owner=VALUE | L'identifiant de l'utilisateur pour lequel répertorier les tableaux de bord ; par défaut, les tableaux de bord partagés sont répertoriés |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
dashboard remove
Supprimez un tableau de bord du serveur.
Exemple:
seqcli dashboard remove -i dashboard-159
Option | Description |
---|---|
-t , --title=VALUE | Le titre du ou des tableaux de bord à supprimer |
-i , --id=VALUE | L'identifiant d'un seul tableau de bord à supprimer |
-o , --owner=VALUE | L'identifiant de l'utilisateur pour lequel supprimer les tableaux de bord ; par défaut, les tableaux de bord partagés sont supprimés |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
dashboard render
Produisez un ensemble de résultats CSV ou JSON à partir d'un tableau de bord.
Exemple:
seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h
Option | Description |
---|---|
-i , --id=VALUE | L'identifiant d'un seul tableau de bord à restituer |
-c , --chart=VALUE | Le titre d'un graphique sur le tableau de bord à restituer |
--last=VALUE | Une durée pendant laquelle le graphique doit être rendu, par exemple 7d ; celui-ci sera aligné sur une limite d'intervalle ; soit --last ou --start et --end doivent être spécifiés |
--by=VALUE | L'intervalle de temps pour les données du graphique, sous forme de durée, par exemple 1h |
--start=VALUE | Date/heure ISO 8601 à partir de laquelle effectuer la requête |
--end=VALUE | Date/heure ISO 8601 à rechercher |
--signal=VALUE | Une expression de signal ou une liste d'identifiants de signaux croisés à appliquer, par exemple signal-1,signal-2 |
--timeout=VALUE | Le délai d'exécution en millisecondes |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
expressionindex create
Créez un index d'expression.
Exemple:
seqcli expressionindex create --expression "ServerName"
Option | Description |
---|---|
-e , --expression=VALUE | L'expression à indexer |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
expressionindex list
Répertoriez les index d’expression.
Exemple:
seqcli expressionindex list
Option | Description |
---|---|
-i , --id=VALUE | L'identifiant d'un index d'expression unique à lister |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
expressionindex remove
Supprimez un index d'expression du serveur.
Exemple:
seqcli expressionindex -i expressionindex-2529
Option | Description |
---|---|
-i , --id=VALUE | L'identifiant d'un index d'expression à supprimer |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
feed create
Créez un flux NuGet.
Exemple:
seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin
Option | Description |
---|---|
-n , --name=VALUE | Un nom unique pour le flux |
-l , --location=VALUE | L'emplacement du flux ; il peut s'agir d'une URL de flux NuGet v2 ou v3, ou d'un chemin de système de fichiers local sur le serveur Seq |
-u , --username=VALUE | Le nom d'utilisateur Seq doit être fourni lors de la connexion au flux, si une authentification est requise |
-p , --password=VALUE | Un mot de passe du flux, si une authentification est requise ; notez que --password-stdin est plus sécurisé |
--password-stdin | Lire le mot de passe du flux depuis STDIN |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
feed list
Répertoriez les flux NuGet.
Exemple:
seqcli feed list
Option | Description |
---|---|
-n , --name=VALUE | Le nom du flux à lister |
-i , --id=VALUE | L'identifiant d'un seul flux à lister |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
feed remove
Supprimez un flux NuGet du serveur.
Exemple:
seqcli feed remove -n CI
Option | Description |
---|---|
-n , --name=VALUE | Le nom du flux à supprimer |
-i , --id=VALUE | L'identifiant d'un seul flux à supprimer |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
feed update
Mettez à jour un flux NuGet existant.
Exemple:
seqcli feed update --json '{...}'
Option | Description |
---|---|
--json=VALUE | Le flux NuGet mis à jour au format JSON ; cela peut être produit en utilisant seqcli feed list --json |
--json-stdin | Lire le flux NuGet mis à jour au format JSON à partir de STDIN |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
help
Afficher des informations sur les commandes disponibles.
Exemple:
seqcli help search
Option | Description |
---|---|
-m , --markdown | Générer une démarque à utiliser dans la documentation |
index list
Liste des index.
Exemple:
seqcli index list
Option | Description |
---|---|
-i , --id=VALUE | L'identifiant d'un seul index à lister |
--json | Imprimer la sortie en JSON délimité par des nouvelles lignes (la valeur par défaut est le texte brut) |
--no-color | Ne pas coloriser la sortie du texte |
--force-color | Forcer la sortie redirigée à avoir une couleur ANSI (sauf si --no-color est également spécifié) |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
index suppress
Supprimer un index.
Exemple:
seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748
Option | Description |
---|---|
-i , --id=VALUE | L'identifiant d'un index à supprimer |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
ingest
Envoyer les événements du journal à partir d'un fichier ou STDIN
.
Exemple:
seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test
Option | Description |
---|---|
-i , --input=VALUE | Fichier(s) à ingérer, y compris le caractère générique * ; s'il n'est pas spécifié, STDIN sera utilisé |
--invalid-data=VALUE | Spécifiez comment les données non valides sont traitées : fail (par défaut) ou ignore |
-p , --property=NAME=VALUE | Spécifiez les propriétés nom/valeur, par exemple -p Customer=C123 -p Environment=Production |
-x , --extract=VALUE | Un modèle d'extraction à appliquer aux journaux en texte brut (ignoré lorsque --json est spécifié) |
--json | Lire les événements au format JSON (la valeur par défaut suppose du texte brut) |
-f , --filter=VALUE | Filtrer l'expression pour sélectionner un sous-ensemble d'événements |
-m , --message=VALUE | Un message à associer aux événements ingérés ; La syntaxe https://messagetemplates.org est prise en charge |
-l , --level=VALUE | Le niveau ou la gravité à associer aux événements ingérés ; cela remplacera toutes les informations de niveau présentes dans les événements eux-mêmes |
--send-failure=VALUE | Spécifiez comment les échecs de connexion sont gérés : fail (par défaut), retry , continue ou ignore |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront utilisées |
--batch-size=VALUE | Le nombre maximum d'événements à envoyer dans chaque demande au point de terminaison d'ingestion ; si non spécifié, une valeur de 100 sera utilisée |
license apply
Appliquez une licence au serveur Seq.
Exemple:
seqcli license apply --certificate="license.txt"
Option | Description |
---|---|
-c , --certificate=VALUE | Dossier de certificat ; le fichier doit être du texte UTF-8 |
--certificate-stdin | Lire le certificat de licence de STDIN |
--automatically-refresh | Si la licence concerne un abonnement, consultez périodiquement datalust.co et actualisez automatiquement le certificat lorsque l'abonnement est modifié ou renouvelé. |
-s , --server=VALUE | L'URL du serveur Seq ; par défaut, la valeur de configuration connection.serverUrl sera utilisée |
-a , --apikey=VALUE | La clé API à utiliser lors de la connexion au serveur ; par défaut, la valeur de configuration connection.apiKey sera utilisée |
--profile=VALUE | Un profil de connexion à utiliser ; par défaut, les valeurs de configuration connection.serverUrl et connection.apiKey seront nous |