fluent-plugin-jfrog-metrics-deepakk 0.2.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3bfb05b0e349dcb3c40bce96824f130942d27675ff0b1c9c4b035bc4b392c484
+  data.tar.gz: fc504524219eef04b0fa68abf40efb67dd386fc7f02dab8959f83a0f72db1258
+SHA512:
+  metadata.gz: ee5da83a61ef21904c4cd2624a0ab51c8c787825a56a562ff5d367f752f189dbe42d3a4444632ecb907dd4a5ec44c89ec3614a8a88f33df52d71283f1d13ea55
+  data.tar.gz: bf2e177fa6579d654d9477835bedcadff5b363f94e8e2ab874bed0b0521aee2d9f29d147bae0b070b4f3fa774e850ed223ea1120e03df72663d7e71ff20bd6c6

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+fluent-plugin-jfrog-metrics-*.gem
+fluent-plugin-jfrog-metrics.iml

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-reporters', '>= 0.5.0'
+  gem 'rest-client', '~> 2.1.0'
+end

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-jfrog-metrics (0.2.13)
+      fluentd (>= 0.14.10, < 2)
+      rest-client (~> 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    cool.io (1.7.1)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    fluentd (1.16.1)
+      bundler
+      cool.io (>= 1.4.5, < 2.0.0)
+      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)
+      strptime (>= 0.2.4, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      webrick (~> 1.4)
+      yajl-ruby (~> 1.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http_parser.rb (0.8.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.1115)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    msgpack (1.7.1)
+    netrc (0.11.0)
+    power_assert (2.0.1)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    ruby-progressbar (1.11.0)
+    serverengine (2.3.2)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.5)
+    test-unit (3.5.0)
+      power_assert
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2023.3)
+      tzinfo (>= 1.0.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    webrick (1.8.1)
+    yajl-ruby (1.4.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  fluent-plugin-jfrog-metrics!
+  minitest
+  minitest-reporters (>= 0.5.0)
+  rake (~> 12.0)
+  rest-client (>= 2.1.0)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,111 @@
+# fluent-plugin-jfrog-metrics
+
+[Fluentd](https://fluentd.org/) input plugin to scrape metrics from JFrog Artifactory and Xray openmetrics API endpoints and export them to Fluentd to process into various outputs
+
+## Building
+
+To build / test locally use rake:
+
+```
+rake
+```
+
+To build install locally use bundler:
+
+```
+bundle install
+```
+
+This will install the gem shown below from source.
+
+## Development
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-jfrog-metrics"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+### Configuration
+
+You can generate configuration template:
+
+```
+$ fluent-plugin-config-format input jfrog-metrics
+```
+
+You can copy and paste generated documents here.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install rest-client
+```
+
+```
+$ gem install thread
+```
+
+```
+$ gem install fluent-plugin-jfrog-metrics
+```
+
+### Setup & configuration
+
+Fluentd is the supported log collector for this integration.
+For Fluentd setup and information, read the JFrog log analytics repository's [README.](https://github.com/jfrog/log-analytics/blob/master/README.md)
+
+#### Fluentd Output
+
+Download fluentd conf for different log-vendors. For example
+Splunk:
+
+Splunk setup can be found at [README.](https://github.com/jfrog/metrics/blob/main/splunk/README.md)
+
+```text
+wget https://raw.githubusercontent.com/jfrog/metrics/master/splunk/splunk_metrics.conf
+```
+
+#### Configuration parameters
+
+Integration is done by setting up Xray. Obtain JPD url and access token for API. Configure the source directive parameters specified below
+
+- **tag** (string) (required): The value is the tag assigned to the generated metrics.
+- **jpd_url** (string) (required): JPD url required to pull metrics, (note - if deployed on K8s use the localhost and port number combination per sidecar)
+- **username** (string) (required): USER is the Artifactory username for authentication
+- **apikey** (string) (required if token is not used, do refer Note section for specifics): API Key is the [Artifactory API Key](https://www.jfrog.com/confluence/display/JFROG/User+Profile#UserProfile-APIKey) for authentication
+- **token** (string) (required if apikey is not used, do refer Note section for specifics): Admin token is the [Artifactory Scoped Tokens](https://www.jfrog.com/confluence/display/JFROG/Access+Tokens#AccessTokens-GeneratingAdminTokens) for authentication
+- **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`
+- **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,
+  - ex: https://sample_base_url/artifactory or https://sample_base_url/xray
+  - Default value: false
+- **target_platform** (string) (optional): The target log-vendor ("SPLUNK", "NEWRELIC" or "DATADOG")
+  - 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.46 either Token or API Key can be used,
+- For Artifactory v7.47 and above token only must be used.
+
+## Copyright
+
+* Copyright(c) 2024 - JFrog
+* Maintainers - MahithaB, BenHarosh
+* License
+  - Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-jfrog-metrics.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = 'fluent-plugin-jfrog-metrics-deepakk'
+  spec.version = '0.2.14'
+  spec.authors = ['MahithaB, BenHarosh']
+  spec.email   = ['cpe-support@jfrog.com']
+
+  spec.summary       = %q{Fluentd Plugin for converting JFrog Artifactory, Xray generated metrics (Prometheus Exposition Format) to target observability platform format (Splunk HEC, New Relic, DataDog)}
+  spec.description   = %q{Fluentd Plugin for converting JFrog Artifactory, Xray generated metrics (Prometheus Exposition Format) to target observability platform format (Splunk HEC, New Relic, DataDog)}
+
+  spec.homepage      = 'https://github.com/jfrog/jfrog-fluentd-plugins/tree/main/fluent-plugin-jfrog-metrics'
+  spec.license       = 'Apache-2.0'
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ['lib']
+
+  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_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
+  spec.add_runtime_dependency "rest-client", "~> 2.1.0"
+end

data/lib/fluent/plugin/base_metrics_parser.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'json'
+
+class BaseMetricsParser
+
+  def normalise_data(data_to_normalize = [])
+    normalized_data = []
+    if data_to_normalize.length == 1
+      data_to_normalize.each do |interim_data|
+        normalized_data = interim_data.split(/\\n+|\\r+/).reject(&:empty?)
+      end
+    else
+      data_to_normalize.each_line do |interim_data|
+        normalized_data << interim_data.strip unless interim_data == "\n"
+      end
+    end
+    normalized_data
+  end
+
+  def clean_data(data_to_clean = [])
+    cleaned_data = []
+    data_to_clean.each do |interim_data|
+      cleaned_data << interim_data unless interim_data.include? '#'
+    end
+    cleaned_data
+  end
+
+  def serialize_data(hashed_data_array = [])
+    serialised_data = []
+    hashed_data_array.each do |interim_data|
+      serialised_data << JSON.parse(interim_data.to_json)
+    end
+    serialised_data
+  end
+
+  def emit_parsed_metrics(platform_metrics)
+    normalized_data = normalise_data(platform_metrics)
+    cleaned_data = clean_data(normalized_data)
+    hash_data_array = format_data(cleaned_data, @metric_prefix, '.')
+    serialized_data = serialize_data(hash_data_array)
+    serialized_data.each do |interim_data|
+      @router.emit(@tag, Fluent::Engine.now, interim_data)
+    end
+  end
+end

data/lib/fluent/plugin/datadog_metrics_parser.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'json'
+require_relative 'base_metrics_parser'
+
+class DatadogMetricsParser < BaseMetricsParser
+  def initialize(metric_prefix, router, tag)
+    @metric_prefix = metric_prefix
+    @router = router
+    @tag = tag
+  end
+
+  def format_data(cleaned_data = [], prefix = '', separator = '')
+    hash_data_array = []
+    data_hash = {}
+    data_array = []
+    cleaned_data.each do |interim_data|
+      metrics_hash = {}
+      tags = []
+      point = {}
+      points = []
+      if interim_data =~ /{/ && interim_data =~ /}/
+        metric_name, additional_dims, metric_val_and_time = interim_data.match(/(.*){(.*)}(.*)/i).captures
+        additional_dims.split("\",").each do |interim_data|
+          pair_data = interim_data.gsub("\"", "").gsub("{", "").gsub("}", "")
+          interim_data_value = pair_data.split("=", 2)[1]
+          interim_data_key = pair_data.split("=", 2)[0]
+          interim_data_tag = interim_data_key + ':' + interim_data_value
+          tags << interim_data_tag
+        end
+        if metric_val_and_time =~ / /
+          metrics_hash['metric'] = prefix + separator + metric_name
+          metric_timestamp = metric_val_and_time.strip.split[1]
+          point['timestamp'] = metric_timestamp[0,10].to_i if metric_timestamp != nil
+          point['value'] = metric_val_and_time.strip.split[0] =~ /^\S*\.\S*$/ ? metric_val_and_time.strip.split[0].to_f : metric_val_and_time.strip.split[0].to_i
+          points << point
+          metrics_hash['points'] = points
+          metrics_hash['tags'] = tags
+        end
+      else
+        metrics_hash['metric'], metric_value, metric_timestamp = interim_data.split
+        metrics_hash['metric'] = prefix + separator + metrics_hash['metric']
+        point['value'] = metric_value =~ /^\S*\.\S*$/ ? metric_value.to_f : metric_value.to_i
+        point['timestamp'] = metric_timestamp[0,10].to_i
+        points << point
+        metrics_hash['points'] = points
+      end
+      metrics_hash['type'] = 3
+      data_array << metrics_hash
+    end
+    data_hash["series"] = data_array
+    hash_data_array.push(data_hash)
+    hash_data_array
+  end
+
+end