EFK 配置geo-ip落地實踐（二）fluentd外掛編寫

宋奕發表於2019-02-27

前因

在之前的篇幅中–EFK 配置geo-ip落地實踐，已經介紹過如何配置geo外掛到fluentd中，實現ip地址轉經緯度的例項。

但是隨之也產生了一個問題。即，ip出口地址大多數落在了大城市，並且相對集中，其導致根據其轉換的經緯度所繪製的地圖點太集中，不能夠反映真實的使用者所在位置。

因此，新的需求從天而降！我們需要使用客戶端上報的經緯度來繪製地圖。

在瀏覽了所有fluentd的外掛後。居然沒有解析request body的外掛。 fluentd外掛查詢地址：www.fluentd.org/plugins/all

沒辦法，自己動手寫一個。

外掛編寫
首先，我們可以明確，fluentd的filter資料是順序流向下一個的。
由於我也是第一次編寫Ruby程式。所以先看一下專案結構：

其中比較重要的是：

filter_parse_request_body.rb （fluentd的filter外掛編寫，用於攔截資料，中途修改資料）
out_parse_request_body.rb （fluentd的out外掛編寫，用於最後格式化輸出資料）
parse_request_body_extractor.rb （最終執行拆解資料的類）
fluent-plugin-parse_request_body.gemspec （專案的配置檔案，包括專案名稱，版本號等）

下面，直接上程式碼：

filter_parse_request_body.rb

require "fluent/plugin/filter"
require "fluent/plugin/parse_request_body_extractor"

module Fluent::Plugin
  class ParseRequestBodyFilter < Fluent::Plugin::Filter

    #註冊filter名稱#
    Fluent::Plugin.register_filter(`parse_request_body`, self)

    #request body在record中所對應的key#
    desc "point a key whose value contains body string."
    config_param :key,    :string
    #需要使用array_value替換資料的key#
    desc "point a key who will be replaced."
    config_param :replace_key,    :string, default: nil
    #需要被組合在一起的資料名稱#
    desc "If set, the key/value will be reformd array whose would be added to the record."
    config_param :array_value,   :string, default: nil
    #最終組合資料在record中的key#
    desc "array_value`s key in record"
    config_param :array_value_key,   :string, default: nil
    #request body解析資料白名單#
    desc "If set, only the key/value whose key is included only will be added to the record."
    config_param :only,   :string, default: nil
    #request body解析資料黑名單#
    desc "If set, the key/value whose key is included except will NOT be added to the record."
    config_param :except, :string, default: nil
    #是否只保留最終解析出來的資料，而刪除request body原資料#
    desc "If set to true, the original key url will be discarded from the record."
    config_param :discard_key, :bool, default: false
    #給解析出的資料key新增字首#
    desc "Prefix of fields."
    config_param :add_field_prefix, :string, default: nil
    #是否允許解析空key#
    desc "If set to true, permit blank key."
    config_param :permit_blank_key, :bool, default: false

    #初始化解析器#
    def configure(conf)
      super
      @extractor = Fluent::Plugin::ParseRequestBodyExtractor.new(self, conf)
    end

    #執行解析工作#
    def filter(tag, time, record)
      @extractor.add_query_params_field(record)
    end
  end
end
複製程式碼

out_parse_request_body.rb （fluentd的out外掛編寫，用於最後格式化輸出資料）

require "fluent/plugin/output"
require "fluent/plugin/parse_request_body_extractor"

module Fluent::Plugin
  class ParseRequestBodyOutput < Fluent::Plugin::Output
    include Fluent::HandleTagNameMixin

    #註冊output名稱#
    Fluent::Plugin.register_output(`parse_request_body`, self)

    helpers :event_emitter

    #request body在record中所對應的key#
    desc "point a key whose value contains body string."
    config_param :key,    :string
    #需要使用array_value替換資料的key#
    desc "point a key who will be replaced."
    config_param :replace_key,    :string, default: nil
    #需要被組合在一起的資料名稱#
    desc "If set, the key/value will be reformd array whose would be added to the record."
    config_param :array_value,   :string, default: nil
    #最終組合資料在record中的key#
    desc "array_value`s key in record"
    config_param :array_value_key,   :string, default: nil
    #request body解析資料白名單#
    desc "If set, only the key/value whose key is included only will be added to the record."
    config_param :only,   :string, default: nil
    #request body解析資料黑名單#
    desc "If set, the key/value whose key is included except will NOT be added to the record."
    config_param :except, :string, default: nil
    #是否只保留最終解析出來的資料，而刪除request body原資料#
    desc "If set to true, the original key url will be discarded from the record."
    config_param :discard_key, :bool, default: false
    #給解析出的資料key新增字首#
    desc "Prefix of fields."
    config_param :add_field_prefix, :string, default: nil
    #是否允許解析空key#
    desc "If set to true, permit blank key."
    config_param :permit_blank_key, :bool, default: false

    #初始化解析器#
    def configure(conf)
      super
      @extractor = Fluent::Plugin::ParseRequestBodyExtractor.new(self, conf)
    end

    def multi_workers_ready?
      true
    end

    #執行解析工作#
    def filter_record(tag, time, record)
      record = @extractor.add_query_params_field(record)
      super(tag, time, record)
    end

    def process(tag, es)
      es.each do |time, record|
        t = tag.dup
        filter_record(t, time, record)
        router.emit(t, time, record)
      end
    end
  end
end
複製程式碼

parse_request_body_extractor.rb （最終執行拆解資料的類）

require `uri`
require `cgi/util`
require `webrick`

module Fluent::Plugin
  class ParseRequestBodyExtractor

    attr_reader :log
        
    #初始化解析器#
    def initialize(plugin, conf)
      @log = plugin.log

      if plugin.is_a?(Fluent::Plugin::Output)
        unless have_tag_option?(plugin)
          raise Fluent::ConfigError, "out_parse_request_body: At least one of remove_tag_prefix/remove_tag_suffix/add_tag_prefix/add_tag_suffix is required to be set."
        end
      end

      #從配置中讀取配置選項#
      @key = plugin.key
      @only = plugin.only
      @except = plugin.except
      @discard_key = plugin.discard_key
      @add_field_prefix = plugin.add_field_prefix
      @permit_blank_key = plugin.permit_blank_key
      @array_value = plugin.array_value
      @array_value_key = plugin.array_value_key
      @replace_key = plugin.replace_key

      #初始化白名單#
      if @only
        @include_keys = @only.split(/s*,s*/).inject({}) do |hash, i|
          hash[i] = true
          hash
        end
      end

      #初始化黑名單#
      if @except
        @exclude_keys = @except.split(/s*,s*/).inject({}) do |hash, i|
          hash[i] = true
          hash
        end
      end

      #初始化需要被組合的key#
      if @array_value_key
        if @array_value
          @include_array_value = @array_value.split(/s*,s*/).inject({}) do |hash, i|
            hash[i] = true
            hash
          end
        end
      end

    end

    #解析方法#
    def add_query_params_field(record)
      return record unless record[@key]
      add_query_params(record[@key], record)
      replace_record_by_key(record) if @replace_key
      record.delete(@key) if @discard_key
      record
    end

    private

    #替換record中某一個鍵值#
    def replace_record_by_key(record)
      return record unless record[@replace_key]
      replace_value = record[@array_value_key]
      empty_value = replace_value.select {|item| item == 0 }
      if replace_value && (empty_value.size != replace_value.size)
        record[@replace_key] = replace_value
      end
    end

    def have_tag_option?(plugin)
      plugin.remove_tag_prefix ||
        plugin.remove_tag_suffix ||
        plugin.add_tag_prefix    ||
        plugin.add_tag_suffix
    end

    def create_field_key(field_key)
      if add_field_prefix?
        "#{@add_field_prefix}#{field_key}"
      else
        field_key
      end
    end

    def add_field_prefix?
      !!@add_field_prefix
    end

    def permit_blank_key?
      @permit_blank_key
    end

    def add_query_params(body, record)
      return if body.nil?
      placeholder = []
      body.split(`&`).each do |pair|
        key, value = pair.split(`=`, 2).map { |i| CGI.unescape(i) }
        next if (key.nil? || key.empty?) && (!permit_blank_key? || value.nil? || value.empty?)
        key ||= ``
        value ||= ``

        new_key = create_field_key(key)
        if @only
          record[new_key] = value if @include_keys.has_key?(key)
        elsif @except
          record[new_key] = value if !@exclude_keys.has_key?(key)
        else
          record[new_key] = value
        end

        if @include_array_value
          placeholder[placeholder.size] = value.to_f if @include_array_value.has_key?(key)
        end
      end

      unless placeholder.empty?
        record[@array_value_key] = placeholder
      end
    end
  end
end
複製程式碼

fluent-plugin-parse_request_body.gemspec （專案的配置檔案，包括專案名稱，版本號等）

Gem::Specification.new do |gem|
  gem.name          = `fluent-plugin-parse_request_body`
  gem.version       = `0.0.18`
  gem.authors       = [`EkiSong`]
  gem.email         = [`yifriday0614@gmail.com`]
  gem.homepage      = `https://github.com/yifriday/fluent-plugin-parse_request_body.git`
  gem.description   = %q{Fluentd plugin to parse request body.}
  gem.summary       = %q{Fluentd plugin to parse request body}
  gem.license       = `MIT`

  gem.files         = `git ls-files`.split($)
  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
  gem.require_paths = [`lib`]

  if defined?(RUBY_VERSION) && RUBY_VERSION > `2.2`
    gem.add_development_dependency "test-unit", `~> 3`
  end

  gem.add_development_dependency `rake`
  gem.add_development_dependency `appraisal`
  gem.add_runtime_dependency     `fluentd`, [`>= 0.14.8`, `< 2`]
end
複製程式碼

##外掛製作

在結束編碼工作之後，使用gem製作上傳外掛。

ruby所寫的外掛，都可以上傳到這個網站rubygems.org/

下面是在命令列中的相關操作

➜  fluent-plugin-parse_request_body git:(master) gem build fluent-plugin-parse_request_body.gemspec 
  Successfully built RubyGem
  Name: fluent-plugin-parse_request_body
  Version: 0.0.18
  File: fluent-plugin-parse_request_body-0.0.18.gem
➜  fluent-plugin-parse_request_body git:(master) gem push fluent-plugin-parse_request_body-0.0.18.gem
Pushing gem to https://rubygems.org...
Successfully registered gem: fluent-plugin-parse_request_body (0.0.18)
複製程式碼

在成功上傳外掛後。我們就可以使用gem工具，在我們的伺服器中安裝了

外掛安裝和配置

安裝直接執行下面語句即可：

/usr/sbin/td-agent-gem install fluent-plugin-parse_request_body
複製程式碼

而在td-agent.conf中的配置如下：

<filter nginx.**>
  @type geoip
    geoip_lookup_key remote
    geoip_database /opt/td-agent/embedded/lib/ruby/gems/2.1.0/gems/fluent-plugin-geoip-1.2.0/data/GeoLiteCity.dat
    geoip2_database /opt/td-agent/embedded/lib/ruby/gems/2.1.0/gems/fluent-plugin-geoip-1.2.0/data/GeoLite2-City.mmdb
    <record>
     city         ${city.names.zh-CN["remote"]}     # skip adding fields if this field is null
     country      ${country.iso_code["remote"]}
     country_name ${country.names.zh-CN["remote"]}
     location `[${location.longitude["remote"]},${location.latitude["remote"]}]`
    </record>
</filter>

<filter nginx.**>
  @type parse_request_body
  key                request_body
  #discard_key        true
  add_field_prefix   body.
  only lat,lng
  array_value lat,lng
  array_value_key locatonGPS
  replace_key location
</filter>
複製程式碼

注意：由於我們需要在沒有客戶端經緯度的情況下，依然使用ip轉換，並且filter是單向資料流，所以 parse_request_body一定要配置在geo下方。

至此，資料地圖的資料處理部分第二階段工作結束。

後續，在目前的需求上，此外掛需要優化一點：

組合資料，使用標籤動態配置，想geo中配置location一樣，而不是現在死配置這種比較low的做法。

感興趣的同學，可以看我的github：

github.com/yifriday/fl…

EFK 配置geo-ip落地實踐
2018-10-11
EFK 配置geo-ip落地實踐（三）經緯度資料查詢及格式化輸出
2018-11-20
蜻蜓安全編寫外掛模組 webcrack 實踐
2022-05-10
Web
如何編寫 ProtoBuf 外掛 (二) ？
2022-01-09
Go - 如何編寫 ProtoBuf 外掛（二）？
2021-12-18
Go
Vue 外掛編寫與實戰
2017-08-23
Vue
編寫node 外掛
2019-05-10
編寫jq外掛
2018-12-29
egg外掛編寫
2019-02-16
Phonegap外掛編寫
2012-07-02
Grafana的Datasource外掛開發實踐二
2019-03-02
Grafana
WebRTC Gateway Janus入門：從配置到編寫外掛
2018-04-26
WebGateway
Rainbond通過外掛整合ELK/EFK，實現日誌收集
2021-12-27
AI
eggjs外掛編寫
2019-03-04
JS
如何編寫 ProtoBuf 外掛 (一) ？
2022-01-09
如何編寫 ProtoBuf 外掛 (三) ？
2022-01-09
vue外掛編寫小記
2018-03-24
Vue
編寫Ansj的Solr外掛
2014-02-25
Solr
Docker Compose部署 EFK（Elasticsearch + Fluentd + Kibana）收集日誌
2020-07-07
DockerElasticsearch
第二期：JQ外掛編寫入門（2）
2017-03-16
markdown-it 外掛如何寫（二）
2022-01-28
Go - 如何編寫 ProtoBuf 外掛 (三) ？
2022-01-16
Go
Go - 如何編寫 ProtoBuf 外掛 (一) ？
2021-12-18
Go
編寫自己的Babel外掛（一）
2018-12-04
Babel
如何編寫一個Jquery外掛
2013-07-03
jQuery
如何編寫Node.js外掛
2014-08-02
Node.js
kubernetes實踐之十一：EFK
2018-04-07
flutter外掛編寫及釋出流程
2021-03-29
Flutter
Flutter 外掛編寫必知必會
2018-12-26
Flutter
如何使用Python編寫vim外掛
2017-12-04
Python
phpstorm編寫程式碼特效外掛
2017-12-27
PHPORM特效
編寫最基本的Gradle外掛
2017-11-06
Gradle
編寫jquery常用外掛的基本格式
2015-03-01
jQuery
pual_bot 天氣外掛編寫
2014-06-25
自己動手編寫一個Mybatis外掛：Mybatis脫敏外掛
2020-08-11
MyBatis
Electron 外掛開發實踐
2022-05-17
Unity3D編輯器外掛編寫教程
2013-01-29
Unity3D
如何從零編寫一個vite外掛建立 vite 外掛通用模板
2024-08-19
Vite

EFK 配置geo-ip落地實踐（二）fluentd外掛編寫

前因

外掛安裝和配置

相關文章