fluent-plugin-jfrog-metrics 0.2.10 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9376678b3169e51397b9d705e3fe663dc869af24cfb6003622bdd4b7609f269
-  data.tar.gz: 2119039f822220595e995d88b417fe9f43b0cdaa9b783959feb9ce349bc9615b
+  metadata.gz: 28f317687267209cdc5e43c874fa40503c6ab86d970ec1509ff1d3e1af7cf26f
+  data.tar.gz: 4ab7a27eeee244cb9b497c2d4d3b97553049ba859cdbda3b194c7cf4d81b3cdf
 SHA512:
-  metadata.gz: 5543013d5ff07db5c6046d1aed46383f80f3eb709e4344703c9dcef736716b05be80feea657c5be7ed399c24e6c446011e8a14e44ebdccd6566fd0c220f2285c
-  data.tar.gz: f44be96345b2c7dfee24b9f95a21ce0db4c49724180bd66d8af7ae8d2e5611a1244acc9c7e20820fcb7d3326595170062f28ebb3b8e3cb8d348a931beee4d998
+  metadata.gz: ebd57e01c5255ec2bd69201919c05069d90cb9847653cc8b620b89034e75bce2f06fe378897f0756f2c6aee257ae463ea32a1ccdc17b9ee7fd0f89a88eabdab2
+  data.tar.gz: 30a48056fda84ab46678855b9fa84270c6618518c5835e7ae3b853d3a27fd6dd8ee8b5dab907c00fd84c83a59e6bfaf551fec8ca3a8447fd0741f5a3a8656aa8

data/Gemfile.lock

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

data/README.md

@@ -88,8 +88,6 @@ Integration is done by setting up Xray. Obtain JPD url and access token for API.
 - **metric_prefix** (string) (required): This values pulls the specific metrics. Values can be - jfrog.artifactory, jfrog.xray
 - **execution_interval** (integer) (optional): Wait interval between pulling new events (scheduler)
   - Default value: `60`
-- **timeout_interval** (integer) (optional): Timeout interval for pulling new events (scheduler)
-  - Default value: `60`
 - **request_timeout** (integer) (optional): Http request timeout when calling Artifactory/Xray to pull new events (http client)
   - Default value: `20`
 - **common_jpd** (true / false) (optional): This flag should be set as true only for non-kubernetes installations or installations where JPD base URL is same to access both Artifactory and Xray,
@@ -101,7 +99,6 @@ Integration is done by setting up Xray. Obtain JPD url and access token for API.
   - Default value: true
 
 Note:
-
 - For Artifactory v7.4 and below only API Key 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.

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.10'
+  spec.version = '0.2.12'
   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.1.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.1.0"
+  spec.add_runtime_dependency "rest-client", ">= 2.1.0"
 end

data/lib/fluent/plugin/in_jfrog_metrics.rb

@@ -22,7 +22,6 @@ require_relative 'metrics_helper'
 require_relative 'newrelic_metrics_parser'
 require_relative 'splunk_metrics_parser'
 require_relative 'datadog_metrics_parser'
-require_relative 'utility'
 
 module Fluent
   module Plugin
@@ -38,13 +37,14 @@ module Fluent
       config_param :apikey, :string, default: '', :secret => true
       config_param :token, :string, default: '', :secret => true
       config_param :execution_interval, :time, default: 60
-      config_param :timeout_interval, :time, default: 60
       config_param :request_timeout, :time, default: 20
       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
 
+      $logger = nil
+
       # `configure` is called before `start`.
       # 'conf' is a `Hash` that includes the configuration parameters.
       # If the configuration is invalid, raise `Fluent::ConfigError`.
@@ -65,11 +65,18 @@ module Fluent
         raise Fluent::ConfigError, 'Must define the target_platform to be fone of the following (DATADOG, NEWRELIC, SPLUNK).' if !(['DATADOG', 'NEWRELIC', 'SPLUNK'].include?(@target_platform))
       end
 
+      def initialize
+        super
+      end
+
       # `start` is called when starting and after `configure` is successfully completed.
       def start
         super
         @running = true
-        @thread = Thread.new(&method(:run))
+        $logger = log
+        @thread = Thread.new do
+          run
+        end
       end
 
       def shutdown
@@ -79,26 +86,33 @@ module Fluent
       end
 
       def run
-        puts "#{Utility.get_time} Preparing metrics collection, creating timer task"
-        timer_task = Concurrent::TimerTask.new(execution_interval: @execution_interval, timeout_interval: @timeout_interval, run_now: true) do
-          puts "#{Utility.get_time} Timer task execution"
-          do_execute
+        $logger.info("Preparing metrics collection, creating timer task")
+        timer_task = Concurrent::TimerTask.new(execution_interval: @execution_interval, run_now: true) do
+          begin
+            $logger.info("Timer task execution started")
+            do_execute
+            next "Timer task execution finished successfully"
+          rescue => e
+            $logger.error("Error occurred when running Timer task: #{e.message}")
+            raise e
+          end
         end
+        timer_task.add_observer(TaskObserver.new)
         timer_task.execute
         sleep 100
       end
 
       def do_execute
         begin
-          puts "#{Utility.get_time} Metrics collection started"
-          metrics_helper = MetricsHelper.new(@metric_prefix, @jpd_url, @username, @apikey, @token, @common_jpd, @verify_ssl, @request_timeout)
+          $logger.info("Metrics collection started")
+          metrics_helper = MetricsHelper.new($logger, @metric_prefix, @jpd_url, @username, @apikey, @token, @common_jpd, @verify_ssl, @request_timeout)
           platform_metrics = metrics_helper.get_metrics
 
           additional_metrics = metrics_helper.get_additional_metrics
           if !additional_metrics.nil? && additional_metrics != ''
             platform_metrics += additional_metrics.to_s
           end
-          puts "#{Utility.get_time} Metrics collection finished"
+          $logger.info("Metrics collection finished")
 
           if @target_platform == 'SPLUNK'
             parser = SplunkMetricsParser.new(@metric_prefix, router, @tag)
@@ -109,19 +123,33 @@ module Fluent
           else
             raise 'Parser Type is not valid. target_platform Should be SPLUNK or NEWRELIC or DATADOG'
           end
+          $logger.debug("Emitting collected metrics started")
           parser.emit_parsed_metrics(platform_metrics)
+          $logger.debug("Emitting collected metrics finished")
 
         rescue RestClient::Exceptions::OpenTimeout
-          puts "#{Utility.get_time} The request timed out while trying to open a connection. The configured request timeout is: #{@request_timeout}"
+          $logger.info("The request timed out while trying to open a connection. The configured request timeout is: #{@request_timeout}")
         rescue RestClient::Exceptions::ReadTimeout
-          puts "#{Utility.get_time} The request timed out while waiting for a response. The configured request timeout is: #{@request_timeout}"
+          $logger.info("The request timed out while waiting for a response. The configured request timeout is: #{@request_timeout}")
         rescue  RestClient::Exceptions::RequestTimeout
-          puts "#{Utility.get_time} The request timed out. The configured request timeout is: #{@request_timeout}"
+          $logger.info("The request timed out. The configured request timeout is: #{@request_timeout}")
         rescue RestClient::ExceptionWithResponse => e
-          puts "#{Utility.get_time} HTTP request failed: #{e.response}"
+          $logger.info("HTTP request failed: #{e.response}")
         rescue StandardError => e
-          puts "#{Utility.get_time} An unexpected error occurred: #{e.message}"
-        end  
+          $logger.info("An unexpected error occurred during metrics collection: #{e.message}")
+        else
+          $logger.debug("Metrics collection and emission do_execute finished with no errors")
+        end
+      end
+
+      class TaskObserver
+        def update(time, result, e)
+          if result
+            $logger.info("Timer task Execution successfully returned: '#{result}' at: #{time}")
+          else
+            $logger.error("Timer task Execution failed with error: #{e} at: #{time}")
+          end
+        end
       end
     end
   end

data/lib/fluent/plugin/metrics_helper.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require 'rest-client'
-require_relative 'utility'
 
 class MetricsHelper
   @@obs_endpoint_exists = false
 
-  def initialize(metric_prefix, jpd_url, username, apikey, token, common_jpd, verify_ssl, request_timeout)
+  def initialize(logger, metric_prefix, jpd_url, username, apikey, token, common_jpd, verify_ssl, request_timeout)
+    @logger = logger
     @metric_prefix = metric_prefix
     @jpd_url = jpd_url
     @username = username
@@ -18,6 +18,7 @@ class MetricsHelper
   end
 
   def get_metrics
+    @logger.debug("Get metrics started")
     url = nil
     url = case @metric_prefix
           when 'jfrog.artifactory'
@@ -27,72 +28,80 @@ class MetricsHelper
           else
             "#{@jpd_url}/artifactory/api/v1/metrics"
           end
-
-    puts "#{Utility.get_time} Executing #{@metric_prefix} metrics collection from: #{url}"
+    
+    @logger.info("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
-
+    @logger.debug("Get metrics finished")
   end
 
   def get_additional_metrics
-    puts "#{Utility.get_time} Aadditional metrics collection started"
+    @logger.info("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}"
+      @logger.info("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
+    @logger.info("Aadditional metrics collection finished")
   end
 
   def check_endpoint(url, token, verify_ssl, request_timeout)
-    puts "#{Utility.get_time} Checking connectivity to endpoint: #{url}"
-    response = RestClient::Request.new(
+    @logger.debug("Checking connectivity to endpoint: #{url} started")
+    request = RestClient::Request.new(
       method: :get,
       url: url,
       headers: { Authorization: "Bearer #{token}"},
       verify_ssl: verify_ssl,
       timeout: request_timeout
-    ).execute do |response, request, result|
+    )
+
+    request.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" 
+        @logger.info("#{url} exists: #{@@obs_endpoint_exists}. Storing the result for next executions")
       else
         @@obs_endpoint_exists = false 
-        puts "#{Utility.get_time} Cannot verify endpoint. Skipping metrics collection from  #{url}. Received response code: #{response.code}, Response body:\n#{response.body}"
+        @logger.info("Cannot verify endpoint. Skipping metrics collection from  #{url}. Received response code: #{response.code}, Response body:\n#{response.body}")
       end
     end
+    @logger.debug("Checking connectivity to endpoint: #{url} finished")
   end
 
   def execute_rest_call(url, user, password, token, use_token, verify_ssl, request_timeout)
+    @logger.debug("Rest call to fetch metrics started")
     request = if use_token == true
+      @logger.debug("Using token for authentication")
       RestClient::Request.new(
         method: :get,
         url: url,
         headers: { Authorization: "Bearer #{token}" },
         verify_ssl: verify_ssl,
-        timeout: request_timeout     
+        timeout: request_timeout
       )
     else
+      @logger.debug("Using apiKey for authentication")
       RestClient::Request.new(
         method: :get,
         url: url,
         user: user,
         password: password,
         verify_ssl: verify_ssl,
-        timeout: request_timeout,      
+        timeout: request_timeout
       )
     end
-  
+
     request.execute do |response, request, result|
+      @logger.debug("Recieved response body: #{response.body} when fetching metrics")
       case response.code
       when 200
-        puts "#{Utility.get_time} #{@metric_prefix} metrics were successfully collected from url: #{url}"
+        @logger.info("#{@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}"
+        @logger.info("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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-jfrog-metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.12
 platform: ruby
 authors:
 - MahithaB, BenHarosh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,14 +56,14 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
@@ -90,14 +90,14 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
 description: Fluentd Plugin for converting JFrog Artifactory, Xray generated metrics
@@ -123,7 +123,6 @@ files:
 - lib/fluent/plugin/metrics_helper.rb
 - lib/fluent/plugin/newrelic_metrics_parser.rb
 - lib/fluent/plugin/splunk_metrics_parser.rb
-- lib/fluent/plugin/utility.rb
 - spec/fixtures/files/creds.rb
 - spec/fixtures/files/sample_artifactory_metrics.txt
 - spec/fixtures/files/sample_xray_metrics.txt

data/lib/fluent/plugin/utility.rb

@@ -1,7 +0,0 @@
-class Utility  
-    # one place to control time format for logginggit 
-    def self.get_time()
-      return Time.now.strftime("%Y-%m-%d %H:%M:%S")
-    end
-
-  end