Class: Fluent::Plugin::MongoStorage

Inherits:
Storage
  • Object
show all
Includes:
LoggerSupport, MongoAuth, MongoAuthParams
Defined in:
lib/fluent/plugin/storage_mongo.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from LoggerSupport

#configure_logger, included

Methods included from MongoAuth

#authenticate

Methods included from MongoAuthParams

included

Constructor Details

#initialize ⇒ MongoStorage

Returns a new instance of MongoStorage.



45
46
47
48
49
50
51
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 45

def initialize
  super

  @client_options = {}
  @collection_options = {capped: false}
  @store = {}
end

Instance Attribute Details

#client_options ⇒ Object (readonly)

Returns the value of attribute client_options.



43
44
45
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 43

def client_options
  @client_options
end

#collection_options ⇒ Object (readonly)

Returns the value of attribute collection_options.



43
44
45
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 43

def collection_options
  @collection_options
end

#store ⇒ Object (readonly)

for test



11
12
13
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 11

def store
  @store
end

Instance Method Details

#configure(conf) ⇒ Object 



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
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 53

def configure(conf)
  super

  unless @path
    if conf && !conf.arg.empty?
      @path = conf.arg
    else
      raise Fluent::ConfigError, "path or conf.arg for <storage> is required."
    end
  end

  if conf.has_key?('capped') and Fluent::Config.bool_value(conf['capped'])
    raise Fluent::ConfigError, "'capped_size' parameter is required on <storage> of Mongo storage" unless conf.has_key?('capped_size')
    @collection_options[:capped] = true
    @collection_options[:size] = Fluent::Config.size_value(conf['capped_size'])
    @collection_options[:max] = Fluent::Config.size_value(conf['capped_max']) if conf.has_key?('capped_max')
  end

  @client_options[:write] = {j: @journaled}
  @client_options[:write].merge!({w: @write_concern}) unless @write_concern.nil?
  @client_options[:ssl] = @ssl

  if @ssl
    @client_options[:ssl_cert] = @ssl_cert
    @client_options[:ssl_key] = @ssl_key
    @client_options[:ssl_key_pass_phrase] = @ssl_key_pass_phrase
    @client_options[:ssl_verify] = @ssl_verify
    @client_options[:ssl_ca_cert] = @ssl_ca_cert
  end
  configure_logger(@mongo_log_level)

  @client = client
  @client = authenticate(@client)
end

#delete(key) ⇒ Object 



129
130
131
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 129

def delete(key)
  @store.delete(key.to_s)
end

#fetch(key, defval) ⇒ Object 



121
122
123
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 121

def fetch(key, defval)
  @store.fetch(key.to_s, defval)
end

#get(key) ⇒ Object 



117
118
119
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 117

def get(key)
  @store[key.to_s]
end

#load ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 92

def load
  begin
    value = {}
    documents = @client[format_collection_name(@collection)].find(_id: @path)
    if documents.count >= 1
      documents.each do |document|
        value.merge!(document)
      end
    end
    value.delete('_id')
    unless value.is_a?(Hash)
      log.error "broken content for plugin storage (Hash required: ignored)", type: json.class
      log.debug "broken content", content: json_string
      return
    end
    @store = value
  rescue => e
    log.error "failed to load data for plugin storage from mongo", path: @path, error: e
  end
end

#multi_workers_ready? ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 88

def multi_workers_ready?
  true
end

#put(key, value) ⇒ Object 



125
126
127
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 125

def put(key, value)
  @store[key.to_s] = value
end

#save ⇒ Object 



113
114
115
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 113

def save
  operate(format_collection_name(@collection), @store)
end

#update(key, &block) ⇒ Object 



133
134
135
 
# File 'lib/fluent/plugin/storage_mongo.rb', line 133

def update(key, &block)
  @store[key.to_s] = block.call(@store[key.to_s])
end