seqcli
La aplicación de línea de comandos del cliente Seq. Admite registro ( seqcli log
), búsqueda ( search
), seguimiento ( tail
), consulta ( query
) e ingesta de archivos de registro JSON o de texto sin formato ( ingest
), y mucho más.
El instalador de Seq para Windows incluye seqcli
. De lo contrario, descargue la versión para su sistema operativo. O, si tiene instalado dotnet
, seqcli
se puede instalar como una herramienta global usando:
dotnet tool install --global seqcli
Para configurar una URL de servidor predeterminada y una clave API, ejecute:
seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key
La clave API se almacenará en su archivo de configuración SeqCli.json
; en Windows, esto se cifra mediante DPAPI; En Mac/Linux, la clave está actualmente almacenada en texto sin formato. Como alternativa a almacenar la clave API en la configuración, se puede pasar a cada comando mediante el argumento --apikey=
.
seqcli
también está disponible como contenedor Docker en datalust/seqcli
:
docker run --rm datalust/seqcli:latest <command> [<args>]
Para conectarse a Seq en un contenedor acoplable en la máquina local, use la dirección IP de la máquina (no localhost) o especifique la red del host acoplable con --net host
.
Utilice redes y volúmenes de Docker para que seqcli
pueda acceder a archivos locales y otros contenedores dentro de su contenedor.
Cada valor de configuración se puede anular en tiempo de ejecución especificando una variable de entorno del formato SEQCLI_<setting path>
, donde contiene un elemento para cada segmento de puntos del nombre de la configuración, separados por guiones bajos.
Por ejemplo, la configuración connection.serverUrl
se puede anular con la variable SEQCLI_CONNECTION_SERVERURL
.
Si está automatizando la configuración de Seq, es probable que aún no tenga una clave API para que la use seqcli
. Durante la configuración inicial del servidor Seq, puede especificar firstRun.adminUsername
y firstRun.adminPasswordHash
(o las variables de entorno equivalentes SEQ_FIRSTRUN_ADMINUSERNAME
y SEQ_FIRSTRUN_ADMINPASSWORDHASH
) para establecer un nombre de usuario y una contraseña iniciales para la cuenta de administrador. Puede usarlos para crear una clave API y luego usar el token de clave API con los comandos seqcli
restantes.
El comando seqcli apikey create
acepta --connect-username
y --connect-password-stdin
e imprime el nuevo token de clave API en STDOUT
(la sintaxis de PowerShell se usa a continuación):
$user = "admin"
$pw = "thepassword"
$token = (
echo $pw |
seqcli apikey create `
-t CLI `
--permissions="Read,Write,Project,Organization,System" `
--connect-username $user --connect-password-stdin
)
Consulte CONTRIBUTING.md
.
Al conectarse con una clave API, las operaciones permitidas están determinadas por los permisos asignados a esa clave API.
Para determinar el permiso requerido para un comando, consulte la columna "Solicitud de permiso" de la operación API del servidor equivalente. Por ejemplo, el comando apikey create
utiliza el punto final POST api/apikeys
, que requiere permiso Write
.
Todos los comandos seqcli
siguen el mismo patrón:
seqcli <command> [<args>]
La lista completa de comandos admitidos se puede ver ejecutando:
seqcli help
Para mostrar información de uso para un comando específico, ejecute seqcli help <command>
, por ejemplo:
seqcli help apikey create
Esto también funciona para grupos de mando; para enumerar todos los subcomandos apikey
, ejecute:
seqcli help apikey
apikey
apikey create
: crea una clave API para automatización o ingesta.apikey list
: enumera las claves API disponibles.apikey remove
: elimina una clave API del servidor.apikey update
: actualiza una clave API existente.app
app define
: genere una definición de aplicación para un complemento .NET [SeqApp]
.app install
: instala un paquete de aplicación.app list
: enumera los paquetes de aplicaciones instalados.app run
: aloja un complemento .NET [SeqApp]
.app uninstall
: desinstala un paquete de aplicación.app update
: actualiza un paquete de aplicación instalado.appinstance
appinstance create
: crea una instancia de una aplicación instalada.appinstance list
: enumera instancias de aplicaciones instaladas.appinstance remove
: elimina una instancia de aplicación del servidor.appinstance update
: actualiza una instancia de aplicación existente.bench
: mide el rendimiento de las consultas.config
: ve y configura campos en el archivo SeqCli.json
; ejecute sin argumentos para enumerar todos los campos.dashboard
dashboard list
: lista de paneles.dashboard remove
: elimina un panel del servidor.dashboard render
: produzca un conjunto de resultados CSV o JSON a partir de un gráfico del panel.expressionindex
expressionindex create
: crea un índice de expresión.expressionindex list
: enumera los índices de expresiones.expressionindex remove
: elimina un índice de expresión del servidor.feed
feed create
: cree un feed NuGet.feed list
: muestra los feeds de NuGet.feed remove
: elimina un feed NuGet del servidor.feed update
: actualiza un feed NuGet existente.help
: muestra información sobre los comandos disponibles.index
index list
: lista de índices.index suppress
: suprime un índice.ingest
: envía eventos de registro desde un archivo o STDIN
.license apply
: aplica una licencia al servidor Seq.log
: envía un evento de registro estructurado al servidor.node
node demote
: comienza la degradación del nodo líder actual.node health
: sondee el punto final /health
de un nodo Seq e imprima el código de estado HTTP devuelto, o "Inalcanzable" si no se pudo consultar el punto final.node list
: enumera los nodos en el clúster Seq.print
: eventos de impresión bonita en formato CLEF/JSON, desde un archivo o STDIN
.profile
profile create
: crea o reemplaza un perfil de conexión.profile list
: enumera los perfiles de conexión.profile remove
: elimina un perfil de conexión.query
: ejecute una consulta SQL y reciba los resultados en formato CSV.retention
retention create
: cree una política de retención.retention list
: enumera las políticas de retención.retention remove
: elimina una política de retención del servidor.retention update
: actualiza una política de retención existente.sample
sample ingest
: registra eventos de muestra en una instancia de Seq.sample setup
: configure una instancia de Seq con paneles de ejemplo, señales, usuarios, etc.search
: recupera eventos de registro que coinciden con un filtro determinado.setting
setting clear
: borra una configuración del servidor configurable en tiempo de ejecución.setting names
: imprime los nombres de todas las configuraciones admitidas.setting set
: cambia una configuración del servidor configurable en tiempo de ejecución.setting show
: imprime el valor actual de una configuración de servidor configurable en tiempo de ejecución.signal
signal create
: crea una señal.signal import
: importe señales en formato JSON delimitado por nuevas líneas.signal list
: enumera las señales disponibles.signal remove
: elimina una señal del servidor.signal update
: actualiza una señal existente.tail
: eventos de registro de transmisión que coinciden con un filtro.template
template export
: exporta entidades a archivos de plantilla.template import
: importe entidades desde archivos de plantilla.user
user create
: crea un usuario.user list
: lista de usuarios.user remove
: elimina un usuario del servidor.user update
: actualiza un usuario existente.version
: imprime la versión ejecutable actual.workspace
workspace create
: crea un espacio de trabajo.workspace list
: muestra los espacios de trabajo disponibles.workspace remove
: elimina un espacio de trabajo del servidor.workspace update
: actualiza un espacio de trabajo existente.apikey create
Cree una clave API para automatización o ingesta.
Ejemplo:
seqcli apikey create -t 'Test API Key' -p Environment=Test
Opción | Descripción |
---|---|
-t , --title=VALUE | Un título para la clave API |
--token=VALUE | Un token de clave API preasignado; De forma predeterminada, se generará un nuevo token y se escribirá en STDOUT |
-p , --property=NAME=VALUE | Especifique las propiedades de nombre/valor, por ejemplo -p Customer=C123 -p Environment=Production |
--filter=VALUE | Un filtro para aplicar a los eventos entrantes. |
--minimum-level=VALUE | El nivel/gravedad mínimo del evento a aceptar; el valor predeterminado es aceptar todos los eventos |
--use-server-timestamps | Descartar las marcas de tiempo proporcionadas por el cliente y utilizar los valores del reloj del servidor |
--permissions=VALUE | Una lista de permisos separados por comas para delegar a la clave API; Los permisos válidos son Ingest (predeterminado), Read , Write , Project y System |
--connect-username=VALUE | Un nombre de usuario con el que conectarse, útil principalmente al configurar la primera clave API; Los servidores con suscripción 'Individual' solo permiten una solicitud simultánea con esta opción |
--connect-password=VALUE | Cuando se especifica connect-username , la contraseña correspondiente |
--connect-password-stdin | Cuando se especifica connect-username , lea la contraseña correspondiente de STDIN |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
apikey list
Enumere las claves API disponibles.
Ejemplo:
seqcli apikey list
Opción | Descripción |
---|---|
-t , --title=VALUE | El título de las claves API que se enumerarán |
-i , --id=VALUE | La identificación de una única clave API para enumerar |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
apikey remove
Elimine una clave API del servidor.
Ejemplo:
seqcli apikey remove -t 'Test API Key'
Opción | Descripción |
---|---|
-t , --title=VALUE | El título de las claves API que se eliminarán |
-i , --id=VALUE | La identificación de una única clave API para eliminar |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
apikey update
Actualice una clave API existente.
Ejemplo:
seqcli apikey update --json '{...}'
Opción | Descripción |
---|---|
--json=VALUE | La clave API actualizada en formato JSON; esto se puede producir usando seqcli apikey list --json |
--json-stdin | Lea la clave API actualizada como JSON de STDIN |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
app define
Genere una definición de aplicación para un complemento .NET [SeqApp]
.
Ejemplo:
seqcli app define -d "./bin/Debug/netstandard2.2"
Opción | Descripción |
---|---|
-d , --directory=VALUE | El directorio que contiene los ensamblados de .NET Standard; por defecto es el directorio actual |
--type=VALUE | El nombre del tipo de complemento [SeqApp]; El valor predeterminado es escanear ensamblajes para un solo tipo marcado con este atributo. |
--indented | Formatee la definición en varias líneas con sangría |
app install
Instale un paquete de aplicación.
Ejemplo:
seqcli app install --package-id 'Seq.App.JsonArchive'
Opción | Descripción |
---|---|
--package-id=VALUE | La identificación del paquete de la aplicación a instalar. |
--version=VALUE | La versión del paquete a instalar; el valor predeterminado es instalar la última versión |
--feed-id=VALUE | La identificación del feed NuGet desde donde instalar el paquete; se puede omitir si solo se configura una fuente |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
app list
Enumere los paquetes de aplicaciones instalados.
Ejemplo:
seqcli app list
Opción | Descripción |
---|---|
--package-id=VALUE | La identificación del paquete de las aplicaciones a enumerar. |
-i , --id=VALUE | La identificación de una sola aplicación para enumerar. |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
app run
Aloje un complemento .NET [SeqApp]
.
Ejemplo:
seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]
Opción | Descripción |
---|---|
-d , --directory=VALUE | El directorio que contiene los ensamblados de .NET Standard; por defecto es el directorio actual |
--type=VALUE | El nombre del tipo de complemento [SeqApp]; El valor predeterminado es escanear ensamblajes para un solo tipo marcado con este atributo. |
-p , --property=NAME=VALUE | Especifique la configuración de nombre/valor para la aplicación, por ejemplo -p [email protected] -p Subject="Alert!" |
--storage=VALUE | Un directorio en el que se pueden almacenar datos específicos de la aplicación; por defecto es el directorio actual |
-s , --server=VALUE | La URL del servidor Seq, utilizada solo para la configuración de la aplicación (no se realiza ninguna conexión con el servidor); De forma predeterminada, se utilizará el valor de connection.serverUrl |
--server-instance=VALUE | El nombre de la instancia del servidor Seq, usado solo para la configuración de la aplicación; por defecto no tiene nombre de instancia |
-t , --title=VALUE | El título de la instancia de la aplicación, usado solo para la configuración de la aplicación; por defecto es un título de marcador de posición. |
--id=VALUE | La identificación de la instancia de la aplicación, que se usa solo para la configuración de la aplicación; El valor predeterminado es una identificación de marcador de posición. |
--read-env | Lea la configuración de la aplicación y los ajustes de las variables de entorno, como se especifica en https://docs.datalust.co/docs/seq-apps-in-other-languages; ignora todas las opciones excepto --directory y --type |
app uninstall
Desinstalar un paquete de aplicación.
Ejemplo:
seqcli app uninstall --package-id 'Seq.App.JsonArchive'
Opción | Descripción |
---|---|
--package-id=VALUE | La identificación del paquete de la aplicación para desinstalar. |
-i , --id=VALUE | La identificación de un único paquete de aplicación para desinstalar. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
app update
Actualice un paquete de aplicación instalado.
Ejemplo:
seqcli app update -n 'HTML Email'
Opción | Descripción |
---|---|
-i , --id=VALUE | La identificación de una única aplicación instalada para actualizar. |
-n , --name=VALUE | El nombre de la aplicación instalada para actualizar. |
--all | Actualice todas las aplicaciones instaladas; no compatible con -i o -n |
--version=VALUE | La versión del paquete a actualizar; el valor predeterminado es actualizar a la última versión en el feed asociado |
--force | Actualice la aplicación incluso si la versión de destino ya está instalada |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
appinstance create
Cree una instancia de una aplicación instalada.
Ejemplo:
seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]
Opción | Descripción |
---|---|
-t , --title=VALUE | Un título para la instancia de la aplicación. |
--app=VALUE | La identificación del paquete de aplicación instalado para crear una instancia. |
-p , --property=NAME=VALUE | Especifique la configuración de nombre/valor para la aplicación, por ejemplo -p [email protected] -p Subject="Alert!" |
--stream[=VALUE] | Transmita eventos entrantes a esta instancia de aplicación a medida que se ingieran; opcionalmente acepta una expresión de señal que limita qué eventos deben transmitirse, por ejemplo signal-1,signal-2 |
--overridable=VALUE | Especifique nombres de configuración que los usuarios pueden anular al invocar la aplicación |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
appinstance list
Enumere instancias de aplicaciones instaladas.
Ejemplo:
seqcli appinstance list
Opción | Descripción |
---|---|
-t , --title=VALUE | El título de las instancias de la aplicación que se enumerarán |
-i , --id=VALUE | La identificación de una única instancia de aplicación para enumerar |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
appinstance remove
Elimine una instancia de aplicación del servidor.
Ejemplo:
seqcli appinstance remove -t 'Email Ops'
Opción | Descripción |
---|---|
-t , --title=VALUE | El título de las instancias de la aplicación que se eliminarán. |
-i , --id=VALUE | La identificación de una única instancia de aplicación para eliminar. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
appinstance update
Actualice una instancia de aplicación existente.
Ejemplo:
seqcli appinstance update --json '{...}'
Opción | Descripción |
---|---|
--json=VALUE | La instancia de la aplicación actualizada en formato JSON; esto se puede producir usando seqcli appinstance list --json |
--json-stdin | Lea la instancia de la aplicación actualizada como JSON desde STDIN |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
bench
Mida el rendimiento de las consultas.
Opción | Descripción |
---|---|
-r , --runs=VALUE | El número de ejecuciones a ejecutar; el valor predeterminado es 10 |
-c , --cases=VALUE | Un archivo JSON que contiene el conjunto de casos a ejecutar. El valor predeterminado es un conjunto estándar de casos. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--start=VALUE | Fecha/hora ISO 8601 para realizar la consulta |
--end=VALUE | Fecha/hora ISO 8601 para realizar la consulta |
--reporting-server=VALUE | La dirección de un servidor Seq al que enviar resultados de banco. |
--reporting-apikey=VALUE | La clave API que se utilizará al conectarse al servidor de informes |
--description=VALUE | Descripción opcional de la ejecución de prueba en banco |
--with-ingestion | ¿Debería el punto de referencia incluir el envío de eventos a Seq? |
--with-queries | ¿Debería el punto de referencia incluir la consulta de Seq? |
config
Ver y configurar campos en el archivo SeqCli.json
; ejecute sin argumentos para enumerar todos los campos.
Opción | Descripción |
---|---|
-k , --key=VALUE | El campo, por ejemplo connection.serverUrl |
-v , --value=VALUE | El valor del campo; si no se especifica, el comando imprimirá el valor actual |
-c , --clear | Limpiar el campo |
dashboard list
Listar paneles.
Ejemplo:
seqcli dashboard list
Opción | Descripción |
---|---|
-t , --title=VALUE | El título de los paneles que se van a enumerar |
-i , --id=VALUE | La identificación de un único panel para enumerar |
-o , --owner=VALUE | La identificación del usuario para el cual enumerar los paneles; De forma predeterminada, se enumeran los paneles compartidos. |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
dashboard remove
Eliminar un panel del servidor.
Ejemplo:
seqcli dashboard remove -i dashboard-159
Opción | Descripción |
---|---|
-t , --title=VALUE | El título de los paneles que se van a eliminar |
-i , --id=VALUE | La identificación de un único panel para eliminar |
-o , --owner=VALUE | La identificación del usuario para quien se eliminarán los paneles; De forma predeterminada, los paneles compartidos se eliminan. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
dashboard render
Genere un conjunto de resultados CSV o JSON a partir de un gráfico del panel.
Ejemplo:
seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h
Opción | Descripción |
---|---|
-i , --id=VALUE | La identificación de un único panel para renderizar. |
-c , --chart=VALUE | El título de un gráfico en el tablero para representar. |
--last=VALUE | Una duración durante la cual se debe representar el gráfico, por ejemplo, 7d ; esto se alineará con un límite de intervalo; Se debe especificar --last o --start y --end |
--by=VALUE | El intervalo de tiempo para los datos del gráfico, como duración, por ejemplo, 1h |
--start=VALUE | Fecha/hora ISO 8601 para realizar la consulta |
--end=VALUE | Fecha/hora ISO 8601 para realizar la consulta |
--signal=VALUE | Una expresión de señal o una lista de identificadores de señales intersectadas para aplicar, por ejemplo signal-1,signal-2 |
--timeout=VALUE | El tiempo de espera de ejecución en milisegundos. |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
expressionindex create
Cree un índice de expresión.
Ejemplo:
seqcli expressionindex create --expression "ServerName"
Opción | Descripción |
---|---|
-e , --expression=VALUE | La expresión a indexar |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
expressionindex list
Listar índices de expresiones.
Ejemplo:
seqcli expressionindex list
Opción | Descripción |
---|---|
-i , --id=VALUE | La identificación de un índice de expresión única para enumerar. |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
expressionindex remove
Eliminar un índice de expresión del servidor.
Ejemplo:
seqcli expressionindex -i expressionindex-2529
Opción | Descripción |
---|---|
-i , --id=VALUE | La identificación de un índice de expresión para eliminar. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
feed create
Cree una fuente NuGet.
Ejemplo:
seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin
Opción | Descripción |
---|---|
-n , --name=VALUE | Un nombre único para el feed. |
-l , --location=VALUE | La ubicación del feed; Esta puede ser una URL de fuente NuGet v2 o v3, o una ruta del sistema de archivos local en el servidor Seq. |
-u , --username=VALUE | El nombre de usuario que Seq debe proporcionar al conectarse al feed, si se requiere autenticación |
-p , --password=VALUE | Una contraseña de feed, si se requiere autenticación; tenga en cuenta que --password-stdin es más seguro |
--password-stdin | Leer la contraseña del feed de STDIN |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
feed list
Enumere los feeds de NuGet.
Ejemplo:
seqcli feed list
Opción | Descripción |
---|---|
-n , --name=VALUE | El nombre del feed a listar. |
-i , --id=VALUE | La identificación de un único feed para enumerar. |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
feed remove
Elimine una fuente NuGet del servidor.
Ejemplo:
seqcli feed remove -n CI
Opción | Descripción |
---|---|
-n , --name=VALUE | El nombre del feed a eliminar. |
-i , --id=VALUE | La identificación de un único feed para eliminar. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
feed update
Actualice una fuente NuGet existente.
Ejemplo:
seqcli feed update --json '{...}'
Opción | Descripción |
---|---|
--json=VALUE | El feed NuGet actualizado en formato JSON; esto se puede producir usando seqcli feed list --json |
--json-stdin | Lea el feed NuGet actualizado como JSON desde STDIN |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
help
Muestra información sobre los comandos disponibles.
Ejemplo:
seqcli help search
Opción | Descripción |
---|---|
-m , --markdown | Generar rebajas para usar en la documentación. |
index list
Listar índices.
Ejemplo:
seqcli index list
Opción | Descripción |
---|---|
-i , --id=VALUE | La identificación de un único índice para enumerar. |
--json | Imprima la salida en JSON delimitado por nuevas líneas (el valor predeterminado es texto sin formato) |
--no-color | No colorear la salida de texto |
--force-color | Forzar que la salida redirigida tenga color ANSI (a menos que también se especifique --no-color ) |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
index suppress
Suprimir un índice.
Ejemplo:
seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748
Opción | Descripción |
---|---|
-i , --id=VALUE | La identificación de un índice para suprimir. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
ingest
Envía eventos de registro desde un archivo o STDIN
.
Ejemplo:
seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test
Opción | Descripción |
---|---|
-i , --input=VALUE | Archivo(s) a ingerir, incluido el comodín * ; si no se especifica, se utilizará STDIN |
--invalid-data=VALUE | Especifique cómo se manejan los datos no válidos: fail (predeterminado) o ignore |
-p , --property=NAME=VALUE | Especifique las propiedades de nombre/valor, por ejemplo -p Customer=C123 -p Environment=Production |
-x , --extract=VALUE | Un patrón de extracción para aplicar a registros de texto sin formato (ignorado cuando se especifica --json ) |
--json | Lea los eventos como JSON (el valor predeterminado asume texto sin formato) |
-f , --filter=VALUE | Filtrar expresión para seleccionar un subconjunto de eventos |
-m , --message=VALUE | Un mensaje para asociar con los eventos ingeridos; Se admite la sintaxis de https://messagetemplates.org |
-l , --level=VALUE | El nivel o gravedad a asociar con los eventos ingeridos; esto anulará cualquier información de nivel presente en los propios eventos |
--send-failure=VALUE | Especifique cómo se manejan los errores de conexión: fail (predeterminado), retry , continue o ignore |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, se utilizarán los valores de configuración connection.serverUrl y connection.apiKey |
--batch-size=VALUE | El número máximo de eventos que se enviarán en cada solicitud al punto final de ingesta; si no se especifica se utilizará un valor de 100 |
license apply
Aplicar una licencia al servidor Seq.
Ejemplo:
seqcli license apply --certificate="license.txt"
Opción | Descripción |
---|---|
-c , --certificate=VALUE | Archivo de certificado; el archivo debe ser texto UTF-8 |
--certificate-stdin | Leer el certificado de licencia de STDIN |
--automatically-refresh | Si la licencia es para una suscripción, consulte periódicamente datalust.co y actualice automáticamente el certificado cuando se cambie o renueve la suscripción. |
-s , --server=VALUE | La URL del servidor Seq; De forma predeterminada, se utilizará el valor de configuración connection.serverUrl |
-a , --apikey=VALUE | La clave API que se utilizará al conectarse al servidor; De forma predeterminada, se utilizará el valor de configuración connection.apiKey |
--profile=VALUE | Un perfil de conexión a utilizar; De forma predeterminada, los valores de configuración connection.serverUrl y connection.apiKey serán nosotros. |