› ›

Metricbeat 命令参考

edit

Metricbeat 命令参考

edit

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

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

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

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

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

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

另请参见全局标志。

`export` 命令

edit

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

概要

metricbeat export SUBCOMMAND [FLAGS]

子命令

config

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

dashboard

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

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

要查找DASHBOARD_ID，请查看 Kibana 中仪表盘的 URL。默认情况下，export dashboard 将仪表盘写入标准输出。示例显示了如何将仪表盘写入 JSON 文件，以便您可以稍后导入它。JSON 文件将包含带有所有可视化和搜索的仪表盘。您必须单独加载 Metricbeat 的索引模式。

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

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

template

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

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

标志

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

另请参见全局标志。

示例

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

`help` 命令

edit

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

概要

metricbeat help COMMAND_NAME [FLAGS]

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

标志

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

另请参见全局标志。

示例

metricbeat help export

`keystore` 命令

edit

管理密钥库。

概要

metricbeat keystore SUBCOMMAND [FLAGS]

子命令

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

标志

--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` 命令

edit

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

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

概要

metricbeat modules SUBCOMMAND [FLAGS]

子命令

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

标志

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

另请参见全局标志。

示例

metricbeat modules list
metricbeat modules enable apache nginx system

`run` 命令

edit

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

概要

metricbeat run [FLAGS]

或者

metricbeat [FLAGS]

标志

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

另请参见全局标志。

示例

metricbeat run -e

或者

metricbeat -e

`setup` 命令

edit

设置初始环境，包括索引模板、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` 命令

edit

测试配置。

概要

metricbeat test SUBCOMMAND [FLAGS]

子命令

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

标志

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

另请参见全局标志。

示例

metricbeat test config
metricbeat test modules system cpu

`version` 命令

edit

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

概要

metricbeat version [FLAGS]

标志

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

另请参见全局标志。

示例

metricbeat version

全局标志

edit

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

-E, --E "SETTING_NAME=VALUE"

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

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

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

-c, --c FILE

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

-d, --d SELECTORS

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

-e, --e

登录到 stderr 并禁用 syslog/文件输出。

-environment

出于日志记录目的，指定 Metricbeat 运行的环境。此设置用于在未配置日志输出时选择默认日志输出。支持的值为：systemd、container、macos_service 和 windows_service。如果指定了 systemd 或 container，Metricbeat 将默认将日志记录到 stdout 和 stderr。

--path.config

设置配置文件的路径。详情请参见目录布局部分。

--path.data

设置数据文件的路径。详情请参见目录布局部分。

--path.home

设置杂项文件的路径。详情请参见目录布局部分。

--path.logs

设置日志文件的路径。详情请参见目录布局部分。

--strict.perms

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

-v, --v

记录 INFO 级别的消息。

« 安全设置的密钥库 APT 和 YUM 的资源库 »

Metricbeat 命令参考

Metricbeat 命令参考

export 命令

help 命令

keystore 命令

modules 命令

run 命令

setup 命令

test 命令

version 命令

全局标志

`export` 命令

`help` 命令

`keystore` 命令

`modules` 命令

`run` 命令

`setup` 命令

`test` 命令

`version` 命令