require 'fluent/mixin/rewrite_tag_name' class Fluent::GeoipOutput < Fluent::BufferedOutput Fluent::Plugin.register_output('geoip', self) REGEXP_PLACEHOLDER_SINGLE = /^\$\{(?-?[^\[]+)\[['"](?-?[^'"]+)['"]\]\}$/ REGEXP_PLACEHOLDER_SCAN = /['"]?(\$\{[^\}]+?\})['"]?/ GEOIP_KEYS = %w(city latitude longitude country_code3 country_code country_name dma_code area_code region) config_param :geoip_database, :string, :default => File.dirname(__FILE__) + '/../../../data/GeoLiteCity.dat' config_param :geoip_lookup_key, :string, :default => 'host' config_param :tag, :string, :default => nil config_param :skip_adding_null_record, :bool, :default => false include Fluent::HandleTagNameMixin include Fluent::SetTagKeyMixin config_set_default :include_tag_key, false include Fluent::Mixin::RewriteTagName config_param :hostname_command, :string, :default => 'hostname' config_param :flush_interval, :time, :default => 0 config_param :log_level, :string, :default => 'warn' # Define `log` method for v0.10.42 or earlier unless method_defined?(:log) define_method("log") { $log } end def initialize require 'geoip' require 'yajl' super end def configure(conf) super @map = {} @geoip_lookup_key = @geoip_lookup_key.split(/\s*,\s*/) # enable_key_* format (legacy format) conf.keys.select{|k| k =~ /^enable_key_/}.each do |key| geoip_key = key.sub('enable_key_','') raise Fluent::ConfigError, "geoip: unsupported key #{geoip_key}" unless GEOIP_KEYS.include?(geoip_key) @geoip_lookup_key.zip(conf[key].split(/\s*,\s*/)).each do |lookup_field,record_key| if record_key.nil? raise Fluent::ConfigError, "geoip: missing value found at '#{key} #{lookup_field}'" end @map.store(record_key, "${#{geoip_key}['#{lookup_field}']}") end end if conf.keys.select{|k| k =~ /^enable_key_/}.size > 0 log.warn "geoip: 'enable_key_*' config format is obsoleted. use directive for now." log.warn "geoip: for further details referable to https://github.com/y-ken/fluent-plugin-geoip" end # directive conf.elements.select { |element| element.name == 'record' }.each { |element| element.each_pair { |k, v| element.has_key?(k) # to suppress unread configuration warning v = v[1..v.size-2] if quoted_value?(v) @map[k] = v validate_json = Proc.new { begin dummy_text = Yajl::Encoder.encode('dummy_text') Yajl::Parser.parse(v.gsub(REGEXP_PLACEHOLDER_SCAN, dummy_text)) rescue Yajl::ParseError => e raise Fluent::ConfigError, "geoip: failed to parse '#{v}' as json." end } validate_json.call if json?(v.tr('\'"\\', '')) } } @placeholder_keys = @map.values.join.scan(REGEXP_PLACEHOLDER_SCAN).map{ |placeholder| placeholder[0] }.uniq @placeholder_keys.each do |key| geoip_key = key.match(REGEXP_PLACEHOLDER_SINGLE)[:geoip_key] raise Fluent::ConfigError, "geoip: unsupported key #{geoip_key}" unless GEOIP_KEYS.include?(geoip_key) end @placeholder_expander = PlaceholderExpander.new if ( !@tag && !@remove_tag_prefix && !@remove_tag_suffix && !@add_tag_prefix && !@add_tag_suffix ) raise Fluent::ConfigError, "geoip: required at least one option of 'tag', 'remove_tag_prefix', 'remove_tag_suffix', 'add_tag_prefix', 'add_tag_suffix'." end @geoip = GeoIP::City.new(@geoip_database, :memory, false) end def start super end def format(tag, time, record) [tag, time, record].to_msgpack end def shutdown super end def write(chunk) chunk.msgpack_each do |tag, time, record| Fluent::Engine.emit(tag, time, add_geoip_field(record)) end end private def json?(text) text.match(/^\[.+\]$/) || text.match(/^\{.+\}$/) end def quoted_value?(text) # to improbe compatibility with fluentd v1-config trim_quote = text[1..text.size-2] text.match(/(^'.+'$|^".+"$)/) end def add_geoip_field(record) placeholder = create_placeholder(geolocate(get_address(record))) return record if @skip_adding_null_record && placeholder.values.first.nil? @map.each do |record_key, value| if value.match(REGEXP_PLACEHOLDER_SINGLE) rewrited = placeholder[value] elsif json?(value) rewrited = value.gsub(REGEXP_PLACEHOLDER_SCAN) {|match| match = match[1..match.size-2] if quoted_value?(match) Yajl::Encoder.encode(placeholder[match]) } rewrited = parse_json(rewrited) else rewrited = value.gsub(REGEXP_PLACEHOLDER_SCAN, placeholder) end record.store(record_key, rewrited) end return record end def parse_json(message) begin return Yajl::Parser.parse(message) rescue Yajl::ParseError => e log.info "geoip: failed to parse '#{message}' as json.", :error_class => e.class, :error => e.message return nil end end def get_address(record) address = {} @geoip_lookup_key.each do |field| address.store(field, record[field]); next if not record[field].nil? key = field.split('.') obj = record key.each {|k| break obj = nil if not obj.has_key?(k) obj = obj[k] } address.store(field, obj) end return address end def geolocate(addresses) geodata = {} addresses.each do |field, ip| geo = ip.nil? ? nil : @geoip.look_up(ip) geodata.store(field, geo) end return geodata end def create_placeholder(geodata) placeholder = {} @placeholder_keys.each do |placeholder_key| position = placeholder_key.match(REGEXP_PLACEHOLDER_SINGLE) next if position.nil? or geodata[position[:record_key]].nil? placeholder.store(placeholder_key, geodata[position[:record_key]][position[:geoip_key].to_sym]) end return placeholder end end