fluent-plugin-jfrog-metrics 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc48b6c9f8a51df6c59f938a6283e17751649320e9e02ec811ad05f2dd58fc0e
-  data.tar.gz: 8996298f2223575ae661e115a9eedf695d5fb14732bedc29e4b634bc69c20fa4
+  metadata.gz: be1f993ce6a17cbbd55addf9bd1c2c987861373b86d0c9e5bf57fba2391b89c6
+  data.tar.gz: 42caf47f85ef0005eae2b35b35c6c4f7cf9c0cb39bd8f8b361cdf282f8e5ea2c
 SHA512:
-  metadata.gz: eee23ebb31284a6a358f618f30a2e6a735e12fc6956c92a22b347db1f128d1b27b908f508a110b4ee93372032f017a4b397c04a98d83662643275ea0137d0915
-  data.tar.gz: 30837a031c859b1a3882b42e7ba20665d097531bb116ef63434315476a6141d338cc11c7d5f3373d03131d6062987ff219e73e3d7d6abe3b431fac15052ea087
+  metadata.gz: 459aa4c98d67051b19e5c3947277ade652eaaea9fb868bd41ac9ba1d0126bc15247d9b1f4076c21abe526ae74e9e0f68d565578916077ffcf3385717354f7b64
+  data.tar.gz: 41008a0e14481e8b1b0a9881ada4559cc4d2edbc13d5af4d43d294b26ebebab58710cd0dfcda55815541b77a129cc68f5fc3b668abcb460a0b8069d0465f5091

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-jfrog-metrics (0.2.5)
+    fluent-plugin-jfrog-metrics (0.2.8)
       fluentd (>= 0.14.10, < 2)
-      rest-client (~> 2.0)
+      rest-client (~> 2.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -93,12 +93,14 @@ Integration is done by setting up Xray. Obtain JPD url and access token for API.
   - Default value: false
 - **target_platform** (string) (optional): Output format of target platform allowed values SPLUNK and ELASTIC
   - Default value: `SPLUNK`
+- **verify_ssl** (true / false) (optional): This flag should be set as false in order to bypass client's ssl certificate verification. When false, sets ssl_opts['verify_ssl'] to OpenSSL::SSL::VERIFY_NONE. Otherwise, sets ssl_opts['verify_ssl'] to OpenSSL::SSL::VERIFY_PEER
+  - Default value: true
 
 Note:
 
 - For Artifactory v7.4 and below only API Key must be used,
-- For Artifactory v7.4 to 7.29 either Token or API Key can be used,
-- For Artifactory v7.30 and above token only must be used.
+- For Artifactory v7.4 to 7.46 either Token or API Key can be used,
+- For Artifactory v7.47 and above token only must be used.
 
 ## Copyright
 

data/fluent-plugin-jfrog-metrics.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = 'fluent-plugin-jfrog-metrics'
-  spec.version = '0.2.7'
+  spec.version = '0.2.8'
   spec.authors = ['MahithaB, BenHarosh']
   spec.email   = ['cpe-support@jfrog.com']
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'test-unit', '~> 3.0'
-  spec.add_development_dependency "rest-client", "~> 2.0"
+  spec.add_development_dependency "rest-client", "~> 2.1.0"
   spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
-  spec.add_runtime_dependency "rest-client", "~> 2.0"
+  spec.add_runtime_dependency "rest-client", "~> 2.1.0"
 end

data/lib/fluent/plugin/in_jfrog_metrics.rb

@@ -42,6 +42,7 @@ module Fluent
       config_param :metric_prefix, :string, default: ''
       config_param :target_platform, :string, default: 'SPLUNK'
       config_param :common_jpd, :bool, default: false
+      config_param :verify_ssl, :bool, default: true
 
       # `configure` is called before `start`.
       # 'conf' is a `Hash` that includes the configuration parameters.
@@ -85,8 +86,8 @@ module Fluent
       end
 
       def do_execute
-        puts('Executing metrics collection')
-        metrics_helper = MetricsHelper.new(@metric_prefix, @jpd_url, @username, @apikey, @token, @common_jpd)
+        puts('Metrics collection started')
+        metrics_helper = MetricsHelper.new(@metric_prefix, @jpd_url, @username, @apikey, @token, @common_jpd, @verify_ssl)
         platform_metrics = metrics_helper.get_metrics
 
         additional_metrics = metrics_helper.get_additional_metrics
@@ -95,16 +96,15 @@ module Fluent
         end
         if @target_platform == 'SPLUNK'
           parser = SplunkMetricsParser.new(@metric_prefix, router, @tag)
-        elsif @target_platform == 'ELASTIC'
-          parser = ElasticMetricsParser.new(@metric_prefix, router, @tag)
         elsif @target_platform == 'NEWRELIC'
           parser = NewRelicMetricsParser.new(@metric_prefix, router, @tag)
         elsif @target_platform == 'DATADOG'
           parser = DatadogMetricsParser.new(@metric_prefix, router, @tag)
         else
-          raise 'Parser Type is not valid.Should be SPLUNK or ELASTIC or NEWRELIC'
+          raise 'Parser Type is not valid.Should be SPLUNK or NEWRELIC or DATADOG'
         end
         parser.emit_parsed_metrics(platform_metrics)
+        puts('Metrics collection finished')
       end
     end
   end

data/lib/fluent/plugin/metrics_helper.rb

@@ -5,13 +5,14 @@ require 'rest-client'
 class MetricsHelper
   @@obs_endpoint_exists = false
 
-  def initialize(metric_prefix, jpd_url, username, apikey, token, common_jpd)
+  def initialize(metric_prefix, jpd_url, username, apikey, token, common_jpd, verify_ssl)
     @metric_prefix = metric_prefix
     @jpd_url = jpd_url
     @username = username
     @apikey = apikey
     @token = token
     @common_jpd = common_jpd
+    @verify_ssl = verify_ssl
   end
 
   def get_metrics
@@ -24,60 +25,63 @@ class MetricsHelper
           else
             "#{@jpd_url}/artifactory/api/v1/metrics"
           end
+
+    puts "Executing #{@metric_prefix} metrics collection from: #{url}"
     if !@token.nil? && @token != ''
-      execute_rest_call(url, @username, nil, @token, false, true)
+      execute_rest_call(url, @username, nil, @token, true, @verify_ssl)
     elsif !@apikey.nil? && @apikey != ''
-      execute_rest_call(url, @username, @apikey, nil, false, false)
+      execute_rest_call(url, @username, @apikey, nil, false, @verify_ssl)
     end
 
   end
 
   def get_additional_metrics
     if (@metric_prefix == 'jfrog.artifactory' || @common_jpd == false) && !@token.nil? && @token != ''
-      puts 'Executing additional metrics collection'
       url = "#{@jpd_url}/observability/api/v1/metrics"
-      check_endpoint(url, @token) if @@obs_endpoint_exists == nil? || !@@obs_endpoint_exists
-      execute_rest_call(url, @username, nil, @token, true, true) if @@obs_endpoint_exists
+      puts "Executing additional metrics collection from: #{url}"
+      check_endpoint(url, @token, @verify_ssl) if @@obs_endpoint_exists == nil? || !@@obs_endpoint_exists
+      execute_rest_call(url, @username, nil, @token, true, @verify_ssl) if @@obs_endpoint_exists
     end
   end
 
-  def check_endpoint(url, token)
+  def check_endpoint(url, token, verify_ssl)
     response = RestClient::Request.new(
       method: :get,
       url: url,
-      headers: { Authorization: "Bearer #{token}" }
+      headers: { Authorization: "Bearer #{token}"},
+      verify_ssl: verify_ssl
     ).execute do |response, request, result|
       @@obs_endpoint_exists = true if response.code == 200
       puts "#{url} exists? -> #{@@obs_endpoint_exists}, storing the result for next executions"
     end
   end
 
-  def execute_rest_call(url, user, password, token, ignore_exception, use_token)
+  def execute_rest_call(url, user, password, token, use_token, verify_ssl)
     request = if use_token == true
                 RestClient::Request.new(
                   method: :get,
                   url: url,
-                  headers: { Authorization: "Bearer #{token}" }
+                  headers: { Authorization: "Bearer #{token}" },
+                  verify_ssl: verify_ssl
                 )
               else
                 RestClient::Request.new(
                   method: :get,
                   url: url,
                   user: user,
-                  password: password
+                  password: password,
+                  verify_ssl: verify_ssl
                 )
               end
 
     request.execute do |response, request, result|
       case response.code
       when 200
+        puts "#{@metric_prefix} metrics were successfully collected from url: #{url}"
         return response.body
       else
-        if ignore_exception == true
-          return ''
-        else
-          raise Fluent::ConfigError, 'Cannot fetch #{@metric_prefix} metrics'
-        end
+        puts "Cannot fetch #{@metric_prefix} metrics from url: #{url}. Received response code: #{response.code}, Response body:\n#{response.body}"
+        raise Fluent::ConfigError, 'Cannot fetch #{@metric_prefix} metrics'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-jfrog-metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - MahithaB, BenHarosh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.0
 description: Fluentd Plugin for converting JFrog Artifactory, Xray generated metrics
   (Prometheus Exposition Format) to target observability platform format (Splunk HEC,
   New Relic, Elastic)