seqcli
Seq 客户端命令行应用程序。支持日志记录 ( seqcli log
)、搜索 ( search
)、拖尾 ( tail
)、查询 ( query
) 和 JSON 或纯文本日志文件摄取 ( ingest
) 等等。
适用于 Windows 的 Seq 安装程序包括seqcli
。否则,请下载适合您的操作系统的版本。或者,如果您安装了dotnet
,则可以使用以下命令将seqcli
安装为全局工具:
dotnet tool install --global seqcli
要设置默认服务器 URL 和 API 密钥,请运行:
seqcli config -k connection.serverUrl -v https://your-seq-server
seqcli config -k connection.apiKey -v your-api-key
API密钥将存储在您的SeqCli.json
配置文件中;在 Windows 上,这是使用 DPAPI 加密的;在 Mac/Linux 上,密钥当前以纯文本形式存储。作为在配置中存储 API 密钥的替代方法,可以通过--apikey=
参数将其传递给每个命令。
seqcli
也可以作为datalust/seqcli
下的 Docker 容器使用:
docker run --rm datalust/seqcli:latest <command> [<args>]
要连接到本地计算机上 docker 容器中的 Seq,请使用计算机的 IP 地址(而不是 localhost)或使用--net host
指定 docker 主机网络。
使用 Docker 网络和卷使本地文件和其他容器可供seqcli
在其容器内访问。
每个设置值都可以在运行时通过指定SEQCLI_<setting path>
形式的环境变量来覆盖,其中设置名称的每个点部分包含一个元素,并用下划线分隔。
例如,设置connection.serverUrl
可以用SEQCLI_CONNECTION_SERVERURL
变量覆盖。
如果您要自动化 Seq 设置,那么您很可能还没有可供seqcli
使用的 API 密钥。在初始Seq服务器配置期间,您可以指定firstRun.adminUsername
和firstRun.adminPasswordHash
(或等效的环境变量SEQ_FIRSTRUN_ADMINUSERNAME
和SEQ_FIRSTRUN_ADMINPASSWORDHASH
)来设置管理员帐户的初始用户名和密码。您可以使用它们创建 API 密钥,然后将 API 密钥令牌与其余seqcli
命令一起使用。
seqcli apikey create
命令接受--connect-username
和--connect-password-stdin
,并将新的 API 密钥令牌打印到STDOUT
(下面使用 PowerShell 语法):
$user = "admin"
$pw = "thepassword"
$token = (
echo $pw |
seqcli apikey create `
-t CLI `
--permissions="Read,Write,Project,Organization,System" `
--connect-username $user --connect-password-stdin
)
请参阅CONTRIBUTING.md
。
使用 API 密钥连接时,允许的操作由分配给该 API 密钥的权限确定。
要确定命令所需的权限,请检查等效服务器 API 操作的“权限需求”列。例如,命令apikey create
使用POST api/apikeys
端点,这需要Write
权限。
所有seqcli
命令都遵循相同的模式:
seqcli <command> [<args>]
可以通过运行以下命令查看支持的命令的完整列表:
seqcli help
要显示特定命令的使用信息,请运行seqcli help <command>
,例如:
seqcli help apikey create
这也适用于指挥组;要列出所有apikey
子命令,请运行:
seqcli help apikey
apikey
apikey create
— 创建用于自动化或摄取的 API 密钥。apikey list
— 列出可用的 API 密钥。apikey remove
— 从服务器中删除 API 密钥。apikey update
— 更新现有的 API 密钥。app
app define
— 为 .NET [SeqApp]
插件生成应用程序定义。app install
— 安装应用程序包。app list
— 列出已安装的应用程序包。app run
— 托管 .NET [SeqApp]
插件。app uninstall
— 卸载应用程序包。app update
— 更新已安装的应用程序包。appinstance
appinstance create
— 创建已安装应用程序的实例。appinstance list
— 列出已安装应用程序的实例。appinstance remove
— 从服务器中删除应用程序实例。appinstance update
— 更新现有的应用程序实例。bench
— 衡量查询性能。config
— 查看和设置SeqCli.json
文件中的字段;不带参数运行以列出所有字段。dashboard
dashboard list
— 列出仪表板。dashboard remove
— 从服务器中删除仪表板。dashboard render
— 从仪表板图表生成 CSV 或 JSON 结果集。expressionindex
expressionindex create
— 创建表达式索引。expressionindex list
— 列出表达式索引。expressionindex remove
— 从服务器中删除表达式索引。feed
feed create
— 创建 NuGet feed。feed list
— 列出 NuGet feed。feed remove
— 从服务器中删除 NuGet feed。feed update
— 更新现有的 NuGet feed。help
— 显示有关可用命令的信息。index
index list
— 列出索引。index suppress
— 抑制索引。ingest
- 从文件或STDIN
发送日志事件。license apply
— 将许可证应用于 Seq 服务器。log
— 将结构化日志事件发送到服务器。node
node demote
— 开始降级当前领导节点。node health
— 探测 Seq 节点的/health
端点,并打印返回的 HTTP 状态代码,如果无法查询端点,则打印“无法访问”。node list
— 列出 Seq 集群中的节点。print
- 来自文件或STDIN
CLEF/JSON 格式的漂亮打印事件。profile
profile create
— 创建或替换连接配置文件。profile list
— 列出连接配置文件。profile remove
— 删除连接配置文件。query
— 执行 SQL 查询并接收 CSV 格式的结果。retention
retention create
— 创建保留策略。retention list
— 列出保留策略。retention remove
— 从服务器中删除保留策略。retention update
— 更新现有保留策略。sample
sample ingest
- 将样本事件记录到 Seq 实例中。sample setup
- 使用示例仪表板、信号、用户等配置 Seq 实例。search
— 检索与给定过滤器匹配的日志事件。setting
setting clear
— 清除运行时可配置的服务器设置。setting names
— 打印所有支持的设置的名称。setting set
— 更改运行时可配置的服务器设置。setting show
— 打印运行时可配置服务器设置的当前值。signal
signal create
— 创建信号。signal import
— 以换行符分隔的 JSON 格式导入信号。signal list
— 列出可用信号。signal remove
— 从服务器中删除信号。signal update
— 更新现有信号。tail
— 与过滤器匹配的流日志事件。template
template export
— 将实体导出到模板文件中。template import
— 从模板文件导入实体。user
user create
— 创建用户。user list
— 列出用户。user remove
— 从服务器中删除用户。user update
— 更新现有用户。version
— 打印当前可执行版本。workspace
workspace create
— 创建工作区。workspace list
— 列出可用的工作区。workspace remove
— 从服务器中删除工作区。workspace update
— 更新现有工作区。apikey create
创建用于自动化或摄取的 API 密钥。
例子:
seqcli apikey create -t 'Test API Key' -p Environment=Test
选项 | 描述 |
---|---|
-t , --title=VALUE | API 密钥的标题 |
--token=VALUE | 预先分配的 API 密钥令牌;默认情况下,将生成一个新令牌并将其写入STDOUT |
-p , --property=NAME=VALUE | 指定名称/值属性,例如-p Customer=C123 -p Environment=Production |
--filter=VALUE | 应用于传入事件的过滤器 |
--minimum-level=VALUE | 可接受的最低事件级别/严重性;默认是接受所有事件 |
--use-server-timestamps | 丢弃客户端提供的时间戳并使用服务器时钟值 |
--permissions=VALUE | 以逗号分隔的权限列表,委托给 API 密钥;有效权限为Ingest (默认)、 Read 、 Write 、 Project 和System |
--connect-username=VALUE | 用于连接的用户名,主要在设置第一个 API 密钥时有用;具有“个人”订阅的服务器仅允许使用此选项的一个同时请求 |
--connect-password=VALUE | 当指定connect-username 时,对应的密码 |
--connect-password-stdin | 当指定connect-username 时,从STDIN 读取对应的密码 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下将使用connection.serverUrl 和connection.apiKey 配置值 |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
apikey list
列出可用的 API 密钥。
例子:
seqcli apikey list
选项 | 描述 |
---|---|
-t , --title=VALUE | 要列出的 API 密钥的标题 |
-i , --id=VALUE | 要列出的单个 API 密钥的 ID |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
apikey remove
从服务器中删除 API 密钥。
例子:
seqcli apikey remove -t 'Test API Key'
选项 | 描述 |
---|---|
-t , --title=VALUE | 要删除的 API 密钥的标题 |
-i , --id=VALUE | 要删除的单个 API 密钥的 ID |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
apikey update
更新现有的 API 密钥。
例子:
seqcli apikey update --json '{...}'
选项 | 描述 |
---|---|
--json=VALUE | 更新后的 JSON 格式的 API 密钥;这可以使用seqcli apikey list --json 生成 |
--json-stdin | 从STDIN 读取更新后的 JSON 格式的 API 密钥 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
app define
为 .NET [SeqApp]
插件生成应用程序定义。
例子:
seqcli app define -d "./bin/Debug/netstandard2.2"
选项 | 描述 |
---|---|
-d , --directory=VALUE | 包含 .NET Standard 程序集的目录;默认为当前目录 |
--type=VALUE | [SeqApp]插件类型名称;默认扫描程序集以查找标有此属性的单一类型 |
--indented | 使用缩进设置多行定义的格式 |
app install
安装应用程序包。
例子:
seqcli app install --package-id 'Seq.App.JsonArchive'
选项 | 描述 |
---|---|
--package-id=VALUE | 要安装的应用程序的包 ID |
--version=VALUE | 要安装的软件包版本;默认安装最新版本 |
--feed-id=VALUE | 用于安装包的 NuGet feed 的 id;如果只配置了一个 feed,则可以省略 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
app list
列出已安装的应用程序包。
例子:
seqcli app list
选项 | 描述 |
---|---|
--package-id=VALUE | 要列出的应用程序的包 ID |
-i , --id=VALUE | 要列出的单个应用程序的 ID |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
app run
托管 .NET [SeqApp]
插件。
例子:
seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p [email protected]
选项 | 描述 |
---|---|
-d , --directory=VALUE | 包含 .NET Standard 程序集的目录;默认为当前目录 |
--type=VALUE | [SeqApp]插件类型名称;默认扫描程序集以查找标有此属性的单一类型 |
-p , --property=NAME=VALUE | 指定应用程序的名称/值设置,例如-p [email protected] -p Subject="Alert!" |
--storage=VALUE | 可以存储应用程序特定数据的目录;默认为当前目录 |
-s , --server=VALUE | Seq服务器的URL,仅用于应用程序配置(不连接到服务器);默认情况下将使用connection.serverUrl 值 |
--server-instance=VALUE | Seq服务器的实例名称,仅用于应用程序配置;默认没有实例名称 |
-t , --title=VALUE | 应用实例标题,仅用于应用配置;默认为占位符标题。 |
--id=VALUE | 应用实例id,仅用于应用配置;默认为占位符 id。 |
--read-env | 从环境变量中读取应用程序配置和设置,如 https://docs.datalust.co/docs/seq-apps-in-other-languages 中指定的;忽略除 --directory 和 --type 之外的所有选项 |
app uninstall
卸载应用程序包。
例子:
seqcli app uninstall --package-id 'Seq.App.JsonArchive'
选项 | 描述 |
---|---|
--package-id=VALUE | 要卸载的应用程序包的包id |
-i , --id=VALUE | 待卸载的单个应用包id |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
app update
更新已安装的应用程序包。
例子:
seqcli app update -n 'HTML Email'
选项 | 描述 |
---|---|
-i , --id=VALUE | 要更新的单个已安装应用程序的 ID |
-n , --name=VALUE | 要更新的已安装应用程序的名称 |
--all | 更新所有已安装的应用程序;与-i 或-n 不兼容 |
--version=VALUE | 要更新到的软件包版本;默认是更新到关联 feed 中的最新版本 |
--force | 即使已安装目标版本也更新应用程序 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
appinstance create
创建已安装应用程序的实例。
例子:
seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p [email protected]
选项 | 描述 |
---|---|
-t , --title=VALUE | 应用程序实例的标题 |
--app=VALUE | 要实例化的已安装应用包的id |
-p , --property=NAME=VALUE | 指定应用程序的名称/值设置,例如-p [email protected] -p Subject="Alert!" |
--stream[=VALUE] | 在摄取传入事件时将其流式传输到此应用程序实例;可选择接受限制应流式传输哪些事件的信号表达式,例如signal-1,signal-2 |
--overridable=VALUE | 指定调用应用程序时用户可能覆盖的设置名称 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下将使用connection.serverUrl 和connection.apiKey 配置值 |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
appinstance list
列出已安装应用程序的实例。
例子:
seqcli appinstance list
选项 | 描述 |
---|---|
-t , --title=VALUE | 要列出的应用程序实例的标题 |
-i , --id=VALUE | 要列出的单个应用程序实例的 ID |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
appinstance remove
从服务器中删除应用程序实例。
例子:
seqcli appinstance remove -t 'Email Ops'
选项 | 描述 |
---|---|
-t , --title=VALUE | 要删除的应用程序实例的标题 |
-i , --id=VALUE | 要删除的单个应用程序实例的 id |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
appinstance update
更新现有应用程序实例。
例子:
seqcli appinstance update --json '{...}'
选项 | 描述 |
---|---|
--json=VALUE | JSON格式的更新后的应用程序实例;这可以使用seqcli appinstance list --json 生成 |
--json-stdin | 从STDIN 以 JSON 形式读取更新的应用程序实例 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
bench
衡量查询性能。
选项 | 描述 |
---|---|
-r , --runs=VALUE | 要执行的运行次数;默认值为 10 |
-c , --cases=VALUE | 包含要运行的案例集的 JSON 文件。默认为一组标准案例。 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
--start=VALUE | 查询的 ISO 8601 日期/时间 |
--end=VALUE | 要查询的 ISO 8601 日期/时间 |
--reporting-server=VALUE | 将基准结果发送到的 Seq 服务器的地址 |
--reporting-apikey=VALUE | 连接到报告服务器时使用的 API 密钥 |
--description=VALUE | 台架测试运行的可选描述 |
--with-ingestion | 基准测试是否应该包括向 Seq 发送事件 |
--with-queries | 基准测试是否应该包括查询 Seq |
config
查看和设置SeqCli.json
文件中的字段;不带参数运行以列出所有字段。
选项 | 描述 |
---|---|
-k , --key=VALUE | 该字段,例如connection.serverUrl |
-v , --value=VALUE | 字段值;如果未指定,该命令将打印当前值 |
-c , --clear | 清除字段 |
dashboard list
列出仪表板。
例子:
seqcli dashboard list
选项 | 描述 |
---|---|
-t , --title=VALUE | 要列出的仪表板的标题 |
-i , --id=VALUE | 要列出的单个仪表板的 ID |
-o , --owner=VALUE | 为其列出仪表板的用户 ID;默认情况下,列出共享仪表板 |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
dashboard remove
从服务器中删除仪表板。
例子:
seqcli dashboard remove -i dashboard-159
选项 | 描述 |
---|---|
-t , --title=VALUE | 要删除的仪表板的标题 |
-i , --id=VALUE | 要删除的单个仪表板的 ID |
-o , --owner=VALUE | 要为其删除仪表板的用户 ID;默认情况下,共享仪表板被删除 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
dashboard render
从仪表板图表生成 CSV 或 JSON 结果集。
例子:
seqcli dashboard render -i dashboard-159 -c 'Response Time (ms)' --last 7d --by 1h
选项 | 描述 |
---|---|
-i , --id=VALUE | 要呈现的单个仪表板的 ID |
-c , --chart=VALUE | 仪表板上要呈现的图表的标题 |
--last=VALUE | 图表渲染的持续时间,例如7d ;这将与间隔边界对齐;必须指定--last 或--start 和--end |
--by=VALUE | 图表数据的时间片间隔,作为持续时间,例如1h |
--start=VALUE | 查询的 ISO 8601 日期/时间 |
--end=VALUE | 要查询的 ISO 8601 日期/时间 |
--signal=VALUE | 要应用的信号表达式或相交信号 ID 列表,例如signal-1,signal-2 |
--timeout=VALUE | 执行超时(以毫秒为单位) |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
expressionindex create
创建表达式索引。
例子:
seqcli expressionindex create --expression "ServerName"
选项 | 描述 |
---|---|
-e , --expression=VALUE | 要索引的表达式 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下将使用connection.serverUrl 和connection.apiKey 配置值 |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
expressionindex list
列出表达式索引。
例子:
seqcli expressionindex list
选项 | 描述 |
---|---|
-i , --id=VALUE | 要列出的单个表达式索引的 id |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
expressionindex remove
从服务器中删除表达式索引。
例子:
seqcli expressionindex -i expressionindex-2529
选项 | 描述 |
---|---|
-i , --id=VALUE | 要删除的表达式索引的 id |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
feed create
创建 NuGet 源。
例子:
seqcli feed create -n 'CI' --location="https://f.feedz.io/example/ci" -u Seq --password-stdin
选项 | 描述 |
---|---|
-n , --name=VALUE | Feed 的唯一名称 |
-l , --location=VALUE | 进料位置;这可能是 NuGet v2 或 v3 feed URL,或者 Seq 服务器上的本地文件系统路径 |
-u , --username=VALUE | 如果需要身份验证,则连接到 feed 时应提供用户名 Seq |
-p , --password=VALUE | 提要密码(如果需要身份验证);请注意--password-stdin 更安全 |
--password-stdin | 从STDIN 读取 feed 密码 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
feed list
列出 NuGet 源。
例子:
seqcli feed list
选项 | 描述 |
---|---|
-n , --name=VALUE | 要列出的 feed 的名称 |
-i , --id=VALUE | 要列出的单个提要的 ID |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
feed remove
从服务器中删除 NuGet 源。
例子:
seqcli feed remove -n CI
选项 | 描述 |
---|---|
-n , --name=VALUE | 要删除的 Feed 的名称 |
-i , --id=VALUE | 要删除的单个 feed 的 ID |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下将使用connection.serverUrl 和connection.apiKey 配置值 |
feed update
更新现有的 NuGet 源。
例子:
seqcli feed update --json '{...}'
选项 | 描述 |
---|---|
--json=VALUE | 更新后的 JSON 格式的 NuGet feed;这可以使用seqcli feed list --json 生成 |
--json-stdin | 从STDIN 读取更新后的 NuGet feed 作为 JSON |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下将使用connection.serverUrl 和connection.apiKey 配置值 |
help
显示有关可用命令的信息。
例子:
seqcli help search
选项 | 描述 |
---|---|
-m , --markdown | 生成用于文档的 Markdown |
index list
列出索引。
例子:
seqcli index list
选项 | 描述 |
---|---|
-i , --id=VALUE | 要列出的单个索引的 id |
--json | 以换行符分隔的 JSON 格式打印输出(默认为纯文本) |
--no-color | 不要对文本输出着色 |
--force-color | 强制重定向输出具有 ANSI 颜色(除非还指定了--no-color ) |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下,将使用connection.serverUrl 和connection.apiKey 配置值 |
index suppress
抑制索引。
例子:
seqcli index suppress -i index-2191448f1d9b4f22bd32c6edef752748
选项 | 描述 |
---|---|
-i , --id=VALUE | 要抑制的索引的 id |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下将使用connection.serverUrl 和connection.apiKey 配置值 |
ingest
从文件或STDIN
发送日志事件。
例子:
seqcli ingest -i log-*.txt --json --filter="@Level <> 'Debug'" -p Environment=Test
选项 | 描述 |
---|---|
-i , --input=VALUE | 要摄取的文件,包括* 通配符;如果未指定,将使用STDIN |
--invalid-data=VALUE | 指定如何处理无效数据: fail (默认)或ignore |
-p , --property=NAME=VALUE | 指定名称/值属性,例如-p Customer=C123 -p Environment=Production |
-x , --extract=VALUE | 应用于纯文本日志的提取模式(指定--json 时忽略) |
--json | 以 JSON 形式读取事件(默认采用纯文本) |
-f , --filter=VALUE | 过滤表达式以选择事件子集 |
-m , --message=VALUE | 与摄取事件相关联的消息;支持 https://messagetemplates.org 语法 |
-l , --level=VALUE | 与摄入事件相关的级别或严重性;这将覆盖事件本身中存在的任何级别信息 |
--send-failure=VALUE | 指定如何处理连接失败: fail (默认)、 retry 、 continue 或ignore |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下将使用connection.serverUrl 和connection.apiKey 配置值 |
--batch-size=VALUE | 每个请求中发送到摄取端点的最大事件数;如果未指定,将使用值100 |
license apply
将许可证应用于 Seq 服务器。
例子:
seqcli license apply --certificate="license.txt"
选项 | 描述 |
---|---|
-c , --certificate=VALUE | 证书文件;文件必须是 UTF-8 文本 |
--certificate-stdin | 从STDIN 读取许可证书 |
--automatically-refresh | 如果许可证用于订阅,请定期检查datalust.co 并在订阅更改或续订时自动刷新证书 |
-s , --server=VALUE | Seq服务器的URL;默认情况下将使用connection.serverUrl 配置值 |
-a , --apikey=VALUE | 连接到服务器时使用的 API 密钥;默认情况下将使用connection.apiKey 配置值 |
--profile=VALUE | 要使用的连接配置文件;默认情况下, connection.serverUrl 和connection.apiKey 配置值将是我们 |