logstash插件

背景:由于需要将探针数据中的服务器位置信息等数据可能是错误的,而我们自己有相对准确的数据,所以要自己来把这些信息附加到探针数据中。对于这个需求,最高效的做法应该就是自己开发logstash的插件,直接在logstash将这一步搞定。


具体步骤

生成插件模板
$:bin/logstash-plugin generate --type filter --name tesT
 Creating /home/elk/logstash-7.3.1/logstash-filter-test
     create logstash-filter-test/CHANGELOG.md
     create logstash-filter-test/CONTRIBUTORS
     create logstash-filter-test/DEVELOPER.md
     create logstash-filter-test/Gemfile
     create logstash-filter-test/LICENSE
     create logstash-filter-test/README.md
     create logstash-filter-test/Rakefile
     create logstash-filter-test/docs/index.asciidoc
     create logstash-filter-test/lib/logstash/filters/tesT.rb
     create logstash-filter-test/logstash-filter-tesT.gemspec
     create logstash-filter-test/spec/filters/tesT_spec.rb
     create logstash-filter-test/spec/spec_helper.rb
修改插件模板

tesT.rb是插件处理逻辑代码位置,内容如下:

# encoding: utf-8
require "logstash/filters/base"

# This  filter will replace the contents of the default
# message field with whatever you specify in the configuration.
#
# It is only intended to be used as an .
class LogStash::Filters::Test < LogStash::Filters::Base

  # Setting the config_name here is required. This is how you
  # configure this filter from your Logstash config.
  #
  # filter {
  #    {
  #     message => "My message..."
  #   }
  # }
  #
  config_name "tesT"

  # Replace the message with this value.
  config :message, :validate => :string, :default => "Hello World!"


  public
  def register
    # Add instance variables
  end # def register

  public
  def filter(event)

    if @message
      # Replace the event message with our message as configured in the
      # config file.
      event.set("message", @message)
    end

    # filter_matched should go in the last line of our successful code
    filter_matched(event)
  end # def filter
end # class LogStash::Filters::Test

register方法是初始化模块,在该方法中一般做一些初始化的工作,在这个方法中加载外部数据会在整个logstash运行的过程中一直存在与内存中,此时需要注意的是,如果加载的数据比较多,最好增加jvm heap的大小。config_name定义调用插件时所以用的名字,也就是插件的名字。config定义插件调用时需要设置的属性。config :message, :validate => :string, :default => "Hello World!"设置了message属性,必须是string类型,初始值为"Hello World!",并且该语句会创建一个实例变量@message。(ps:我使用ruby的hash数据结构加载了我需要给每条日志匹配的信息。)
filter方法会处理所有进入插件处理流畅的event,该方法只会在每次处理event时运行一次,意味着在这里加载的数据不会驻留在内存中。

修改Gemfile

logstash根目录中的Gemfile列出了logstash可用的所有插件及其路径,在该文件中添加gem "logstash-filter-tesT", :path => "./logstash-filter-test/"

使用插件

在logstash配置文件中使用我们定义的插件:

tesT{
    message => "bye bye!"
}

此时,该插件会将所有的message替换为"bye bye!"


问题:插件所需要的第三方数据在logstash运行过程中是不是一直加载在内存中?
在register方法中加载数据后,整个运行过程中该数据都在内存中。
问题:插件的名字中用了大写字母会产生找不到插件的问题?有待验证。
经过验证,插件的名字中可以用大写字母,例如我的插件名字为tesT,我需要在Gemfile文件中添加:

gem "logstash-filter-tesT", :path => "./logstash-filter-test/"

而我的插件ruby程序文件名为tesT.rb,我的插件类名为LogStash::Filters::Test,插件的路径为"./logstash-filter-test/"。对于初学者的我来说,这足以引起混乱了。而开始找不到插件的问题就是因为在Gemfile文件中我写的是:

gem "logstash-filter-test", :path => "./logstash-filter-test/"

可以看出Gemfile中gem后跟是带了前缀的插件名字,所以为了避免不必要的麻烦,尽量使用全小写来命名插件名称!
问题:logstash的geoip插件加载的mmdb数据库文件是否比ruby hash数据结构效率更高,内存占用更少?
待研究...
问题:运用到到的项目中,我在register中加载了200m的数据,每次运行都会爆内存,然而我已经设置了30G的jvm heap了,这是为什么呢?
待研究...


官方filter插件文档
logstash插件较详细解释

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350