Class: Fluent::GeoipOutput

Inherits:
BufferedOutput
  • Object
show all
Includes:
HandleTagNameMixin, Mixin::RewriteTagName, SetTagKeyMixin
Defined in:
lib/fluent/plugin/out_geoip.rb

Constant Summary collapse

REGEXP_PLACEHOLDER_SINGLE = 
/^\$\{(?<geoip_key>-?[^\[]+)\[['"](?<record_key>-?[^'"]+)['"]\]\}$/
REGEXP_PLACEHOLDER_SCAN = 
/['"]?(\$\{[^\}]+?\})['"]?/
GEOIP_KEYS = 
%w(city latitude longitude country_code3 country_code country_name dma_code area_code region)

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GeoipOutput

Returns a new instance of GeoipOutput.



31
32
33
34
35
36
 
# File 'lib/fluent/plugin/out_geoip.rb', line 31

def initialize
  require 'geoip'
  require 'yajl'

  super
end

Instance Method Details

#configure(conf) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/fluent/plugin/out_geoip.rb', line 38

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 <record></record> directive for now."
    log.warn "geoip: for further details referable to https://github.com/y-ken/fluent-plugin-geoip"
  end

  # <record></record> 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

#format(tag, time, record) ⇒ Object 



95
96
97
 
# File 'lib/fluent/plugin/out_geoip.rb', line 95

def format(tag, time, record)
  [tag, time, record].to_msgpack
end

#shutdown ⇒ Object 



99
100
101
 
# File 'lib/fluent/plugin/out_geoip.rb', line 99

def shutdown
  super
end

#start ⇒ Object 



91
92
93
 
# File 'lib/fluent/plugin/out_geoip.rb', line 91

def start
  super
end

#write(chunk) ⇒ Object 



103
104
105
106
107
 
# File 'lib/fluent/plugin/out_geoip.rb', line 103

def write(chunk)
  chunk.msgpack_each do |tag, time, record|
    Fluent::Engine.emit(tag, time, add_geoip_field(record))
  end
end