心跳命令参考
edit心跳命令参考edit
Heartbeat 提供了一个命令行界面，用于启动 Heartbeat 并执行常见的任务，例如测试配置文件。
命令行还支持 全局标志 用于控制全局行为。
如果使用 sudo 运行以下命令
- 配置文件由
root拥有，或者 - Heartbeat 配置为捕获需要
root访问权限的数据
此处描述的某些功能需要 Elastic 许可证。有关更多信息，请参见 https://elastic.ac.cn/subscriptions 和 许可证管理。
| 命令 | |
|---|---|
将配置、索引模板或 ILM 策略导出到 stdout。 |
|
显示任何命令的帮助信息。 |
|
管理 密钥库。 |
|
运行 Heartbeat。如果在没有指定命令的情况下启动 Heartbeat，则默认使用此命令。 |
|
设置初始环境，包括 ES 索引模板和 ILM 策略以及写入别名。 |
|
测试配置。 |
|
显示有关当前版本的信息。 |
另请参阅 全局标志。
export 命令edit
将配置、索引模板或 ILM 策略导出到 stdout。可以使用此命令快速查看配置或查看索引模板或 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.14.3
help 命令edit
显示任何命令的帮助信息。如果未指定命令，则显示 run 命令的帮助信息。
概要
heartbeat help COMMAND_NAME [FLAGS]
-
COMMAND_NAME - 指定要显示其帮助信息的命令的名称。
标志
-
-h, --help - 显示
help命令的帮助信息。
另请参阅 全局标志。
示例
heartbeat help export
keystore 命令edit
管理 密钥库。
概要
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 命令edit
运行 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模块配置值指定备用主机文件系统。
另请参阅 全局标志。
示例
heartbeat run -e
或
heartbeat -e
setup 命令edit
设置初始环境，包括 ES 索引模板和 ILM 策略以及写入别名
- 索引模板确保字段在 Elasticsearch 中正确映射。如果启用了索引生命周期管理，它还确保定义的 ILM 策略和写入别名与匹配索引模板的索引相关联。ILM 策略负责索引的生命周期，何时进行滚动、何时将索引从热阶段移到下一个阶段等。
此命令设置环境，但实际上不运行 Heartbeat 并收集数据。指定可选标志以设置资产的子集。
概要
heartbeat setup [FLAGS]
标志
-
-h, --help - 显示
setup命令的帮助信息。 -
--index-management - 设置与 Elasticsearch 索引管理相关的组件，包括模板、ILM 策略和写入别名（如果支持并已配置）。
另请参阅 全局标志。
示例
heartbeat setup --index-management
test 命令edit
测试配置。
概要
heartbeat test SUBCOMMAND [FLAGS]
子命令
-
config - 测试配置设置。
-
output - 使用当前设置测试 Heartbeat 是否可以连接到输出。
标志
-
-h, --help - 显示
test命令的帮助信息。
另请参阅 全局标志。
示例
heartbeat test config
version 命令edit
显示有关当前版本的信息。
概要
heartbeat version [FLAGS]
标志
-
-h, --help - 显示
version命令的帮助信息。
另请参阅 全局标志。
示例
heartbeat version
全局标志edit
这些全局标志在您运行 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 运行所在的 environment。此设置用于在未配置日志输出时选择默认日志输出。支持的值包括：
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 级别的消息。