/filebeat-plugin

filebeat plugin processor

Primary LanguageGo

说明

简单了解filebeat开发插件的流程,及插件工作的机制。

Processors 说明

filebeat对于收集的每行日志都封装成event, event 发送到 output 之前,可在配置文件中定义processors去处理 event。 processor 作用:

  • 减少导出的字段
  • 添加其他的 metadata
  • 执行额外的处理和解码

每个 processor 会接收一个 event,将一些定义好的行为应用到 event,然后返回 event,如果你在配置文件中定义了一系列 processors,那么他会按定义的顺序依次执行。

所以,可以基于此机制进行filebeat功能扩展。

filebeat-plugin

filebeat plugin processor

add_sample_data

  • 基于URL维度计数,进行采样收集

  • 采样率控制config.go中Sample

add_sample_data使用场景

准确率要求不高的情况下,可以使用采样的机制,比如,通过日志,计算服务的可用性,基于统计计数的情况,会存在误差,服务波动情况下,可能导致抽样的数据都是正常的,异常的日志漏掉。

版本信息

  • os: mac 10.14.6
  • golang: go1.12.7
  • filebeat: 7.4.2

基于以上版本测试通过

测试运行

./filebeat -e -c filebeat_test.yml --plugin add_sample_data.so

开发

  • 下载beats源码 https://github.com/elastic/beats
  • 可以选择filebeat对应版本的分支
  • libbeat/processors下新建add_sample_data目录(下面有自带processor)
  • 插件编译打包在当前目录下
// processor名称定义用于filebeat.yml配置文件Processors配置
const (
	processorName = "add_sample_data"
)

// 插件注册
var Bundle = plugin.Bundle(
	processors.Plugin(processorName, newSampleProcessor),
)

打包

基于 https://github.com/elastic/beats 源码下进行编译打包

cd libbeat/processors/add_sample_data
go build -buildmode=plugin

filebeat.yml配置

#================================ Processors =====================================
processors:
  - add_sample_data: ~

问题

  1. 启动运行命令签名错误

由于Mac系统(csrutil)保护系统完整性导致的问题,运行 csrutil status 查看结果,如果是 enable,关闭disable即可。具体操作步骤自行百度

  1. 启动 plugin was built with a different version of package errors

plugin 编译问题导致,解决方法,基于beats对应版本源代码重新编译,执行filebeat下make命令,替换原有 filebeat 二进制文件

参考

https://github.com/zhonglongbo/filebeat_plugin