Heartbeat 命令参考
编辑Heartbeat 命令参考
编辑Heartbeat 提供了一个命令行界面，用于启动 Heartbeat 和执行常见任务，例如测试配置文件。
命令行还支持用于控制全局行为的全局标志。
如果满足以下条件，请使用 sudo 运行以下命令
- 配置文件的所有者是
root，或者 - Heartbeat 被配置为捕获需要
root访问权限的数据
此处描述的某些功能需要 Elastic 许可证。有关更多信息，请参阅 https://elastic.ac.cn/subscriptions 和 许可证管理。
| 命令 | |
|---|---|
将配置、索引模板或 ILM 策略导出到标准输出。 |
|
显示任何命令的帮助信息。 |
|
管理密钥库。 |
|
运行 Heartbeat。 如果你在启动 Heartbeat 时未指定命令，则默认使用此命令。 |
|
设置初始环境，包括 ES 索引模板、ILM 策略和写入别名。 |
|
测试配置。 |
|
显示有关当前版本的信息。 |
另请参阅全局标志。
export 命令
编辑将配置、索引模板或 ILM 策略导出到标准输出。 你可以使用此命令快速查看你的配置，或查看索引模板或 ILM 策略的内容。
概要
heartbeat export SUBCOMMAND [FLAGS]
子命令
标志
-
--es.version VERSION - 与
template一起使用时，导出与指定版本兼容的索引模板。 与ilm-policy一起使用时，如果指定 ES 版本启用了 ILM，则导出 ILM 策略。 -
-h, --help - 显示
export命令的帮助信息。 -
--dir DIRNAME - 定义一个目录，将模板、管道和 ILM 策略导出到该目录中的文件，而不是将其打印到
stdout。
另请参阅全局标志。
示例
heartbeat export config heartbeat export template --es.version 8.17.0
help 命令
编辑显示任何命令的帮助信息。 如果未指定命令，则显示 run 命令的帮助信息。
概要
heartbeat help COMMAND_NAME [FLAGS]
-
COMMAND_NAME - 指定要显示帮助的命令的名称。
标志
-
-h, --help - 显示
help命令的帮助信息。
另请参阅全局标志。
示例
heartbeat help export
keystore 命令
编辑管理密钥库。
概要
heartbeat keystore SUBCOMMAND [FLAGS]
子命令
-
add KEY - 将指定的密钥添加到密钥库。 使用
--force标志覆盖现有密钥。 使用--stdin标志通过stdin传递值。 -
create - 创建一个密钥库来保存机密。 使用
--force标志覆盖现有密钥库。 -
list - 列出密钥库中的密钥。
-
remove KEY - 从密钥库中删除指定的密钥。
标志
-
--force - 适用于
add和create子命令。 与add一起使用时，覆盖指定的密钥。 与create一起使用时，覆盖密钥库。 -
--stdin - 与
add一起使用时，使用 stdin 作为密钥值的来源。 -
-h, --help - 显示
keystore命令的帮助信息。
另请参阅全局标志。
示例
heartbeat keystore create heartbeat keystore add ES_PWD heartbeat keystore remove ES_PWD heartbeat keystore list
有关更多示例，请参阅密钥库。
run 命令
编辑运行 Heartbeat。 如果你在启动 Heartbeat 时未指定命令，则默认使用此命令。
概要
heartbeat run [FLAGS]
或
heartbeat [FLAGS]
标志
-
-N, --N - 禁用发布以进行测试。 此选项禁用除文件输出之外的所有输出。
-
--cpuprofile FILE - 将 CPU 配置文件数据写入指定的文件。 此选项对于排除 Heartbeat 故障很有用。
-
-h, --help - 显示
run命令的帮助信息。 -
--httpprof [HOST]:PORT - 启动用于分析的 HTTP 服务器。 此选项对于排除 Heartbeat 故障和进行分析很有用。
-
--memprofile FILE - 将内存配置文件数据写入指定的输出文件。 此选项对于排除 Heartbeat 故障很有用。
-
--system.hostfs MOUNT_POINT - 指定主机文件系统的挂载点，用于监视主机。 此标志已弃用，应通过
hostfs模块配置值指定备用 hostfs。
另请参阅全局标志。
示例
heartbeat run -e
或
heartbeat -e
setup 命令
编辑设置初始环境，包括 ES 索引模板、ILM 策略和写入别名
- 索引模板确保在 Elasticsearch 中正确映射字段。 如果启用了索引生命周期管理，它还会确保已定义的 ILM 策略和写入别名连接到与索引模板匹配的索引。 ILM 策略负责索引的生命周期，例如何时执行滚动更新、何时将索引从热阶段移动到下一阶段等。
此命令在不实际运行 Heartbeat 和摄取数据的情况下设置环境。 指定可选标志以设置资产的子集。
概要
heartbeat setup [FLAGS]
标志
-
-h, --help - 显示
setup命令的帮助信息。 -
--index-management - 设置与 Elasticsearch 索引管理相关的组件，包括模板、ILM 策略和写入别名（如果支持和配置）。
另请参阅全局标志。
示例
heartbeat setup --index-management
test 命令
编辑测试配置。
概要
heartbeat test SUBCOMMAND [FLAGS]
子命令
-
config - 测试配置设置。
-
output - 通过使用当前设置测试 Heartbeat 是否可以连接到输出。
标志
-
-h, --help - 显示
test命令的帮助信息。
另请参阅全局标志。
示例
heartbeat test config
version 命令
编辑显示有关当前版本的信息。
概要
heartbeat version [FLAGS]
标志
-
-h, --help - 显示
version命令的帮助信息。
另请参阅全局标志。
示例
heartbeat version
全局标志
编辑这些全局标志在你运行 Heartbeat 时始终可用。
-
-E, --E "SETTING_NAME=VALUE" -
覆盖特定的配置设置。 你可以指定多个覆盖。 例如
heartbeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"
此设置将应用于当前正在运行的 Heartbeat 进程。 Heartbeat 配置文件不会更改。
-
-c, --c FILE - 指定要用于 Heartbeat 的配置文件。 你在此处指定的文件相对于
path.config。 如果未指定-c标志，则使用默认配置文件heartbeat.yml。 -
-d, --d SELECTORS - 为指定的选择器启用调试。 对于选择器，你可以指定一个逗号分隔的组件列表，也可以使用
-d "*"为所有组件启用调试。 例如，-d "publisher"将显示所有与发布者相关的消息。 -
-e, --e - 记录到 stderr 并禁用 syslog/文件输出。
-
-environment - 出于日志记录目的，指定 Heartbeat 运行的环境。 此设置用于在未配置日志输出时选择默认日志输出。 支持的值为：
systemd、container、macos_service和windows_service。 如果指定了systemd或container，则默认情况下，Heartbeat 将记录到 stdout 和 stderr。 -
--path.config - 设置配置文件的路径。 有关详细信息，请参阅目录布局部分。
-
--path.data - 设置数据文件的路径。 有关详细信息，请参阅目录布局部分。
-
--path.home - 设置杂项文件的路径。 有关详细信息，请参阅目录布局部分。
-
--path.logs - 设置日志文件的路径。 有关详细信息，请参阅目录布局部分。
-
--strict.perms - 对配置文件设置严格的权限检查。 默认值为
-strict.perms=true。 有关更多信息，请参阅 配置文件所有权和权限。 -
-v, --v - 记录 INFO 级别的消息。