Filebeat命令参考

 Filebeat命令参考:
    Filebeat提供了一个命令行界面,用于启动Filebeat并执行常见任务,例如测试配置文件和加载仪表板。命令行还支持用于控制全局行为的全局标志。
    命令:
    export    将配置或索引模板导出到stdout。
    help      显示任何命令的帮助。
    keystore  管理秘密密钥库。
    modules   管理配置的模块。
    run       运行Filebeat。如果在未指定命令的情况下启动Filebeat,则默认使用此命令。
    setup     设置初始环境,包括索引模板,Kibana仪表板(如果可用)和机器学习作业(如果可用)。
    test      测试配置。
    version   显示有关当前版本的信息。
    export命令
        将配置或索引模板导出到stdout。您可以使用此命令快速查看配置或索引模板的内容。
        filebeat export SUBCOMMAND [FLAGS]
                SUBCOMMANDS
                    config
                    将当前配置导出到stdout。如果使用该-c标志,则此命令将导出在指定文件中定义的配置。        
                    template
                    将索引模板导出到stdout。您可以指定--es.version和 --index标志以进一步定义导出的内容。
                FLAGE
                --es.version VERSION 与其一起指定时template,导出与指定版本兼容的索引模板。
                -h, --help 显示export命令的帮助。
                --index BASE_NAME 与其一起指定时template,设置用于索引模板的基本名称。如果未指定此标志,则默认基本名称为filebeat。

                例子: 
                    filebeat export config
                    filebeat export template --es.version 6.2.4 --index myindexname

    keystore命令
        管理秘钥库
        filebeat keystore SUBCOMMAND [ FLAGS ]
                SUBCOMMAND
                    add KEY  将指定的密钥添加到密钥库。使用该--force标志覆盖现有密钥。使用--stdin标志传递值stdin
                    create     创建一个密钥库来保存秘密。使用该--force标志覆盖现有密钥库。
                    list    列出密钥库中的密钥。
                    remove KEY 从密钥库中删除指定的密钥。
                FLAGS
                    --force 适用于add和create子命令。使用时add,会覆盖指定的密钥。与之一起使用时create,会覆盖密钥库。

                    --stdin 与之一起使用时add,使用stdin作为键值的来源。
                    -h,--help 显示keystore命令的帮助。

                例子:
                filebeat keystore create 
                filebeat keystore add ES_PWD 
                filebeat keystore remove ES_PWD 
                filebeat keystore list
    
    modules命令
         管理配置的模块。您可以使用此命令启用和禁用modules.d目录中定义的特定模块配置。使用此命令所做的更改将保留,并用于后续运行的Filebeat。

         filebeat modules SUBCOMMAND [FLAGS]
                 SUBCOMMANDS
                     disable MODULE_LIST  禁用以空格分隔的列表中指定的模块。

                     enable MODULE_LIST  启用以空格分隔的列表中指定的模块。

                     list   列出当前启用和禁用的模块。
                 FLAGS
                     -h,--help  显示export命令的帮助。

                 例子:
                 filebeat modules list
                filebeat modules enable apache2 auditd mysql

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

        filebeat run [FLAGS]  or  filebeat [FLAGS]
            FLAGS
                -N, --N  禁用将事件发布到已定义的输出。此选项仅用于测试Filebeat。
                --cpuprofile FILE  将CPU配置文件数据写入指定的文件。此选项对于Filebeat故障排除很有用。
                -h, --help  显示run命令的帮助。
                --httpprof [HOST]:PORT  启动http服务器以进行性能分析。此选项对于故障排除和分析Filebeat很有用。
                --memprofile FILE  将内存配置文件数据写入指定的输出文件。此选项对于Filebeat故障排除很有用。
                --modules MODULE_LIST  指定要运行的以逗号分隔的模块列表。例如:
                    filebeat run --modules nginx,mysql,system
                    您可以使用该modules命令启用和禁用特定模块,而不是每次运行Filebeat时指定模块列表。然后,当您运行Filebeat时,它将运行任何已启用的模块。
                --once  使用该once标志时,Filebeat将启动所有已配置的收集器和探测器,并运行每个探测器,直到收割机关闭。如果设置了--once标志,则还应设置close_eof为在达到文件末尾时关闭收割机。默认情况下,收割机在close_inactive到达后关闭。
                --setup  加载示例Kibana仪表板。如果要在不运行Filebeat的情况下加载仪表板,请改用setup命令。

                例子:filebeat run -e --setup

    setup命令
        设置初始环境,包括索引模板,Kibana仪表板(如果可用)和机器学习作业(如果可用)。
            索引模板可确保在Elasticsearch中正确映射字段。
            Kibana仪表板使您可以更轻松地在Kibana中可视化Filebeat数据。
            机器学习作业包含分析异常数据所需的配置信息和元数据。
        使用此命令而不是run --setup在不实际运行Filebeat和摄取数据的情况下设置环境。

        filebeat setup [FLAGS]
        FLAGS
            --dashboards  仅设置Kibana仪表板。此选项从Filebeat包加载仪表板。有关更多选项,例如加载自定义仪表板,请参阅Beats开发人员指南 中的导入现有节拍仪表板。
            -h, --help  显示setup命令的帮助。
            --machine-learning  仅设置机器学习作业配置。
            --modules MODULE_LIST  指定以逗号分隔的模块列表。当filebeat.yml文件中没有定义模块时,使用此标志可以避免错误。
            --template  仅设置索引模板。
            例子:filebeat setup --dashboards

    test命令
        测试配置
        filebeat test SUBCOMMAND [FLAGS]
            SUBCOMMAND 
                config 测试配置设置
                output 测试Filebeat可以使用当前设置连接到输出。
            FLAGS
                -h, --help 显示test命令的帮助。
            例子:filebeat test config
     
     version命令
         显示有关当前版本的信息。
         filebeat version [FLAGS]
         -h, --help 显示version命令的帮助。

全局标志
    运行Filebeat时,可​​以使用这些全局标志。
    -E, --E "SETTING_NAME=VALUE"  覆盖特定的配置设置。您可以指定多个覆盖。例如:filebeat -E "name=mybeat" -E "output.elasticsearch.hosts=["http://myhost:9200"]"  此设置适用于当前运行的Filebeat进程。Filebeat配置文件未更改。

    -M, --M "VAR_NAME=VALUE"  覆盖Filebeat模块的默认配置。您可以指定多个变量覆盖。例如:filebeat -modules=nginx -M "nginx.access.var.paths=[/var/log/nginx/access.log*]" -M "nginx.access.var.pipeline=no_plugins"

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

    -d, --d SELECTORS 启用指定选择器的调试。对于选择器,您可以指定以逗号分隔的组件列表,也可以使用它-d "*"来启用所有组件的调试。例如,-d "publish"显示所有“发布”相关消息。

    -e, --e  记录到stderr并禁用syslog/file输出。
    --path.config 设置配置文件的路径
    --path.data  设置数据文件的路径
    --path.home  设置其他文件的路径
    --path.logs  设置日志文件的路径
    --strict.perms 设置对配置文件的严格权限检查。默认是 -strict.perms=true
    -v, --v  记录INFO级别的消息。

 

posted @ 2018-11-08 16:55  风住  阅读(1688)  评论(0编辑  收藏