jfrog-saas-log-collector 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c2f46faac629e4f27dba067ead82eab90586e2a8a888a35c847e81701bf4847
+  data.tar.gz: 2f6ad9cedcdf46fbbfc36ee95551b04fff1da2fd362346d143e1239d8ba961ec
+SHA512:
+  metadata.gz: 589f0526abe38f28aab6cd7e0f5a7439ebd26a6a9cb28ea4bfe9fb01c9aca413e19d5202e89fbe322d491e34bedbf30acf23d2f83cfbaa32ac483f817c627da2
+  data.tar.gz: 404840d4c2649773586f7c35f8599a8bcb1d4b00d734b8e36f56c44d797892005fdae468e891dc21723386095f02e07a2684926be661abf67ae762e884eb205d

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [ jfrog-saas-log-collector change log ]
+
+## [0.1.1] - 2022-04-04
+
+- Initial release
+
+## [0.1.1 - 0.1.4] - 2022-04-05 - Yanked
+
+- Added Scheduler and Job concurrency handling if the gem is run in multiple terminals for the same config
+
+## [0.1.5] - 2022-04-06
+
+- Fixes to config file validation due to missing encoding

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at vasukin@jfrog.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 1.21'
+
+gem 'faraday', '~> 2.2.0'
+
+gem 'faraday-follow_redirects', '~> 0.2.0'
+
+gem 'faraday-gzip', '~> 0.1.0'
+
+gem 'faraday-retry', '~> 1.0.3'
+
+gem 'zlib', '~> 2.1.1'
+
+gem 'parallel', '~> 1.21.0'
+
+gem 'logger', '~> 1.5.0'
+
+gem 'rufus-scheduler', '~> 3.8.1'
+
+gem 'json-schema', '~> 2.8.1'
+
+gem 'addressable', '~> 2.8.0'
+
+gem 'tzinfo', '~> 2.0.4'
+
+gem 'tzinfo-data', '~> 1.2021.5'

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    jfrog-saas-log-collector (0.1.1)
+      addressable (~> 2.8.0)
+      faraday (~> 2.2.0)
+      faraday-follow_redirects (~> 0.2.0)
+      faraday-gzip (~> 0.1.0)
+      faraday-retry (~> 1.0.3)
+      json-schema (~> 2.8.1)
+      logger (~> 1.5.0)
+      minitest (~> 5.0)
+      parallel (~> 1.21.0)
+      rake (~> 13.0)
+      rubocop (~> 1.21)
+      rufus-scheduler (~> 3.8.1)
+      zlib (~> 2.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    et-orbi (1.2.7)
+      tzinfo
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-follow_redirects (0.2.0)
+      faraday (>= 2, < 3)
+    faraday-gzip (0.1.0)
+      faraday (>= 1.0)
+      zlib (~> 2.1)
+    faraday-net_http (2.0.1)
+    faraday-retry (1.0.3)
+    fugit (1.5.2)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.4)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    logger (1.5.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    raabro (1.4.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.25.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    rufus-scheduler (3.8.1)
+      fugit (~> 1.1, >= 1.1.6)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zlib (2.1.1)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  addressable (~> 2.8.0)
+  faraday (~> 2.2.0)
+  faraday-follow_redirects (~> 0.2.0)
+  faraday-gzip (~> 0.1.0)
+  faraday-retry (~> 1.0.3)
+  jfrog-saas-log-collector!
+  json-schema (~> 2.8.1)
+  logger (~> 1.5.0)
+  minitest (~> 5.0)
+  parallel (~> 1.21.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rufus-scheduler (~> 3.8.1)
+  zlib (~> 2.1.1)
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Vasuki Narayana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Jfrog::Saas::Log::Collector
+
+JFrog Saas Log Collector gem is intended for downloading and extracting of log files generated in Artifactory or Xray on the Jfrog Cloud.
+The Log Collection feature on the cloud instance has to be [enabled](https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API#ArtifactoryRESTAPI-EnableLogCollection) for this gem to perform the download and extract of the logs.
+
+## Installation
+
+Prerequisite: 
+
+For Gem based install, Ruby Interpreter has to be setup first, following is the recommended process to install Ruby
+
+```text
+
+1. Install Ruby Version Manager (RVM) as described in https://rvm.io/rvm/install#installation-explained, ensure to follow all the onscreen instructions provided to complete the rvm installation
+	* For installation across users a SUDO based install is recommended, the installation is as described in https://rvm.io/support/troubleshooting#sudo
+
+2. Once rvm installation is complete, verify the RVM installation executing the command 'rvm -v'
+
+3. Now install ruby v2.7.0 or above executing the command 'rvm install <ver_num>', ex: 'rvm install 2.7.5'
+
+4. Verify the ruby installation, execute 'ruby -v', gem installation 'gem -v' and 'bundler -v' to ensure all the components are intact
+
+5. Post completion of Ruby, Gems installation, the environment is ready to further install new gems, execute the following gem install commands one after other to setup the needed ecosystem
+
+```
+Install it:
+
+    $ gem install jfrog-saas-log-collector
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'jfrog-saas-log-collector'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Once the gem is successfully installed, use the gem to generate the sample config file,
+
+    $ jfrog-saas-log-collector -g <full_path_of_the_config_file>
+
+example
+
+    $  jfrog-saas-log-collector -g /var/opt/jfrog/saas/sampleconfig.yaml
+
+The config file sample would look like this, 
+
+```yaml
+connection:
+  jpd_url: "<saas_jpd_url>"
+  end_point_base: "artifactory"
+  username: "<admin_user>"
+  access_token: "<admin_access_token>"
+  open_timeout_in_secs: 20
+  read_timeout_in_secs: 60
+log:
+  log_ship_config: "access/api/v1/logshipping/config"
+  solutions_enabled: ["artifactory", "xray"]
+  log_types_enabled: ["access-request", "router-request"]
+  uri_date_pattern: "%Y-%m-%d"
+  audit_repo: "artifactory/jfrog-logs-audit"
+  log_repo: "artifactory/jfrog-logs"
+  debug_mode: false
+  target_log_path: "<path_to_extract_logs_for_artifactory>"
+  print_with_utc: false
+  log_file_retention_days: 5
+process:
+  parallel_process: 2
+  parallel_downloads: 5
+  historical_log_days: 2
+  write_logs_by_type: false
+  minutes_between_runs: 180
+```
+Provide all the necessary values to the tags which have angular braces like "<saas_jpd_url>" to "https://example.jfrog.io", fill in for all other segments. Do not change any other values unless the operation associated with the other tag is understood well.
+Once done, the jfrog-saas-log collector execution can be started by executing the command
+
+    $ jfrog-saas-log-collector -c <full_path_of_the_config_file>
+
+example
+
+    $  jfrog-saas-log-collector -c /var/opt/jfrog/saas/sampleconfig.yaml
+
+The gem records the progress or errors on the STDOUT / console and in a logfile (if the config provided is valid) which can be located at  <path_to_extract_logs_for_artifactory>/jfrog-saas-collector.log
+
+For all the options supported use
+
+    $ jfrog-saas-log-collector -h      OR    $ jfrog-saas-log-collector --help
+
+```shell
+Usage: jfrog-saas-log-collector [options]
+    -h, --help                       Prints this help
+    -g, --generate=CONFIG            Generates sample config file from template to target file provided
+    -c, --config=CONFIG              Executes the jfrog-saas-log-collector with the config file provided
+```
+
+## Contributing
+
+Bug reports are welcome on GitHub at https://github.com/jfrog/jfrog-saas-log-collector/issues.
+

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jfrog/saas/log/collector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/jfrog-saas-log-collector

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "jfrog/saas/log/collector"

data/lib/jfrog/saas/log/collector/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Jfrog
+  module Saas
+    module Log
+      module Collector
+        VERSION = '0.1.5'
+      end
+    end
+  end
+end