Class: LogStash::Outputs::Edge_Prom

Inherits:
Base
  • Object
show all
Includes:
Edge
Defined in:
lib/logstash/outputs/edge_prom.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Edge

#to_ns

Instance Attribute Details

#batch ⇒ Object (readonly)

Returns the value of attribute batch.


71
72
73
 
# File 'lib/logstash/outputs/edge_prom.rb', line 71

def batch
  @batch
end

Instance Method Details

#add_entry_to_batch(e) ⇒ Object

Add an entry to the current batch returns false if the batch is full and the entry can’t be added.


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/logstash/outputs/edge_prom.rb', line 193

def add_entry_to_batch(e)
  line = e.entry['line']
  # we don't want to send empty lines.
  return true if line.to_s.strip.empty?

  if @batch.nil?
    @batch = Batch.new(e)
    return true
  end

  if @batch.size_bytes_after(line) > @batch_size
    return false
  end
  @batch.add(e)
  return true
end

#batch_size ⇒ Object

‘Maximum batch size to accrue before pushing to loki. Defaults to 102400 bytes’


51
 
# File 'lib/logstash/outputs/edge_prom.rb', line 51

config :batch_size, :validate => :number, :default => 102400, :required => false

#batch_wait ⇒ Object

‘Interval in seconds to wait before pushing a batch of records to loki. Defaults to 1 second’


54
 
# File 'lib/logstash/outputs/edge_prom.rb', line 54

config :batch_wait, :validate => :number, :default => 1, :required => false

#ca_cert ⇒ Object

‘TLS’


48
 
# File 'lib/logstash/outputs/edge_prom.rb', line 48

config :ca_cert, :validate => :path, :required => false

#cert ⇒ Object

‘Client certificate’


44
 
# File 'lib/logstash/outputs/edge_prom.rb', line 44

config :cert, :validate => :path, :required => false

#client_id ⇒ Object

‘BasicAuth credentials’


25
 
# File 'lib/logstash/outputs/edge_prom.rb', line 25

config :client_id, :validate => :string, :required => true

#close ⇒ Object 


220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/logstash/outputs/edge_prom.rb', line 220

def close
  @entries.close
  @mutex.synchronize do 
    @stop = true 
  end
  @batch_wait_thread.join
  @batch_size_thread.join

  # if by any chance we still have a forming batch, we need to send it.
  send(@batch) if !@batch.nil?
  @batch = nil
end

#createClient ⇒ Object 


242
243
244
245
246
 
# File 'lib/logstash/outputs/edge_prom.rb', line 242

def createClient()
  @logger.info("createClient: started method")
  client = OAuth2::Client.new(@client_id, @client_secret, auth_scheme: "basic_auth", site: @tokenurl_domain,:token_url => @tokenurl_endpoint)
  return client
end

#createClientwithProxy ⇒ Object 


248
249
250
251
252
253
254
255
 
# File 'lib/logstash/outputs/edge_prom.rb', line 248

def createClientwithProxy()
  #@logger.info("createClient: started method")
 conn_opts = {}
 conn_opts = conn_opts.merge('ssl' => {verify: false})
 conn_opts = conn_opts.merge('proxy' => @proxy_url)
 client = OAuth2::Client.new(@client_id, @client_secret, auth_scheme: "basic_auth", site: @tokenurl_domain,:token_url => @tokenurl_endpoint, :connection_opts => conn_opts)
  return client
end

#edge_http_request(token, payload) ⇒ Object 


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/logstash/outputs/edge_prom.rb', line 265

def edge_http_request(token, payload)
  @logger.info("edge_http_request: started method")
  cntLines = JSON.parse(payload)["streams"][0]["values"].size
  @logger.info("processing #{cntLines} lines to edge-prom")
  retry_count = 0
  delay = @min_delay
  begin      
    res = token.post(@uri, {:body => payload1, :headers => params})
    status_code = "#{res.status}"
    @logger.info("send: status_code", :status_code => status_code)
    begin
      @logger.info("send: res_body", :res_body => res)
      #JSON.parse(res.body)
      #@logger.info("send res parsed", :res.parsed => res.parsed)
    rescue StandardError => err
      @logger.warn("Failed to send batch, attempt: ", :error_inspect => err.inspect, :error => err)
    end
    return status_code if !status_code.nil? && status_code.to_i != 429 && status_code.to_i.div(100) != 5
    return res
    raise StandardError.new res
  rescue StandardError => e
    retry_count += 1
    @logger.warn("Failed to send batch, attempt: #{retry_count}/#{@retries}", :error_inspect => e.inspect, :error => e)
    if retry_count < @retries
      sleep delay
      if delay * 2 <= @max_delay
        delay = delay * 2
      else
        delay = @max_delay
      end
      retry
    else
      @logger.error("Failed to send batch", :error_inspect => e.inspect, :error => e)
      return res
    end
  end
end

#getToken(client) ⇒ Object 


257
258
259
260
261
262
263
 
# File 'lib/logstash/outputs/edge_prom.rb', line 257

def getToken(client)
  params = {}
  opts = {}
  params = params.merge('scope' => @scopes)
  access = client.client_credentials.get_token(params, opts)
  return access
end

#include_fields ⇒ Object

‘An array of fields to map to labels, if defined only fields in this list will be mapped.’


63
 
# File 'lib/logstash/outputs/edge_prom.rb', line 63

config :include_fields, :validate => :array, :default => [], :required => false

#insecure_skip_verify ⇒ Object

‘Disable server certificate verification’


41
 
# File 'lib/logstash/outputs/edge_prom.rb', line 41

config :insecure_skip_verify, :validate => :boolean, :default => false, :required => false

#is_batch_expired ⇒ Object 


210
211
212
 
# File 'lib/logstash/outputs/edge_prom.rb', line 210

def is_batch_expired
  return !@batch.nil? && @batch.age() >= @batch_wait
end

#load_ssl ⇒ Object 


153
154
155
156
 
# File 'lib/logstash/outputs/edge_prom.rb', line 153

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

#max_batch_size ⇒ Object 


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/logstash/outputs/edge_prom.rb', line 105

def max_batch_size
  #@logger.info("max_batch_size: started method")
  loop do
    @mutex.synchronize do
      return if @stop
    end

    e = @entries.deq
    return if e.nil?

    @mutex.synchronize do
      if !add_entry_to_batch(e)
        @logger.debug("Max batch_size is reached. Sending batch to edge-loki")
        send(@batch)
        @batch = Batch.new(e)
      end
    end
  end
end

#max_batch_wait ⇒ Object 


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/logstash/outputs/edge_prom.rb', line 125

def max_batch_wait
  # minimum wait frequency is 10 milliseconds
 min_wait_checkfrequency = 1/100
 max_wait_checkfrequency = @batch_wait
 if max_wait_checkfrequency < min_wait_checkfrequency
  max_wait_checkfrequency = min_wait_checkfrequency
  end

  loop do
    @mutex.synchronize do
      return if @stop
    end

    sleep(max_wait_checkfrequency)
    if is_batch_expired
      @mutex.synchronize do
        @logger.debug("Max batch_wait time is reached. Sending batch to loki")
        send(@batch)
        @batch = nil
      end
    end
  end
end

#max_delay ⇒ Object

‘Backoff configuration. Maximum backoff time between retries. Default 300s’


66
 
# File 'lib/logstash/outputs/edge_prom.rb', line 66

config :max_delay, :validate => :number, :default => 300, :required => false

#message_field ⇒ Object

‘Log line field to pick from logstash. Defaults to “message”’


57
 
# File 'lib/logstash/outputs/edge_prom.rb', line 57

config :message_field, :validate => :string, :default => "message", :required => false

#min_delay ⇒ Object

‘Backoff configuration. Initial backoff time between retries. Default 1s’


60
 
# File 'lib/logstash/outputs/edge_prom.rb', line 60

config :min_delay, :validate => :number, :default => 1, :required => false

#proxy_url ⇒ Object

‘Proxy URL’


38
 
# File 'lib/logstash/outputs/edge_prom.rb', line 38

config :proxy_url, :validate => :string, :required => false

#receive(event) ⇒ Object 


216
217
218
 
# File 'lib/logstash/outputs/edge_prom.rb', line 216

def receive(event)
  @entries << Entry.new(event, @message_field, @include_fields)
end

#register ⇒ Object 


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
100
101
102
103
 
# File 'lib/logstash/outputs/edge_prom.rb', line 73

def register
  puts "1"
  @uri = URI.parse(@url)
  unless @uri.is_a?(URI::HTTP) || @uri.is_a?(URI::HTTPS)
    raise LogStash::ConfigurationError, "url parameter must be valid HTTP, currently '#{@url}'"
  end

  if @min_delay > @max_delay
    raise LogStash::ConfigurationError, "Min delay should be less than Max delay, currently 'Min delay is #{@min_delay} and Max delay is #{@max_delay}'"
  end

  @logger.info("Prom output plugin", :class => self.class.name)

  # initialize Queue and Mutex
  @entries = Queue.new 
  @mutex = Mutex.new
  @stop = false

  # create nil batch object.
  @batch = nil

  # validate certs
  if ssl_cert?
    load_ssl
    validate_ssl_key
  end

  # start batch_max_wait and batch_max_size threads
  @batch_wait_thread = Thread.new{max_batch_wait()}
  @batch_size_thread = Thread.new{max_batch_size()}
end

#retries ⇒ Object

‘Backoff configuration. Maximum number of retries to do’


69
 
# File 'lib/logstash/outputs/edge_prom.rb', line 69

config :retries, :validate => :number, :default => 10, :required => false

#scopes ⇒ Object

‘Scopes’


35
 
# File 'lib/logstash/outputs/edge_prom.rb', line 35

config :scopes, :validate => :string, :required => true

#send(batch) ⇒ Object 


233
234
235
236
237
238
239
240
 
# File 'lib/logstash/outputs/edge_prom.rb', line 233

def send(batch)
  @logger.info("send: started method")
  payload = batch.to_json
  client = createClient()
  access = getToken(client)
  client = Edge::TimeSeries.new()
  client.Send(@uri, access)
end

#single ⇒ Object

‘A single instance of the Output will be shared among the pipeline worker threads’


19
 
# File 'lib/logstash/outputs/edge_prom.rb', line 19

concurrency :single

#ssl_cert? ⇒ Boolean

Returns:

  • (Boolean) 

149
150
151
 
# File 'lib/logstash/outputs/edge_prom.rb', line 149

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

#ssl_opts(uri) ⇒ Object 


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/logstash/outputs/edge_prom.rb', line 164

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

   # disable server certificate verification
  if @insecure_skip_verify
    opts = opts.merge(
      verify_mode: OpenSSL::SSL::VERIFY_NONE
    )
  end

  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

#tokenurl_domain ⇒ Object

‘Prom Token URL Domain’


29
 
# File 'lib/logstash/outputs/edge_prom.rb', line 29

config :tokenurl_domain, :validate => :string, :required => true

#tokenurl_endpoint ⇒ Object

‘Prom Token URL Endpoint’


32
 
# File 'lib/logstash/outputs/edge_prom.rb', line 32

config :tokenurl_endpoint, :validate => :string, :default => "oauth2/v2.0/token", :required => false

#url ⇒ Object

‘Prom URL’


22
 
# File 'lib/logstash/outputs/edge_prom.rb', line 22

config :url, :validate => :string, :required => true

#validate_ssl_key ⇒ Object 


158
159
160
161
162
 
# File 'lib/logstash/outputs/edge_prom.rb', line 158

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