Class: MetricsHelper

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

Constant Summary collapse

@@obs_endpoint_exists = 
false

Instance Method Summary collapse

Constructor Details

#initialize(metric_prefix, jpd_url, username, apikey, token, common_jpd, verify_ssl, request_timeout) ⇒ MetricsHelper

Returns a new instance of MetricsHelper.



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/fluent/plugin/metrics_helper.rb', line 9

def initialize(metric_prefix, jpd_url, username, apikey, token, common_jpd, verify_ssl, request_timeout)
  @metric_prefix = metric_prefix
  @jpd_url = jpd_url
  @username = username
  @apikey = apikey
  @token = token
  @common_jpd = common_jpd
  @verify_ssl = verify_ssl
  @request_timeout = request_timeout
end

Instance Method Details

#check_endpoint(url, token, verify_ssl, request_timeout) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/fluent/plugin/metrics_helper.rb', line 50

def check_endpoint(url, token, verify_ssl, request_timeout)
  puts "#{Utility.get_time} Checking connectivity to endpoint: #{url}"
  response = RestClient::Request.new(
    method: :get,
    url: url,
    headers: { Authorization: "Bearer #{token}"},
    verify_ssl: verify_ssl,
    timeout: request_timeout
  ).execute do |response, request, result|
    if response.code == 200
      @@obs_endpoint_exists = true
      puts "#{Utility.get_time} #{url} exists: #{@@obs_endpoint_exists}. Storing the result for next executions"
    else
      @@obs_endpoint_exists = false 
      puts "#{Utility.get_time} Cannot verify #{url} endpoint. Received response code: #{response.code}, Response body:\n#{response.body}"
      raise "Unexpected response code: #{response.code} when calling #{url}" 
    end
  end
end

#execute_rest_call(url, user, password, token, use_token, verify_ssl, request_timeout) ⇒ Object 



70
71
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
100
 
# File 'lib/fluent/plugin/metrics_helper.rb', line 70

def execute_rest_call(url, user, password, token, use_token, verify_ssl, request_timeout)
  request = if use_token == true
    RestClient::Request.new(
      method: :get,
      url: url,
      headers: { Authorization: "Bearer #{token}" },
      verify_ssl: verify_ssl,
      timeout: request_timeout     
    )
  else
    RestClient::Request.new(
      method: :get,
      url: url,
      user: user,
      password: password,
      verify_ssl: verify_ssl,
      timeout: request_timeout,      
    )
  end

  request.execute do |response, request, result|
    case response.code
    when 200
      puts "#{Utility.get_time} #{@metric_prefix} metrics were successfully collected from url: #{url}"
      return response.body
    else
      puts "#{Utility.get_time} Cannot fetch #{@metric_prefix} metrics from url: #{url}. Received response code: #{response.code}, Response body:\n#{response.body}"
      raise "Unexpected response code: #{response.code} when calling #{url}"
    end
  end
end

#get_additional_metrics ⇒ Object 



40
41
42
43
44
45
46
47
48
 
# File 'lib/fluent/plugin/metrics_helper.rb', line 40

def get_additional_metrics
  puts "#{Utility.get_time} Aadditional metrics collection started"
  if (@metric_prefix == 'jfrog.artifactory' || @common_jpd == false) && !@token.nil? && @token != ''
    url = "#{@jpd_url}/observability/api/v1/metrics"
    puts "#{Utility.get_time} Collecting additional metrics from: #{url}"
    check_endpoint(url, @token, @verify_ssl, @request_timeout) if @@obs_endpoint_exists == nil? || !@@obs_endpoint_exists
    execute_rest_call(url, @username, nil, @token, true, @verify_ssl, @request_timeout) if @@obs_endpoint_exists
  end
end

#get_metrics ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/fluent/plugin/metrics_helper.rb', line 20

def get_metrics
  url = nil
  url = case @metric_prefix
        when 'jfrog.artifactory'
          "#{@jpd_url}/artifactory/api/v1/metrics"
        when 'jfrog.xray'
          "#{@jpd_url}/xray/api/v1/metrics"
        else
          "#{@jpd_url}/artifactory/api/v1/metrics"
        end

  puts "#{Utility.get_time} Executing #{@metric_prefix} metrics collection from: #{url}"
  if !@token.nil? && @token != ''
    execute_rest_call(url, @username, nil, @token, true, @verify_ssl, @request_timeout)
  elsif !@apikey.nil? && @apikey != ''
    execute_rest_call(url, @username, @apikey, nil, false, @verify_ssl, @request_timeout)
  end

end