Class: Fluent::Plugin::LokiOutput

Inherits:
Output
  • Object
show all
Defined in:
lib/fluent/plugin/out_loki.rb

Overview

Subclass of Fluent Plugin Output

Constant Summary collapse

DEFAULT_BUFFER_TYPE = 
'memory'

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#record_accessors ⇒ Object

Returns the value of attribute record_accessors.



31
32
33
 
# File 'lib/fluent/plugin/out_loki.rb', line 31

def record_accessors
  @record_accessors
end

Instance Method Details

#configure(conf) ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/fluent/plugin/out_loki.rb', line 72

def configure(conf) # rubocop:disable Metrics/CyclomaticComplexity
  compat_parameters_convert(conf, :buffer)
  super
  @uri = URI.parse(@url + '/loki/api/v1/push')
  unless @uri.is_a?(URI::HTTP) || @uri.is_a?(URI::HTTPS)
    raise Fluent::ConfigError, 'url parameter must be valid HTTP'
  end

  @record_accessors = {}
  conf.elements.select { |element| element.name == 'label' }.each do |element|
    element.each_pair do |k, v|
      element.has_key?(k) # rubocop:disable Style/PreferredHashMethods #to suppress unread configuration warning
      v = k if v.empty?
      @record_accessors[k] = record_accessor_create(v)
    end
  end
  @remove_keys_accessors = []
  @remove_keys.each do |key|
    @remove_keys_accessors.push(record_accessor_create(key))
  end

  if ssl_cert?
    load_ssl
    validate_ssl_key
  end

  raise "CA certificate file #{@ca_cert} not found" if !@ca_cert.nil? && !File.exist?(@ca_cert)
end

#generic_to_loki(chunk) ⇒ Object 



180
181
182
183
184
185
 
# File 'lib/fluent/plugin/out_loki.rb', line 180

def generic_to_loki(chunk)
  # log.debug("GenericToLoki: converting #{chunk}")
  streams = chunk_to_loki(chunk)
  payload = payload_builder(streams)
  payload
end

#http_opts(uri) ⇒ Object 



120
121
122
123
124
125
 
# File 'lib/fluent/plugin/out_loki.rb', line 120

def http_opts(uri)
  opts = {
    use_ssl: uri.scheme == 'https'
  }
  opts
end

#load_ssl ⇒ Object 



105
106
107
108
 
# File 'lib/fluent/plugin/out_loki.rb', line 105

def load_ssl
  @cert = OpenSSL::X509::Certificate.new(File.read(@cert)) if @cert
  @key = OpenSSL::PKey.read(File.read(@key)) if @key
end

#multi_workers_ready? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/fluent/plugin/out_loki.rb', line 116

def multi_workers_ready?
  true
end

#ssl_cert? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/fluent/plugin/out_loki.rb', line 101

def ssl_cert?
  !@key.nil? && !@cert.nil?
end

#ssl_opts(uri) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/fluent/plugin/out_loki.rb', line 159

def ssl_opts(uri)
  opts = {
    use_ssl: uri.scheme == 'https'
  }

  if !@cert.nil? && !@key.nil?
    opts = opts.merge(
      verify_mode: OpenSSL::SSL::VERIFY_PEER,
      cert: @cert,
      key: @key
    )
  end

  unless @ca_cert.nil?
    opts = opts.merge(
      ca_file: @ca_cert
    )
  end
  opts
end

#validate_ssl_key ⇒ Object 



110
111
112
113
114
 
# File 'lib/fluent/plugin/out_loki.rb', line 110

def validate_ssl_key
  if !@key.is_a?(OpenSSL::PKey::RSA) && !@key.is_a?(OpenSSL::PKey::DSA)
    raise "Unsupported private key type #{key.class}"
  end
end

#write(chunk) ⇒ Object

flush a chunk to loki



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/fluent/plugin/out_loki.rb', line 128

def write(chunk)
  # streams by label
  payload = generic_to_loki(chunk)
  body = { 'streams' => payload }

  # add ingest path to loki url

  req = Net::HTTP::Post.new(
    @uri.request_uri
  )
  req.add_field('Content-Type', 'application/json')
  req.add_field('X-Scope-OrgID', @tenant) if @tenant
  req.body = Yajl.dump(body)
  req.basic_auth(@username, @password) if @username

  opts = ssl_opts(@uri)

  log.debug "sending #{req.body.length} bytes to loki"
  res = Net::HTTP.start(@uri.host, @uri.port, **opts) { |http| http.request(req) }
  unless res&.is_a?(Net::HTTPSuccess)
    res_summary = if res
                    "#{res.code} #{res.message} #{res.body}"
                  else
                    'res=nil'
                  end
    log.warn "failed to #{req.method} #{@uri} (#{res_summary})"
    log.warn Yajl.dump(body)

  end
end