codemonitor 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf55eb8d37288cec3ce8e828f6705c552d78707084648062b303a75bc7d0a063
-  data.tar.gz: 40a0b1d17eeb986534b812f2668a79eeee4ecf2fb21ec40fe1a672dce8b61a34
+  metadata.gz: 9e6c5534fbc28c7134e0d88898112fd0eff5db4c92bb0ac86833bb4daff955d6
+  data.tar.gz: c9d7dc28df1e2d07e6b5377b320df7e947bcb72e13b6fa1dfe3981325d1fc9a0
 SHA512:
-  metadata.gz: 7fd6aad0e254c9e0efebff094266fa4528bd640a1671a26c8523d86daf4944c72e8116f55bbb87d74bf5f194ada216624f28a3d0de10d962541f768e8c720344
-  data.tar.gz: 38ae84cbcb7888349e1309d6f0008dd62f6c537818ba93197abbf40eed406222c6bad00e990c193f4d6dcc569038bb81011fe4570b8051ea09a98587d7c3a99a
+  metadata.gz: ea0fe2d521164f1386c4d616a2d8a539265c575af18789184672578711207289b506f67b4ed13fa52768389f8df496561206ea7ca73cdb43793f2f31a66dcd6e
+  data.tar.gz: 22fcaa2bf3f0c58f565cf055c214ac993cc59b8ea45ff0523d5895060a7adf6cb475bb3db0ec90dbfd22dc8772241c0ee02f5338afb01b7626125f4811ab80c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    codemonitor (0.2.0)
+    codemonitor (0.3.0)
       dogapi (~> 1.45)
 
 GEM

data/README.md

@@ -1,9 +1,120 @@
-# CodeMonitor
+# 🖥️ CodeMonitor
 
 A engine to collect multiple metrics from your repository and push them to a
 time series provider.
 
 
-# Inspiration
+# Engines
 
-https://github.com/scribd/github-action-datadog-reporting
+## Git
+
+Collect multiple metrics from the a Git repository.
+
+**Requirements / Setup**:
+
+You need a `.git` folder present in the current folder: 
+
+**Options**:
+
+`CODEMONITOR_GIT_FILES_THRESHOLD`: Don't emit metrics about number of files, from those that are above of this threshold. (Default: `0`)
+
+## Eslint
+
+Collect multiple metrics from the a project with [Eslint](https://eslint.org/) configured.
+
+**Requirements / Setup**:
+
+You need a `.eslintrc.js` and a `eslint.output.json` file present in the current folder.
+
+You can generate the `eslint.output.json` file with this example command:
+
+```
+eslint -f json -o eslint.output.json
+```
+**Options**:
+
+`CODEMONITOR_ESLINT_THRESHOLD`: Don't emit metrics about eslint rules that are above of this threshold. (Default: `10`)
+
+
+## Npm
+
+Collect multiple metrics from the a NodeJS.
+
+**Requirements / Setup**:
+
+You need a `package.json` file present in the current folder.
+
+## Packwerk
+
+Collect multiple metrics from the a Ruby project with [Packwerk](https://github.com/Shopify/packwerk) configured.
+
+**Requirements / Setup**:
+
+You need a `deprecated_references.yml` files present in the current project.
+
+## Rubocop
+
+Collect multiple metrics from the a Ruby project with [Rubocop](https://github.com/rubocop/rubocop) configured.
+
+**Requirements / Setup**:
+
+You need a `.rubocop.yml` and a `rubocop.output.json` file present in the current folder.
+
+You can generate the `rubocop.output.json` file with this example command:
+
+```
+bundle exec srb tc --metrics-prefix 'codemetrics' --metrics-file sorbet.output.json
+```
+
+**Options**:
+
+`CODEMONITOR_RUBOCOP_THRESHOLD`: Don't emit metrics about rubocop cops that are above of this threshold. (Default: `50`)
+
+
+## Semgrep
+
+Collect multiple metrics from the a with [Semgrep](https://semgrep.dev/) configured.
+
+**Requirements / Setup**:
+
+You need a `.semgrep.yml` and a `semgrep.output.json` file present in the current folder.
+
+You can generate the `semgrep.output.json` file with this example command:
+
+```
+semgrep --json -o semgrep.output.json
+```
+
+**Options**:
+
+`CODEMONITOR_SEMGREP_THRESHOLD`: Don't emit metrics about rubocop cops that are above of this threshold. (Default: `50`)
+
+## Sorbet
+
+Collect multiple metrics from the a with [Sorbet](https://sorbet.org/) configured.
+
+**Requirements / Setup**:
+
+You need a `sorbet.output.json` file present in the current folder.
+
+You can generate the `sorbet.output.json` file with this example command:
+
+```
+bundle exec srb tc --metrics-prefix 'codemetrics' --metrics-file sorbet.output.json
+```
+
+# Providers
+
+## Console
+
+TODO
+
+## Datadog
+
+TODO
+
+# Contribute
+
+This project started as a side project, so I'm sure that is full
+of mistakes and areas to be improve. If you think you can tweak the code to
+make it better, I'll really appreciate a pull request. ;)

data/engines/custom/extractor.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Engines
+  module Custom
+    class Extractor
+      def call(provider)
+        return unless requirements?
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        custom_files.length.positive?
+      end
+
+      def custom_files
+        Dir.glob('./.codemonitor/*.rb')
+      end
+
+      def metrics
+        custom_files.map do |file|
+          values = begin
+            eval File.read(file)
+          rescue SyntaxError => e
+            raise "Unable to execute the custom codemonitor script `#{file}` file"
+          end
+
+          raise "Malformed return value from `#{file}` file. It must be a hash of metrics" unless values.is_a?(Hash)
+
+          values
+        end.reduce({}, :merge)
+      end
+    end
+  end
+end

data/engines/debug/extractor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Engines
+  module Debug
+    class Extractor
+      METRICS = %i[
+        debug_random
+      ].freeze
+
+      def call(provider)
+        return unless requirements?
+
+        metrics = METRICS.map do |metric|
+          [metric, send(metric) || 0]
+        end.to_h
+
+        provider.emit(metrics)
+      end
+
+      private
+
+      def requirements?
+        true
+      end
+
+      def debug_random
+        rand(0..100)
+      end
+    end
+  end
+end

data/engines/git/extractor.rb

@@ -15,6 +15,10 @@ module Engines
         git_number_of_lines
       ].freeze
 
+      def initialize
+        @threshold = ENV.fetch('CODEMONITOR_GIT_FILES_THRESHOLD', '0').to_i
+      end
+
       def call(provider)
         return unless requirements?
 
@@ -30,6 +34,8 @@ module Engines
 
       private
 
+      attr_reader :threshold
+
       def requirements?
         File.exist?('.git')
       end
@@ -84,8 +90,10 @@ module Engines
           .map do |file|
             File.extname(file.strip)
           end.each_with_object(Hash.new(0)) do |type, total|
-            total["git_file_extensions_#{type.gsub('.', '')}"] += 1
-          end
+            total[type.gsub('.', '')] += 1
+          end.map do |key, value|
+            ["git_file_extensions_#{key}", value] if value >= threshold
+          end.compact.to_h
       end
     end
   end

data/exe/codemonitor

@@ -5,12 +5,14 @@ require_relative '../providers/console'
 require_relative '../providers/datadog'
 
 require_relative '../engines/eslint/extractor'
+require_relative '../engines/debug/extractor'
 require_relative '../engines/git/extractor'
 require_relative '../engines/npm/extractor'
 require_relative '../engines/packwerk/extractor'
 require_relative '../engines/rubocop/extractor'
 require_relative '../engines/semgrep/extractor'
 require_relative '../engines/sorbet/extractor'
+require_relative '../engines/custom/extractor'
 
 PROVIDERS = {
   console: Providers::Console,
@@ -19,12 +21,14 @@ PROVIDERS = {
 
 EXTRACTORS = {
   eslint: Engines::Eslint::Extractor,
+  debug: Engines::Debug::Extractor,
   git: Engines::Git::Extractor,
   npm: Engines::Npm::Extractor,
   packwerk: Engines::Packwerk::Extractor,
   rubocop: Engines::Rubocop::Extractor,
   semgrep: Engines::Semgrep::Extractor,
-  sorbet: Engines::Sorbet::Extractor
+  sorbet: Engines::Sorbet::Extractor,
+  custom: Engines::Custom::Extractor
 }.freeze
 
 config_provider = ENV['CODEMONITOR_PROVIDER'] || 'console'

data/lib/codemonitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodeMonitor
-  VERSION = '0.3.0'
+  VERSION = '0.3.4'
 end

data/providers/datadog.rb

@@ -17,7 +17,7 @@ module Providers
     def send
       datadog_client.batch_metrics do
         pending.each do |metric, value|
-          metric = metric_prefix + metric
+          metric = "#{metric_prefix}#{metric}"
           puts "#{metric}: #{value}"
           datadog_client.emit_point(metric, value, type: 'gauge')
         end
@@ -26,6 +26,6 @@ module Providers
 
     private
 
-    attr_reader :pending, :datadog_client
+    attr_reader :pending, :metric_prefix, :datadog_client
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codemonitor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Ferran Basora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi
@@ -115,6 +115,8 @@ files:
 - bin/console
 - bin/setup
 - codemonitor.gemspec
+- engines/custom/extractor.rb
+- engines/debug/extractor.rb
 - engines/eslint/extractor.rb
 - engines/git/extractor.rb
 - engines/npm/extractor.rb