fluent-plugin-jfrog-send-metrics 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a4ee75d92bb898f8398e2e8c83e30682c350bb94772d2e8a73606a48b28deb
-  data.tar.gz: 2a4261471690052c20d9c95acdb0c9f5bc61747b4850eba3d6e69487cb667844
+  metadata.gz: 01dd0aba88ecd2c738d0a44cd8692c61544ab76472b7e92ca7d2bded0a8cf683
+  data.tar.gz: 246352647868467d91d88dbe8cda0ce65ed411757f3d86e2fe1bcc9053391662
 SHA512:
-  metadata.gz: a3d2b6f84468d2047bbe9b51c3dfafba49a32d88b6b5906713a84892f849ee565295a3d4eb718c991757d24256f4f5a4e430abe3c8a068553d4ec76b287c48d6
-  data.tar.gz: b68ea4050bc6613f3ee28406802359f4da2294a00b06981af21a39e67ddc409a9832be1f8184cf4bd0b3130c83ad6742708bdccd22159eb114de9b56d06b5b4e
+  metadata.gz: 8eab565fd17b0a554e12633860b0d8c87a0efdc61b423c19f8b1df80dd2d343169594f73d790efd247b3d4427ef66af293e57e4bc97b212822b77b9cd50c62b7
+  data.tar.gz: 23a1a59d51b8bf2752770a25df3b2d4f7cf24000cfdc89a59dac1684398d49405614dc80c448ad97fcf6870c2b51991527f5b6a5779d283b8760de9117ea2243

data/Gemfile.lock

@@ -1,26 +1,32 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-jfrog-send-metrics (0.1.3)
+    fluent-plugin-jfrog-send-metrics (0.1.5)
       fluentd (>= 0.14.10, < 2)
-      rest-client (~> 2.0)
+      rest-client (~> 2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
+    base64 (0.2.0)
     builder (3.2.4)
-    concurrent-ruby (1.2.2)
-    cool.io (1.7.1)
+    concurrent-ruby (1.3.4)
+    cool.io (1.8.1)
+    csv (3.3.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    fluentd (1.16.1)
+    drb (2.2.1)
+    fluentd (1.17.0)
+      base64 (~> 0.2)
       bundler
       cool.io (>= 1.4.5, < 2.0.0)
+      csv (~> 3.2)
+      drb (~> 2.2)
       http_parser.rb (>= 0.5.1, < 0.9.0)
       msgpack (>= 1.3.1, < 2.0.0)
       serverengine (>= 2.3.2, < 3.0.0)
-      sigdump (~> 0.2.2)
+      sigdump (~> 0.2.5)
       strptime (>= 0.2.4, < 1.0.0)
       tzinfo (>= 1.0, < 3.0)
       tzinfo-data (~> 1.0)
@@ -39,7 +45,7 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    msgpack (1.7.1)
+    msgpack (1.7.2)
     netrc (0.11.0)
     power_assert (2.0.1)
     rake (12.3.3)
@@ -51,13 +57,13 @@ GEM
     ruby-progressbar (1.11.0)
     serverengine (2.3.2)
       sigdump (~> 0.2.2)
-    sigdump (0.2.4)
+    sigdump (0.2.5)
     strptime (0.2.5)
     test-unit (3.5.3)
       power_assert
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    tzinfo-data (1.2023.3)
+    tzinfo-data (1.2024.1)
       tzinfo (>= 1.0.0)
     unf (0.1.4)
       unf_ext

data/README.md

@@ -64,20 +64,24 @@ Configure the match directive parameters as specified below
 ```
 <match jfrog.metrics.**>
   @type jfrog_send_metrics
-  target_platform "NEWRELIC"
+  target_platform "NEWRELIC" # or "DATADOG"
   apikey <api_key>
+  url https://metric-api.newrelic.com/metric/v1 # or DataDog's metrics URL
+  http_proxy <proxy_url>
 </match>
-
 ```
+
 #### Configuration parameters
 
 Obtain respective authentication credentials for log-vendors
 
 * **target_platform**(string)(required): The target log-vendor ("NEWRELIC" or "DATADOG")
 * **apikey**(string)(required): APIKEY is the apikey of log-vendor for authentication(LicenseKey for NewRelic)
+* **url**(string)(required): Metrics url of the mertics-vendor (Metrics URL for NewRelic or DataDog)
+* **http_proxy**(string)(optional): Proxy server URL - which will proxy http/s calls to your observability vendor (DataDog/NewRelic)
 
 ## Copyright
 
-* Copyright(c) 2022- MahithaB
+* Copyright(c) 2024- MahithaB, BenH
 * License
   * Apache License, Version 2.0

data/fluent-plugin-jfrog-send-metrics.gemspec

@@ -3,9 +3,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-jfrog-send-metrics"
-  spec.version = "0.1.3"
-  spec.authors = ["MahithaB"]
-  spec.email   = ["60710901+MahithaB@users.noreply.github.com"]
+  spec.version = "0.1.5"
+  spec.authors = ["MahithaB", "BenH"]
+  spec.email   = ["partner_support@jfrog.com"]
 
   spec.summary       = %q{Fluentd Plugin for sending metrics to the respective log-vendor}
   spec.description   = %q{Fluentd Plugin for sending metrics to the respective log-vendor}
@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "test-unit", "~> 3.0"
   spec.add_development_dependency "rest-client", "~> 2.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/datadog_metrics_sender.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'json'
 require 'rest-client'
+require 'uri'
 
 class DatadogMetrics
   def initialize(apikey, url)
@@ -8,20 +9,61 @@ class DatadogMetrics
     @url = url
   end
 
-  def send_metrics(metrics_data)
+  def add_custom_data(ddtags, record)
+    if ddtags.length() > 0
+      record_series = record['series']
+      data_array = []
+      record_series.each do |interim_data|
+        interim_data['tags'] ||= []
+        interim_data['tags'].push(*ddtags)
+        data_array << interim_data
+      end
+      record['series'] = data_array
+      return record
+    end
+    return record
+  end
+
+  def send_metrics(ddtags, http_proxy, record)
+    puts "Additional tags to be added to metrics are", ddtags
+    metrics_data = add_custom_data(ddtags, record)
     puts "Sending received metrics data"
-    response = RestClient::Request.new(
-        method: :post,
-        url: @url,
-        payload:  metrics_data.to_json,
-        headers: {'DD-API-KEY': @apikey, content_type: :json }
-    ).execute do |response, request, result|
-      case response.code
-      when 202
-        return response.body
-      else
-        puts 'Cannot send metrics to Datadog', response.body
+
+    if http_proxy
+      RestClient.proxy = URI.parse(http_proxy)
+      puts "Using http_proxy param to set proxy for request. Proxy url: #{RestClient.proxy}"
+    elsif ENV['HTTP_PROXY']
+      RestClient.proxy = ENV['HTTP_PROXY']
+      puts "Using 'HTTP_PROXY' environment variable to set proxy for request. Proxy url: #{RestClient.proxy}"
+    elsif ENV['http_proxy']
+      RestClient.proxy = ENV['http_proxy']
+      puts "Using 'http_proxy' environment variable to set proxy for request. Proxy url: #{RestClient.proxy}"
+    elsif ENV['https_proxy']
+      RestClient.proxy = ENV['https_proxy']
+      puts "Using 'https_proxy' environment variable to set proxy for request. Proxy url: #{RestClient.proxy}"
+    end
+
+    begin
+      response = RestClient::Request.new(
+          method: :post,
+          url: @url,
+          payload:  metrics_payload.to_json,
+          headers: {params: {'Api-Key' => @apikey}}
+      ).execute do |response, request, result|
+        case response.code
+        when 202
+          puts 'Metrics were successfully sent to DataDog'
+          return response.body
+        else
+          puts "Cannot send metrics to DataDog. Received response code: %d"  % [response&.code]
+        end
       end
+    rescue Net::HTTPClientException => e
+      # Handle the HTTP client exception
+      puts "An HTTP client error occurred when calling DataDog metrics: #{e.message}"
+    rescue StandardError => e
+      # Handle any other exceptions
+      puts "An error occurred when sending metrics to DataDog: #{e.message}"
     end
   end
 end

data/lib/fluent/plugin/newrelic_metrics_sender.rb

@@ -8,22 +8,46 @@ class NewRelicMetrics
     @url = url
   end
 
-  def send_metrics(metrics_data)
+  def send_metrics(metrics_data, http_proxy)
     puts "Sending received metrics data"
     metrics_payload = []
     metrics_payload.push(JSON.parse(metrics_data.to_json))
-    response = RestClient::Request.new(
-        method: :post,
-        url: @url,
-        payload:  metrics_payload.to_json,
-        headers: {params: {'Api-Key' => @apikey}}
-    ).execute do |response, request, result|
-      case response.code
-      when 202
-        return response.body
-      else
-        puts 'Cannot send metrics to NewRelic'
+
+    if http_proxy
+      RestClient.proxy = URI.parse(http_proxy)
+      puts "Using http_proxy param to set proxy for request. Proxy url: #{RestClient.proxy}"
+    elsif ENV['HTTP_PROXY']
+      RestClient.proxy = ENV['HTTP_PROXY']
+      puts "Using 'HTTP_PROXY' environment variable to set proxy for request. Proxy url: #{RestClient.proxy}"
+    elsif ENV['http_proxy']
+      RestClient.proxy = ENV['http_proxy']
+      puts "Using 'http_proxy' environment variable to set proxy for request. Proxy url: #{RestClient.proxy}"
+    elsif ENV['https_proxy']
+      RestClient.proxy = ENV['https_proxy']
+      puts "Using 'https_proxy' environment variable to set proxy for request. Proxy url: #{RestClient.proxy}"
+    end
+
+    begin
+      response = RestClient::Request.new(
+          method: :post,
+          url: @url,
+          payload:  metrics_payload.to_json,
+          headers: {params: {'Api-Key' => @apikey}}
+      ).execute do |response, request, result|
+        case response.code
+        when 202
+          puts 'Metrics were successfully sent to NewRelic'
+          return response.body
+        else
+          puts "Cannot send metrics to NewRelic. Received response code: %d"  % [response&.code]
+        end
       end
+    rescue Net::HTTPClientException => e
+      # Handle the HTTP client exception
+      puts "An HTTP client error occurred when sending metrics to NewRelic: #{e.message}"
+    rescue StandardError => e
+      # Handle any other exceptions
+      puts "An error occurred when sending metrics to NewRelic: #{e.message}"
     end
   end
 end

data/lib/fluent/plugin/out_jfrog_send_metrics.rb

@@ -28,6 +28,8 @@ module Fluent
       config_param :target_platform, :string, default: ''
       config_param :apikey, :string, default: ''
       config_param :url, :string, default: 'https://metric-api.newrelic.com/metric/v1'
+      config_param :ddtags, :array, default: []
+      config_param :http_proxy, :string, :default => nil
 
       # `configure` is called before `start`.
       # 'conf' is a `Hash` that includes the configuration parameters.
@@ -37,17 +39,16 @@ module Fluent
         raise Fluent::ConfigError, 'Must define the vendor to use for getting the metrics.' if @target_platform == ''
 
         raise Fluent::ConfigError, 'Must define the apikey to use for authentication.' if @apikey == ''
-
       end
 
       def process(tag, es)
         es.each do |time, record|
           if @target_platform == 'NEWRELIC'
             vendor = NewRelicMetrics.new(@apikey, @url)
-            vendor.send_metrics(record)
+            vendor.send_metrics(record, @http_proxy)
           elsif @target_platform == 'DATADOG'
             vendor = DatadogMetrics.new(@apikey, @url)
-            vendor.send_metrics(record)
+            vendor.send_metrics(@ddtags, @http_proxy, record)
           end
         end
       end

data/test/plugin/test_out_jfrog_send_metrics.rb

@@ -15,7 +15,7 @@ class JfrogSendMetricsOutputTest < Test::Unit::TestCase
   # Default configuration for tests
   CONFIG = %(
      target_platform "NEWRELIC"
-     apikey ""
+     apikey "apiKey"
      url "https://metric-api.newrelic.com/metric/v1"
    )
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-jfrog-send-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - MahithaB
+- BenH
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2024-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,17 +93,17 @@ 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 sending metrics to the respective log-vendor
 email:
-- 60710901+MahithaB@users.noreply.github.com
+- partner_support@jfrog.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Fluentd Plugin for sending metrics to the respective log-vendor