[Filebeat]

Filebeat命令帮助文档

执行命令时注意引用资源的权限问题

表 1 命令列表

命令	作用
export	输出配置、索引模板、仪表盘到标准输出流
help	命令帮助
keystore	管理私密配置参数
modules	管理配置好的模块
run	启动，也是缺省参数
setup	配置个人环境，包括索引模板、Kibana 仪表盘(可选)和机器学习任务(可选)
test	测试配置文件
version	版本信息

export命令

  export命令用来输出配置、索引模板、仪表盘到标准输出流，用来预览配置、索引模板内容、Kibana 仪表盘，确认配置信息是否有误。

• 命令格式：filebeat export SUBCOMMAND [FLAGS]
  • SUBCOMMANDS
    • config：将当前的配置打印到标准输出流，如果使用了-c标签，该命令将输出指定文件中的配置信息
    • dashboard：输出仪表盘，通过该命令，可以按照模块存储一个仪表盘到本地文件，且可以自动加载。例如：filebeat export dashboard --id="DASHBOARD_ID" > dashboard.json ，该命令就将指定的仪表盘存储到了 dashboard.json文件中，如果需要加载该仪表盘，只需要将生成的dashboard.json文件拷贝到 Filebeat安装目录下的kibana/6/dashboard文件夹，然后执行filebeat setup --dashboards命令即可。
      • --id DASHBOARD_ID：指定仪表盘编号
    • template：输出索引模板信息到标准输出流，可通过指定--es.version和--index标签来进一步明确输出对象。
      • --es.version VERSION：输出兼容 ES 版本的索引格式
      • --index BASE_NAME：输出指定索引的索引模板
    • ilm-policy：输出IML策略到标准输出流
  • FLAGS
    • -h, --help：export帮助指令
• 命令举例：

filebeat export config
filebeat export template --es.version 7.0.0 --index myindexname
filebeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json

help命令

  帮助命令，缺省显示run的帮助信息。

• 命令格式：filebeat help COMMAND_NAME [FLAGS]
  • FLAGS:
    • -h, --help：帮助命令的帮助信息
• 命令举例：

filebeat help export

keystore命令

  用来管理敏感参数配置。

• 命令格式：filebeat keystore SUBCOMMAND [FLAGS]
  • SUBCOMMANDS
    • add KEY：添加指定参数到 keystore，使用--force标签来覆盖已有参数，使用--stdin来通过 stdin 传入参数值
    • create：创建一个配置参数对，使用--force标签来覆盖已存在配置
    • list：列出所有参数项
    • remove KEY：移除指定参数项
  • FLAGS
    • -h, --help：帮助命令
• 命令举例：

filebeat keystore create
filebeat keystore add ES_PWD
filebeat keystore remove ES_PWD
filebeat keystore list

modules命令

  modules命令用来管理配置好的模块，可以通过该命令来启动或停止modules.d文件夹下定义的模块。通过该命令执行的操作将会被记录下来，并用于接下来 Filebeat 的运行。

• 命令格式：filebeat modules SUBCOMMAND [FLAGS]
  • SUBCOMMANDS
    • disable MODULE_LIST：停止指定模块
    • enable MODULE_LIST：启动指定模块
    • list：列出当前启动和停止的模块列表
  • FLAGS
    • -h, --help：帮助指令
• 命令举例：

filebeat modules list
filebeat modules enable apache2 auditd mysql