› ›

Metricbeat 命令参考

Metricbeat 命令参考编辑

Metricbeat 提供了一个命令行界面，用于启动 Metricbeat 并执行常见任务，例如测试配置文件和加载仪表板。

命令行还支持全局标志，用于控制全局行为。

如果出现以下情况，请使用 sudo 运行以下命令：

配置文件归 root 所有，或
Metricbeat 配置为捕获需要 root 访问权限的数据

此处描述的某些功能需要 Elastic 许可证。有关更多信息，请参阅 https://elastic.ac.cn/subscriptions 和许可证管理。

命令
`export`	将配置、索引模板、ILM 策略或仪表板导出到 stdout。
`help`	显示任何命令的帮助。
`keystore`	管理密钥库。
`modules`	管理已配置的模块。
`run`	运行 Metricbeat。如果在未指定命令的情况下启动 Metricbeat，则默认使用此命令。
`setup`	设置初始环境，包括索引模板、ILM 策略和写入别名，以及 Kibana 仪表板（如果可用）。
`test`	测试配置。
`version`	显示有关当前版本的信息。

另请参阅全局标志。

`export` 命令编辑

将配置、索引模板、ILM 策略或仪表板导出到 stdout。您可以使用此命令快速查看您的配置，查看索引模板和 ILM 策略的内容，或从 Kibana 导出仪表板。

语法

metricbeat export SUBCOMMAND [FLAGS]

子命令

config

将当前配置导出到 stdout。如果使用 -c 标志，则此命令将导出在指定文件中定义的配置。

dashboard

导出仪表板。您可以使用此选项将仪表板存储在模块中的磁盘上，并自动加载它。例如，要将仪表板导出到 JSON 文件，请运行

metricbeat export dashboard --id="DASHBOARD_ID" > dashboard.json

要查找 DASHBOARD_ID，请查看 Kibana 中仪表板的 URL。默认情况下，export dashboard 会将仪表板写入 stdout。该示例演示了如何将仪表板写入 JSON 文件，以便您以后可以导入它。JSON 文件将包含仪表板以及所有可视化和搜索。您必须单独为 Metricbeat 加载索引模式。

要加载仪表板，请将生成的 dashboard.json 文件复制到 Metricbeat 的 kibana/6/dashboard 目录中，然后运行 metricbeat setup --dashboards 导入仪表板。

如果 Kibana 未在 localhost:5061 上运行，则您还必须调整 setup.kibana 下的 Metricbeat 配置。

template

将索引模板导出到 stdout。您可以指定 --es.version 标志来进一步定义要导出的内容。此外，您可以通过 --dir 定义目录，将模板导出到文件而不是 stdout。

ilm-policy: 将索引生命周期管理策略导出到 stdout。您可以指定 --es.version 和 --dir，将策略作为文件导出到该目录，而不是导出到 stdout。

标志

--es.version 版本: 与 template 一起使用时，导出与指定版本兼容的索引模板。与 ilm-policy 一起使用时，如果为 ILM 启用了指定的 ES 版本，则导出 ILM 策略。
-h, --help: 显示 export 命令的帮助。
--dir 目录名: 定义一个目录，将模板、管道和 ILM 策略作为文件导出到该目录，而不是将它们打印到 stdout。
--id 仪表板 ID: 与 dashboard 一起使用时，指定仪表板 ID。

另请参阅全局标志。

示例

metricbeat export config
metricbeat export template --es.version 8.14.3
metricbeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json

`help` 命令编辑

显示任何命令的帮助。如果未指定命令，则显示 run 命令的帮助。

语法

metricbeat help COMMAND_NAME [FLAGS]

命令名称: 指定要显示其帮助的命令的名称。

标志

-h, --help: 显示 help 命令的帮助。

另请参阅全局标志。

示例

metricbeat help export

`keystore` 命令编辑

管理密钥库。

语法

metricbeat keystore SUBCOMMAND [FLAGS]

子命令

add 密钥: 将指定的密钥添加到密钥库。使用 --force 标志覆盖现有密钥。使用 --stdin 标志通过 stdin 传递值。
create: 创建一个密钥库来保存密钥。使用 --force 标志覆盖现有的密钥库。
list: 列出密钥库中的密钥。
remove 密钥: 从密钥库中删除指定的密钥。

标志

--force: 对 add 和 create 子命令有效。与 add 一起使用时，将覆盖指定的密钥。与 create 一起使用时，将覆盖密钥库。
--stdin: 与 add 一起使用时，使用 stdin 作为密钥值的来源。
-h, --help: 显示 keystore 命令的帮助。

另请参阅全局标志。

示例

metricbeat keystore create
metricbeat keystore add ES_PWD
metricbeat keystore remove ES_PWD
metricbeat keystore list

有关更多示例，请参阅密钥库。

`modules` 命令编辑

管理已配置的模块。您可以使用此命令启用和禁用在 modules.d 目录中定义的特定模块配置。您使用此命令所做的更改将被保留，并用于 Metricbeat 的后续运行。

要查看哪些模块已启用和禁用，请运行 list 子命令。

语法

metricbeat modules SUBCOMMAND [FLAGS]

子命令

disable 模块列表: 禁用空格分隔列表中指定的模块。
enable 模块列表: 启用空格分隔列表中指定的模块。
list: 列出当前已启用和禁用的模块。

标志

-h, --help: 显示 modules 命令的帮助。

另请参阅全局标志。

示例

metricbeat modules list
metricbeat modules enable apache nginx system

`run` 命令编辑

运行 Metricbeat。如果在未指定命令的情况下启动 Metricbeat，则默认使用此命令。

语法

metricbeat run [FLAGS]

或

metricbeat [FLAGS]

标志

-N, --N: 禁用发布以进行测试。此选项将禁用除文件输出之外的所有输出。
--cpuprofile 文件: 将 CPU 配置文件数据写入指定文件。此选项对 Metricbeat 的故障排除很有用。
-h, --help: 显示 run 命令的帮助。
--httpprof [主机]:端口: 启动用于性能分析的 http 服务器。此选项对 Metricbeat 的故障排除和性能分析很有用。
--memprofile 文件: 将内存配置文件数据写入指定的输出文件。此选项对 Metricbeat 的故障排除很有用。
--system.hostfs 挂载点: 指定主机文件系统的挂载点，用于监控主机。此标志已弃用，应通过 hostfs 模块配置值指定备用 hostfs。

另请参阅全局标志。

示例

metricbeat run -e

或

metricbeat -e

`setup` 命令编辑

设置初始环境，包括索引模板、ILM 策略和写入别名，以及 Kibana 仪表板（如果可用）

索引模板可确保在 Elasticsearch 中正确映射字段。如果启用了索引生命周期管理，它还确保定义的 ILM 策略和写入别名连接到与索引模板匹配的索引。ILM 策略负责索引的生命周期，何时进行滚动，何时将索引从热阶段移动到下一阶段，等等。
Kibana 仪表板使您更轻松地在 Kibana 中可视化 Metricbeat 数据。

此命令设置环境，而不实际运行 Metricbeat 和提取数据。指定可选标志以设置资产子集。

语法

metricbeat setup [FLAGS]

标志

--dashboards: 设置 Kibana 仪表板（如果可用）。此选项从 Metricbeat 包加载仪表板。有关更多选项，例如加载自定义仪表板，请参阅 _Beats 开发人员指南_ 中的导入现有 Beat 仪表板。
-h, --help: 显示 setup 命令的帮助。
--index-management: 设置与 Elasticsearch 索引管理相关的组件，包括模板、ILM 策略和写入别名（如果支持并已配置）。

另请参阅全局标志。

示例

metricbeat setup --dashboards
metricbeat setup --index-management

`test` 命令编辑

测试配置。

语法

metricbeat test SUBCOMMAND [FLAGS]

子命令

config: 测试配置设置。
modules [模块名称] [指标集名称]: 测试所有已配置模块的模块设置。当您运行此命令时，Metricbeat 会执行测试运行，应用当前设置，检索指标，并将它们显示为输出。要测试特定模块的设置，请指定 模块名称。要测试模块中特定指标集的设置，还要指定 指标集名称。
输出: 测试 Metricbeat 是否可以使用当前设置连接到输出。

标志

-h, --help: 显示 test 命令的帮助信息。

另请参阅全局标志。

示例

metricbeat test config
metricbeat test modules system cpu

`version` 命令编辑

显示有关当前版本的信息。

语法

metricbeat version [FLAGS]

标志

-h, --help: 显示 version 命令的帮助信息。

另请参阅全局标志。

示例

metricbeat version

全局标志编辑

每当您运行 Metricbeat 时，这些全局标志都可用。

-E, --E "SETTING_NAME=VALUE"

覆盖特定的配置设置。您可以指定多个覆盖。例如

metricbeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"

此设置应用于当前正在运行的 Metricbeat 进程。Metricbeat 配置文件不会更改。

-c, --c 文件

指定用于 Metricbeat 的配置文件。您在此处指定的文件是相对于 path.config 的。如果未指定 -c 标志，则使用默认配置文件 metricbeat.yml。

-d, --d 选择器

为指定的选器启用调试。对于选择器，您可以指定以逗号分隔的组件列表，也可以使用 -d "*" 为所有组件启用调试。例如，-d "publisher" 显示所有与发布者相关的消息。

-e, --e

记录到标准错误并禁用系统日志/文件输出。

-环境

出于日志记录目的，指定 Metricbeat 运行的环境。当未配置日志输出时，此设置用于选择默认日志输出。支持的值为：systemd、container、macos_service 和 windows_service。如果指定了 systemd 或 container，则 Metricbeat 默认情况下将记录到标准输出和标准错误。

--path.config

设置配置文件的路径。有关详细信息，请参阅目录布局部分。

--path.data

设置数据文件的路径。有关详细信息，请参阅目录布局部分。

--path.home

设置其他文件的路径。有关详细信息，请参阅目录布局部分。

--path.logs

设置日志文件的路径。有关详细信息，请参阅目录布局部分。

--strict.perms

对配置文件设置严格的权限检查。默认值为 -strict.perms=true。有关更多信息，请参阅配置文件所有权和权限。

-v, --v

记录 INFO 级别的消息。

« 用于安全设置的密钥库 APT 和 YUM 的存储库 »

Metricbeat 命令参考