seqcli
O aplicativo de linha de comando do cliente Seq. Suporta registro ( seqcli log
), pesquisa ( search
), tail ( tail
), consulta ( query
) e JSON ou ingestão de arquivo de log de texto simples ( ingest
) e muito mais.
O instalador Seq para Windows inclui seqcli
. Caso contrário, baixe a versão para o seu sistema operacional. Ou, se você tiver dotnet
instalado, seqcli
poderá ser instalado como uma ferramenta global usando:
dotnet tool install --global seqcli
Para definir um URL de servidor padrão e uma chave de API, execute:
seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key
A chave API será armazenada em seu arquivo de configuração SeqCli.json
; no Windows, isso é criptografado usando DPAPI; no Mac/Linux, a chave está atualmente armazenada em texto simples. Como alternativa ao armazenamento da chave API na configuração, ela pode ser passada para cada comando por meio do argumento --apikey=
.
seqcli
também está disponível como um contêiner Docker em datalust/seqcli
:
docker run --rm datalust/seqcli:latest <command> [<args>]
Para conectar-se ao Seq em um contêiner docker na máquina local, use o endereço IP da máquina (não localhost) ou especifique a rede do docker host com --net host
.
Use redes e volumes Docker para tornar arquivos locais e outros contêineres acessíveis ao seqcli
dentro de seu contêiner.
Cada valor de configuração pode ser substituído em tempo de execução especificando uma variável de ambiente no formato SEQCLI_<setting path>
, onde contém um elemento para cada segmento pontilhado do nome da configuração, separado por sublinhados.
Por exemplo, a configuração connection.serverUrl
pode ser substituída pela variável SEQCLI_CONNECTION_SERVERURL
.
Se você estiver automatizando a configuração do Seq, é provável que ainda não tenha uma chave de API para usar seqcli
. Durante a configuração inicial do servidor Seq, é possível especificar firstRun.adminUsername
e firstRun.adminPasswordHash
(ou as variáveis de ambiente equivalentes SEQ_FIRSTRUN_ADMINUSERNAME
e SEQ_FIRSTRUN_ADMINPASSWORDHASH
) para configurar um nome de usuário e uma senha iniciais para a conta do administrador. Você pode usá-los para criar uma chave de API e, em seguida, usar o token de chave de API com os comandos seqcli
restantes.
O comando seqcli apikey create
aceita --connect-username
e --connect-password-stdin
e imprime o novo token de chave API em STDOUT
(a sintaxe do PowerShell é usada abaixo):
$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
.
Ao conectar-se com uma chave de API, as operações permitidas são determinadas pelas permissões atribuídas a essa chave de API.
Para determinar a permissão necessária para um comando, verifique a coluna 'Exigência de permissão' da operação equivalente da API do servidor. Por exemplo, o comando apikey create
usa o endpoint POST api/apikeys
, que requer a permissão Write
.
Todos os comandos seqcli
seguem o mesmo padrão:
seqcli <command> [<args>]
A lista completa de comandos suportados pode ser visualizada executando:
seqcli help
Para mostrar informações de uso de um comando específico, execute seqcli help <command>
, por exemplo:
seqcli help apikey create
Isto também funciona para grupos de comando; para listar todos os subcomandos apikey
, execute:
seqcli help apikey
apikey
apikey create
— Crie uma chave de API para automação ou ingestão.apikey list
— Lista as chaves de API disponíveis.apikey remove
— Remova uma chave de API do servidor.apikey update
— Atualize uma chave de API existente.app
app define
— Gere uma definição de aplicativo para um plug-in .NET [SeqApp]
.app install
— Instale um pacote de aplicativo.app list
— Lista pacotes de aplicativos instalados.app run
– hospede um plug-in .NET [SeqApp]
.app uninstall
— Desinstale um pacote de aplicativo.app update
— Atualize um pacote de aplicativo instalado.appinstance
appinstance create
— Crie uma instância de um aplicativo instalado.appinstance list
— Lista instâncias de aplicativos instalados.appinstance remove
— Remove uma instância de aplicativo do servidor.appinstance update
— Atualize uma instância de aplicativo existente.bench
– Meça o desempenho da consulta.config
— Visualize e defina campos no arquivo SeqCli.json
; execute sem argumentos para listar todos os campos.dashboard
dashboard list
— Lista painéis.dashboard remove
— Remova um painel do servidor.dashboard render
— Produza um conjunto de resultados CSV ou JSON a partir de um gráfico do painel.expressionindex
expressionindex create
— Crie um índice de expressão.expressionindex list
— Lista índices de expressões.expressionindex remove
— Remove um índice de expressão do servidor.feed
feed create
— Crie um feed NuGet.feed list
— Lista feeds do NuGet.feed remove
— Remova um feed NuGet do servidor.feed update
— Atualize um feed NuGet existente.help
— Mostra informações sobre os comandos disponíveis.index
index list
— Lista índices.index suppress
— Suprime um índice.ingest
— Envie eventos de log de um arquivo ou STDIN
.license apply
— Aplique uma licença ao servidor Seq.log
— Envie um evento de log estruturado para o servidor.node
node demote
— Inicia o rebaixamento do nó líder atual.node health
— Teste o endpoint /health
de um nó Seq e imprima o código de status HTTP retornado ou 'Inacessível' se o endpoint não puder ser consultado.node list
— lista os nós no cluster Seq.print
— Imprime eventos em formato CLEF/JSON, de um arquivo ou STDIN
.profile
profile create
— Crie ou substitua um perfil de conexão.profile list
— Lista perfis de conexão.profile remove
— Remova um perfil de conexão.query
— Execute uma consulta SQL e receba resultados em formato CSV.retention
retention create
— Crie uma política de retenção.retention list
— Lista políticas de retenção.retention remove
— Remova uma política de retenção do servidor.retention update
— Atualize uma política de retenção existente.sample
sample ingest
— Registra eventos de amostra em uma instância do Seq.sample setup
— Configure uma instância do Seq com painéis de amostra, sinais, usuários e assim por diante.search
— Recupera eventos de log que correspondem a um determinado filtro.setting
setting clear
— Limpa uma configuração de servidor configurável em tempo de execução.setting names
— Imprima os nomes de todas as configurações suportadas.setting set
— Altere uma configuração de servidor configurável em tempo de execução.setting show
— Imprime o valor atual de uma configuração de servidor configurável em tempo de execução.signal
signal create
— Crie um sinal.signal import
— Importe sinais em formato JSON delimitado por nova linha.signal list
— Lista os sinais disponíveis.signal remove
— Remove um sinal do servidor.signal update
— Atualize um sinal existente.tail
— Transmita eventos de log que correspondem a um filtro.template
template export
— Exporte entidades para arquivos de modelo.template import
— Importe entidades de arquivos de modelo.user
user create
— Crie um usuário.user list
— Lista usuários.user remove
— Remove um usuário do servidor.user update
— Atualize um usuário existente.version
— Imprime a versão executável atual.workspace
workspace create
— Crie um espaço de trabalho.workspace list
— Lista os espaços de trabalho disponíveis.workspace remove
— Remova um espaço de trabalho do servidor.workspace update
— Atualize um espaço de trabalho existente.apikey create
Crie uma chave de API para automação ou ingestão.
Exemplo:
seqcli apikey create -t 'Test API Key' -p Environment=Test
Opção | Descrição |
---|---|
-t , --title=VALUE | Um título para a chave API |
--token=VALUE | Um token de chave de API pré-alocado; por padrão, um novo token será gerado e gravado em STDOUT |
-p , --property=NAME=VALUE | Especifique propriedades de nome/valor, por exemplo -p Customer=C123 -p Environment=Production |
--filter=VALUE | Um filtro para aplicar aos eventos recebidos |
--minimum-level=VALUE | O nível/gravidade mínimo do evento a ser aceito; o padrão é aceitar todos os eventos |
--use-server-timestamps | Descarte os carimbos de data/hora fornecidos pelo cliente e use os valores do relógio do servidor |
--permissions=VALUE | Uma lista separada por vírgulas de permissões para delegar à chave de API; permissões válidas são Ingest (padrão), Read , Write , Project e System |
--connect-username=VALUE | Um nome de usuário para se conectar, útil principalmente ao configurar a primeira chave de API; servidores com assinatura 'Individual' permitem apenas uma solicitação simultânea com esta opção |
--connect-password=VALUE | Quando connect-username é especificado, uma senha correspondente |
--connect-password-stdin | Quando connect-username for especificado, leia a senha correspondente em STDIN |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
apikey list
Liste as chaves de API disponíveis.
Exemplo:
seqcli apikey list
Opção | Descrição |
---|---|
-t , --title=VALUE | O título das chaves de API a serem listadas |
-i , --id=VALUE | O ID de uma única chave de API a ser listada |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
apikey remove
Remova uma chave de API do servidor.
Exemplo:
seqcli apikey remove -t 'Test API Key'
Opção | Descrição |
---|---|
-t , --title=VALUE | O título das chaves de API a serem removidas |
-i , --id=VALUE | O ID de uma única chave de API a ser removida |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
apikey update
Atualize uma chave de API existente.
Exemplo:
seqcli apikey update --json '{...}'
Opção | Descrição |
---|---|
--json=VALUE | A chave de API atualizada no formato JSON; isso pode ser produzido usando seqcli apikey list --json |
--json-stdin | Leia a chave de API atualizada como JSON do STDIN |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
app define
Gere uma definição de aplicativo para um plug-in .NET [SeqApp]
.
Exemplo:
seqcli app define -d "./bin/Debug/netstandard2.2"
Opção | Descrição |
---|---|
-d , --directory=VALUE | O diretório que contém os assemblies do .NET Standard; o padrão é o diretório atual |
--type=VALUE | O nome do tipo de plug-in [SeqApp]; o padrão é verificar assemblies para um único tipo marcado com este atributo |
--indented | Formate a definição em várias linhas com recuo |
app install
Instale um pacote de aplicativo.
Exemplo:
seqcli app install --package-id 'Seq.App.JsonArchive'
Opção | Descrição |
---|---|
--package-id=VALUE | O ID do pacote do aplicativo a ser instalado |
--version=VALUE | A versão do pacote a ser instalado; o padrão é instalar a versão mais recente |
--feed-id=VALUE | O ID do feed do NuGet do qual instalar o pacote; pode ser omitido se apenas um feed estiver configurado |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
app list
Listar pacotes de aplicativos instalados.
Exemplo:
seqcli app list
Opção | Descrição |
---|---|
--package-id=VALUE | O ID do pacote dos aplicativos a serem listados |
-i , --id=VALUE | O ID de um único aplicativo a ser listado |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
app run
Hospede um plug-in .NET [SeqApp]
.
Exemplo:
seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]
Opção | Descrição |
---|---|
-d , --directory=VALUE | O diretório que contém os assemblies do .NET Standard; o padrão é o diretório atual |
--type=VALUE | O nome do tipo de plug-in [SeqApp]; o padrão é verificar assemblies para um único tipo marcado com este atributo |
-p , --property=NAME=VALUE | Especifique as configurações de nome/valor para o aplicativo, por exemplo -p [email protected] -p Subject="Alert!" |
--storage=VALUE | Um diretório no qual dados específicos do aplicativo podem ser armazenados; o padrão é o diretório atual |
-s , --server=VALUE | A URL do servidor Seq, usada apenas para configuração do aplicativo (nenhuma conexão é feita com o servidor); por padrão, o valor connection.serverUrl será usado |
--server-instance=VALUE | O nome da instância do servidor Seq, usado apenas para configuração do aplicativo; o padrão é nenhum nome de instância |
-t , --title=VALUE | O título da instância do aplicativo, usado somente para configuração do aplicativo; o padrão é um título de espaço reservado. |
--id=VALUE | O ID da instância do aplicativo, usado apenas para configuração do aplicativo; o padrão é um ID de espaço reservado. |
--read-env | Leia a configuração e as configurações do aplicativo a partir de variáveis de ambiente, conforme especificado em https://docs.datalust.co/docs/seq-apps-in-other-languages; ignora todas as opções exceto --directory e --type |
app uninstall
Desinstale um pacote de aplicativos.
Exemplo:
seqcli app uninstall --package-id 'Seq.App.JsonArchive'
Opção | Descrição |
---|---|
--package-id=VALUE | O ID do pacote do aplicativo a ser desinstalado |
-i , --id=VALUE | O ID de um único pacote de aplicativo a ser desinstalado |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
app update
Atualize um pacote de aplicativo instalado.
Exemplo:
seqcli app update -n 'HTML Email'
Opção | Descrição |
---|---|
-i , --id=VALUE | O ID de um único aplicativo instalado para atualizar |
-n , --name=VALUE | O nome do aplicativo instalado para atualizar |
--all | Atualize todos os aplicativos instalados; não é compatível com -i ou -n |
--version=VALUE | A versão do pacote para a qual atualizar; o padrão é atualizar para a versão mais recente no feed associado |
--force | Atualize o aplicativo mesmo que a versão de destino já esteja instalada |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
appinstance create
Crie uma instância de um aplicativo instalado.
Exemplo:
seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]
Opção | Descrição |
---|---|
-t , --title=VALUE | Um título para a instância do aplicativo |
--app=VALUE | O ID do pacote de aplicativos instalado para instanciar |
-p , --property=NAME=VALUE | Especifique as configurações de nome/valor para o aplicativo, por exemplo -p [email protected] -p Subject="Alert!" |
--stream[=VALUE] | Transmita eventos recebidos para esta instância do aplicativo à medida que são ingeridos; opcionalmente aceita uma expressão de sinal limitando quais eventos devem ser transmitidos, por exemplo signal-1,signal-2 |
--overridable=VALUE | Especifique nomes de configurações que podem ser substituídos pelos usuários ao invocar o aplicativo |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
appinstance list
Listar instâncias de aplicativos instalados.
Exemplo:
seqcli appinstance list
Opção | Descrição |
---|---|
-t , --title=VALUE | O título das instâncias do aplicativo a serem listadas |
-i , --id=VALUE | O ID de uma única instância de aplicativo a ser listada |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
appinstance remove
Remova uma instância de aplicativo do servidor.
Exemplo:
seqcli appinstance remove -t 'Email Ops'
Opção | Descrição |
---|---|
-t , --title=VALUE | O título das instâncias do aplicativo a serem removidas |
-i , --id=VALUE | O ID de uma única instância de aplicativo a ser removida |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
appinstance update
Atualize uma instância de aplicativo existente.
Exemplo:
seqcli appinstance update --json '{...}'
Opção | Descrição |
---|---|
--json=VALUE | A instância do aplicativo atualizada no formato JSON; isso pode ser produzido usando seqcli appinstance list --json |
--json-stdin | Leia a instância do aplicativo atualizada como JSON do STDIN |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
bench
Meça o desempenho da consulta.
Opção | Descrição |
---|---|
-r , --runs=VALUE | O número de execuções a serem executadas; o padrão é 10 |
-c , --cases=VALUE | Um arquivo JSON contendo o conjunto de casos a serem executados. O padrão é um conjunto padrão de casos. |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--start=VALUE | Data/hora ISO 8601 para consulta de |
--end=VALUE | Data/hora ISO 8601 para consulta |
--reporting-server=VALUE | O endereço de um servidor Seq para enviar resultados de bancada |
--reporting-apikey=VALUE | A chave de API a ser usada ao conectar-se ao servidor de relatórios |
--description=VALUE | Descrição opcional do teste de bancada |
--with-ingestion | O benchmark deve incluir o envio de eventos para Seq |
--with-queries | O benchmark deve incluir a consulta de Seq |
config
Visualize e defina campos no arquivo SeqCli.json
; execute sem argumentos para listar todos os campos.
Opção | Descrição |
---|---|
-k , --key=VALUE | O campo, por exemplo connection.serverUrl |
-v , --value=VALUE | O valor do campo; se não for especificado, o comando imprimirá o valor atual |
-c , --clear | Limpe o campo |
dashboard list
Listar painéis.
Exemplo:
seqcli dashboard list
Opção | Descrição |
---|---|
-t , --title=VALUE | O título dos painéis a serem listados |
-i , --id=VALUE | O ID de um único painel a ser listado |
-o , --owner=VALUE | O ID do usuário para o qual listar os painéis; por padrão, os painéis compartilhados são listados |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
dashboard remove
Remova um painel do servidor.
Exemplo:
seqcli dashboard remove -i dashboard-159
Opção | Descrição |
---|---|
-t , --title=VALUE | O título dos painéis a serem removidos |
-i , --id=VALUE | O ID de um único painel a ser removido |
-o , --owner=VALUE | O ID do usuário do qual remover os painéis; por padrão, os painéis compartilhados são removidos |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
dashboard render
Produza um conjunto de resultados CSV ou JSON a partir de um gráfico de painel.
Exemplo:
seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h
Opção | Descrição |
---|---|
-i , --id=VALUE | O ID de um único painel a ser renderizado |
-c , --chart=VALUE | O título de um gráfico no painel a ser renderizado |
--last=VALUE | Uma duração durante a qual o gráfico deve ser renderizado, por exemplo, 7d ; isso será alinhado a um limite de intervalo; ou --last ou --start e --end devem ser especificados |
--by=VALUE | O intervalo de tempo para os dados do gráfico, como duração, por exemplo, 1h |
--start=VALUE | Data/hora ISO 8601 para consulta de |
--end=VALUE | Data/hora ISO 8601 para consulta |
--signal=VALUE | Uma expressão de sinal ou lista de IDs de sinal cruzados a serem aplicados, por exemplo signal-1,signal-2 |
--timeout=VALUE | O tempo limite de execução em milissegundos |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
expressionindex create
Crie um índice de expressão.
Exemplo:
seqcli expressionindex create --expression "ServerName"
Opção | Descrição |
---|---|
-e , --expression=VALUE | A expressão a indexar |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
expressionindex list
Listar índices de expressão.
Exemplo:
seqcli expressionindex list
Opção | Descrição |
---|---|
-i , --id=VALUE | O id de um único índice de expressão a ser listado |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
expressionindex remove
Remova um índice de expressão do servidor.
Exemplo:
seqcli expressionindex -i expressionindex-2529
Opção | Descrição |
---|---|
-i , --id=VALUE | O id de um índice de expressão a ser removido |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
feed create
Crie um feed NuGet.
Exemplo:
seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin
Opção | Descrição |
---|---|
-n , --name=VALUE | Um nome exclusivo para o feed |
-l , --location=VALUE | O local da alimentação; este pode ser um URL de feed do NuGet v2 ou v3 ou um caminho do sistema de arquivos local no servidor Seq |
-u , --username=VALUE | O nome de usuário Seq deve ser fornecido ao conectar-se ao feed, se a autenticação for necessária |
-p , --password=VALUE | Uma senha de feed, se for necessária autenticação; observe que --password-stdin é mais seguro |
--password-stdin | Leia a senha do feed do STDIN |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
feed list
Listar feeds do NuGet.
Exemplo:
seqcli feed list
Opção | Descrição |
---|---|
-n , --name=VALUE | O nome do feed a ser listado |
-i , --id=VALUE | O ID de um único feed a ser listado |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
feed remove
Remova um feed NuGet do servidor.
Exemplo:
seqcli feed remove -n CI
Opção | Descrição |
---|---|
-n , --name=VALUE | O nome do feed a ser removido |
-i , --id=VALUE | O ID de um único feed a ser removido |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
feed update
Atualize um feed NuGet existente.
Exemplo:
seqcli feed update --json '{...}'
Opção | Descrição |
---|---|
--json=VALUE | O feed NuGet atualizado no formato JSON; isso pode ser produzido usando seqcli feed list --json |
--json-stdin | Leia o feed NuGet atualizado como JSON do STDIN |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
help
Mostrar informações sobre os comandos disponíveis.
Exemplo:
seqcli help search
Opção | Descrição |
---|---|
-m , --markdown | Gerar descontos para uso na documentação |
index list
Listar índices.
Exemplo:
seqcli index list
Opção | Descrição |
---|---|
-i , --id=VALUE | O id de um único índice a ser listado |
--json | Imprimir saída em JSON delimitado por nova linha (o padrão é texto simples) |
--no-color | Não colorize a saída de texto |
--force-color | Forçar a saída redirecionada para ter cor ANSI (a menos que --no-color também seja especificado) |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
index suppress
Suprimir um índice.
Exemplo:
seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748
Opção | Descrição |
---|---|
-i , --id=VALUE | O id de um índice a ser suprimido |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
ingest
Envie eventos de log de um arquivo ou STDIN
.
Exemplo:
seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test
Opção | Descrição |
---|---|
-i , --input=VALUE | Arquivo(s) a serem ingeridos, incluindo o curinga * ; se não for especificado, STDIN será usado |
--invalid-data=VALUE | Especifique como os dados inválidos são tratados: fail (padrão) ou ignore |
-p , --property=NAME=VALUE | Especifique propriedades de nome/valor, por exemplo -p Customer=C123 -p Environment=Production |
-x , --extract=VALUE | Um padrão de extração a ser aplicado a logs de texto simples (ignorado quando --json é especificado) |
--json | Leia os eventos como JSON (o padrão assume texto simples) |
-f , --filter=VALUE | Expressão de filtro para selecionar um subconjunto de eventos |
-m , --message=VALUE | Uma mensagem para associar aos eventos ingeridos; A sintaxe https://messagetemplates.org é suportada |
-l , --level=VALUE | O nível ou gravidade a ser associado aos eventos ingeridos; isso substituirá qualquer informação de nível presente nos próprios eventos |
--send-failure=VALUE | Especifique como as falhas de conexão são tratadas: fail (padrão), retry , continue ou ignore |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão usados |
--batch-size=VALUE | O número máximo de eventos a serem enviados em cada solicitação ao endpoint de ingestão; se não for especificado, um valor de 100 será usado |
license apply
Aplique uma licença ao servidor Seq.
Exemplo:
seqcli license apply --certificate="license.txt"
Opção | Descrição |
---|---|
-c , --certificate=VALUE | Arquivo de certificado; o arquivo deve ser texto UTF-8 |
--certificate-stdin | Leia o certificado de licença do STDIN |
--automatically-refresh | Se a licença for por assinatura, verifique periodicamente datalust.co e atualize automaticamente o certificado quando a assinatura for alterada ou renovada |
-s , --server=VALUE | A URL do servidor Seq; por padrão, o valor de configuração connection.serverUrl será usado |
-a , --apikey=VALUE | A chave API a ser usada ao conectar-se ao servidor; por padrão, o valor de configuração connection.apiKey será usado |
--profile=VALUE | Um perfil de conexão a ser usado; por padrão, os valores de configuração connection.serverUrl e connection.apiKey serão nós |