gitlab-exporter 9.1.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f135f6746fff19e960b1ec4c46226541cf5522b36d8f12618bdd1a8dad2998
-  data.tar.gz: 3dfb6dd9751dab33bd5eba3994f380d22dd1a25cc00a4d5b8071aa97e4e5d894
+  metadata.gz: 0f7115d7a7e8604d15ad7734afd3280c22edf9f6911af159f9386f2a9d495701
+  data.tar.gz: 7b050b23851b8073da229a5347b0c22afd641a1420859f37f0a0b8a7a4113244
 SHA512:
-  metadata.gz: 58fde6e70e4f5f1c10ec821866390867317a3d337aacb51ced2a8f0ab28b01c614909fa6abdec7063b73f4b9a23f6da49928a876a161baf715e165dc30607b2a
-  data.tar.gz: 8f420a0fb33a6d109a0645bcd1d178d13a57e8d049c52c65e168eaeeeb680a42e491df01e8a4f92fc6460f3f3272638af91a4a25f04cd86e4e24a899da300d2a
+  metadata.gz: 848007d860313f8d62239b3f97a9024944aec9ddbfe6ea97472eaae64ddfc6e03cc056fe9466ce719209a6fad2b5a88947ff085f25ed6cf4ecf6421c1db576d7
+  data.tar.gz: f751e8af1eea6d30eb00dae65ec41681b50e9481a392b6521fde15c07934d8550dd2c3e3b65ea13ae6cbc0adadfe30986bad418c88172699b3172d20f9f62a75

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (9.1.0)
+    gitlab-exporter (10.0.0)
       connection_pool (~> 2.2.1)
       pg (~> 1.1)
+      puma (~> 5.1.1)
       quantile (~> 0.2.0)
       redis (~> 4.1.2)
       redis-namespace (~> 1.6.0)
@@ -18,10 +19,13 @@ GEM
     diff-lcs (1.3)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.4)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
     pg (1.2.3)
+    puma (5.1.1)
+      nio4r (~> 2.0)
     quantile (0.2.1)
     rack (2.2.3)
     rack-protection (2.0.8.1)
@@ -57,7 +61,7 @@ GEM
     rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.4)
     sidekiq (5.2.9)
       connection_pool (~> 2.2, >= 2.2.2)
       rack (~> 2.0)

data/bin/gitlab-exporter

@@ -2,6 +2,8 @@
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
+require "rubygems"
+require "bundler/setup"
 require "optparse"
 require "gitlab_exporter"
 

data/config/gitlab-exporter.yml.example

@@ -95,12 +95,21 @@ probes:
       redis_url: "redis://localhost:6379"
       redis_enable_client: true
 
+  ruby: &ruby
+    class_name: RubyProber
+    methods:
+    - probe_gc
+    opts:
+      quantiles: false
+
   metrics:
     multiple: true
     git_process:
       <<: *git_process
     process:
       <<: *process
+    ruby:
+      <<: *ruby
     sidekiq:
       <<: *sidekiq
     ci_builds:

data/gitlab-exporter.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency "connection_pool", "~> 2.2.1"
   s.add_runtime_dependency "pg", "~> 1.1"
+  s.add_runtime_dependency "puma", "~> 5.1.1"
   s.add_runtime_dependency "quantile", "~> 0.2.0"
   s.add_runtime_dependency "redis", "~> 4.1.2"
   s.add_runtime_dependency "redis-namespace", "~> 1.6.0"

data/lib/gitlab_exporter.rb

@@ -14,5 +14,6 @@ module GitLab
     autoload :WebExporter,       "gitlab_exporter/web_exporter"
     autoload :Prober,            "gitlab_exporter/prober"
     autoload :SidekiqProber,     "gitlab_exporter/sidekiq"
+    autoload :RubyProber,        "gitlab_exporter/ruby"
   end
 end

data/lib/gitlab_exporter/database/base.rb

@@ -8,14 +8,39 @@ module GitLab
       #
       # It takes a connection string (e.g. "dbname=test port=5432")
       class Base
+        POOL_SIZE = 3
+
+        # This timeout is configured to higher interval than scrapping
+        # of Prometheus to ensure that connection is kept instead of
+        # needed to be re-initialized
+        POOL_TIMEOUT = 90
+
         def self.connection_pool
-          @connection_pool ||= Hash.new do |h, connection_string|
-            h[connection_string] = ConnectionPool.new(size: 3, timeout: 5) do
-              PG.connect(connection_string)
+          @@connection_pool ||= Hash.new do |h, connection_string| # rubocop:disable Style/ClassVars
+            h[connection_string] = ConnectionPool.new(size: POOL_SIZE, timeout: POOL_TIMEOUT) do
+              PG.connect(connection_string).tap do |conn|
+                configure_type_map_for_results(conn)
+              end
             end
           end
         end
 
+        def self.configure_type_map_for_results(conn)
+          tm = PG::BasicTypeMapForResults.new(conn)
+
+          # Remove warning message:
+          # Warning: no type cast defined for type "name" with oid 19.
+          # Please cast this type explicitly to TEXT to be safe for future changes.
+          # Warning: no type cast defined for type "regproc" with oid 24.
+          # Please cast this type explicitly to TEXT to be safe for future changes.
+          [{ "type": "text", "oid": 19 }, { "type": "int4", "oid": 24 }].each do |value|
+            old_coder = tm.coders.find { |c| c.name == value[:type] }
+            tm.add_coder(old_coder.dup.tap { |c| c.oid = value[:oid] })
+          end
+
+          conn.type_map_for_results = tm
+        end
+
         def initialize(args, logger: nil)
           @connection_string = args[:connection_string]
           @logger = logger

data/lib/gitlab_exporter/database/row_count.rb

@@ -175,30 +175,12 @@ module GitLab
 
         def execute(query)
           with_connection_pool do |conn|
-            conn.exec(query).map_types!(type_map_for_results(conn))
+            conn.exec(query)
           end
         rescue PG::UndefinedTable, PG::UndefinedColumn
           nil
         end
 
-        def type_map_for_results(conn)
-          @type_map_for_results ||= begin
-            tm = PG::BasicTypeMapForResults.new(conn)
-
-            # Remove warning message:
-            # Warning: no type cast defined for type "name" with oid 19.
-            # Please cast this type explicitly to TEXT to be safe for future changes.
-            # Warning: no type cast defined for type "regproc" with oid 24.
-            # Please cast this type explicitly to TEXT to be safe for future changes.
-            [{ "type": "text", "oid": 19 }, { "type": "int4", "oid": 24 }].each do |value|
-              old_coder = tm.coders.find { |c| c.name == value[:type] }
-              tm.add_coder(old_coder.dup.tap { |c| c.oid = value[:oid] })
-            end
-
-            tm
-          end
-        end
-
         # Not private so I can test it without meta programming tricks
         def construct_query(query)
           query_string = "SELECT COUNT(*)"

data/lib/gitlab_exporter/git.rb

@@ -93,6 +93,10 @@ module GitLab
       end
 
       def probe_git # rubocop:disable Metrics/MethodLength
+        puts "[DEPRECATED] probe_git and GitProcessProber are now considered obsolete"\
+          " and will be removed in future major versions,"\
+          " please use git metrics produced by Gitaly instead"
+
         counts = Hash.new(0)
 
         Utils.pgrep("^git ").each do |pid|

data/lib/gitlab_exporter/process.rb

@@ -71,6 +71,10 @@ module GitLab
       end
 
       def probe_stat
+        puts "[DEPRECATED] probe_stat and ProcessProber are now considered obsolete"\
+          " and will be removed in future major versions,"\
+          " please use metrics produced by application processes instead"
+
         @pids.each do |pid|
           stats = ProcessStats.new(pid)
           next unless stats.valid?
@@ -88,12 +92,20 @@ module GitLab
       end
 
       def probe_count
+        puts "[DEPRECATED] probe_count and ProcessProber are now considered obsolete"\
+          " and will be removed in future major versions,"\
+          " please use metrics produced by application processes instead"
+
         @metrics.add("process_count", @pids.count, name: @name.downcase)
 
         self
       end
 
       def probe_smaps
+        puts "[DEPRECATED] probe_smaps and ProcessProber are now considered obsolete"\
+          " and will be removed in future major versions,"\
+          " please use metrics produced by application processes instead"
+
         @pids.each do |pid|
           stats = ::GitLab::Exporter::MemStats::Aggregator.new(pid)
 

data/lib/gitlab_exporter/ruby.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GitLab
+  module Exporter
+    # Probes a current process GC for info then writes metrics to a target
+    class RubyProber
+      def initialize(options, metrics: PrometheusMetrics.new, logger: nil) # rubocop:disable Lint/UnusedMethodArgument
+        @metrics = metrics
+        @use_quantiles = options.fetch(:quantiles, false)
+      end
+
+      def probe_gc
+        GC.stat.each do |stat, value|
+          @metrics.add("ruby_gc_stat_#{stat}", value.to_i, @use_quantiles)
+        end
+
+        self
+      end
+    end
+  end
+end

data/lib/gitlab_exporter/sidekiq.rb

@@ -10,100 +10,109 @@ module GitLab
       QUEUE_JOB_STATS_SCRIPT = File.read(File.expand_path("#{__FILE__}/../sidekiq_queue_job_stats.lua")).freeze
       QUEUE_JOB_STATS_SHA    = Digest::SHA1.hexdigest(QUEUE_JOB_STATS_SCRIPT).freeze
 
+      POOL_SIZE = 3
+
+      # This timeout is configured to higher interval than scrapping
+      # of Prometheus to ensure that connection is kept instead of
+      # needed to be re-initialized
+      POOL_TIMEOUT = 90
+
+      def self.connection_pool
+        @@connection_pool ||= Hash.new do |h, connection_hash| # rubocop:disable Style/ClassVars
+          config = connection_hash.merge(pool_timeout: POOL_TIMEOUT, size: POOL_SIZE)
+
+          h[connection_hash] = Sidekiq::RedisConnection.create(config)
+        end
+      end
+
       def initialize(opts, metrics: PrometheusMetrics.new, logger: nil)
         @opts    = opts
         @metrics = metrics
         @logger  = logger
-
-        Sidekiq.configure_client do |config|
-          config.redis = redis_options
-        end
-
-        ensure_queue_job_stats_script_loaded
       end
 
       def probe_stats
-        return self unless connected?
-
-        stats = Sidekiq::Stats.new
-
-        @metrics.add("sidekiq_jobs_processed_total", stats.processed)
-        @metrics.add("sidekiq_jobs_failed_total", stats.failed)
-        @metrics.add("sidekiq_jobs_enqueued_size", stats.enqueued)
-        @metrics.add("sidekiq_jobs_scheduled_size", stats.scheduled_size)
-        @metrics.add("sidekiq_jobs_retry_size", stats.retry_size)
-        @metrics.add("sidekiq_jobs_dead_size", stats.dead_size)
-
-        @metrics.add("sidekiq_default_queue_latency_seconds", stats.default_queue_latency)
-        @metrics.add("sidekiq_processes_size", stats.processes_size)
-        @metrics.add("sidekiq_workers_size", stats.workers_size)
+        with_sidekiq do
+          stats = Sidekiq::Stats.new
+
+          @metrics.add("sidekiq_jobs_processed_total", stats.processed)
+          @metrics.add("sidekiq_jobs_failed_total", stats.failed)
+          @metrics.add("sidekiq_jobs_enqueued_size", stats.enqueued)
+          @metrics.add("sidekiq_jobs_scheduled_size", stats.scheduled_size)
+          @metrics.add("sidekiq_jobs_retry_size", stats.retry_size)
+          @metrics.add("sidekiq_jobs_dead_size", stats.dead_size)
+
+          @metrics.add("sidekiq_default_queue_latency_seconds", stats.default_queue_latency)
+          @metrics.add("sidekiq_processes_size", stats.processes_size)
+          @metrics.add("sidekiq_workers_size", stats.workers_size)
+        end
 
         self
       end
 
       def probe_queues
-        return self unless connected?
-
-        Sidekiq::Queue.all.each do |queue|
-          @metrics.add("sidekiq_queue_size", queue.size, name: queue.name)
-          @metrics.add("sidekiq_queue_latency_seconds", queue.latency, name: queue.name)
-          @metrics.add("sidekiq_queue_paused", queue.paused? ? 1 : 0, name: queue.name)
+        with_sidekiq do
+          Sidekiq::Queue.all.each do |queue|
+            @metrics.add("sidekiq_queue_size", queue.size, name: queue.name)
+            @metrics.add("sidekiq_queue_latency_seconds", queue.latency, name: queue.name)
+            @metrics.add("sidekiq_queue_paused", queue.paused? ? 1 : 0, name: queue.name)
+          end
         end
 
         self
       end
 
       def probe_jobs
-        return self unless connected?
-
-        job_stats = {}
-
-        Sidekiq::Queue.all.each do |queue|
-          Sidekiq.redis do |conn|
-            stats = conn.evalsha(QUEUE_JOB_STATS_SHA, ["queue:#{queue.name}"])
-            job_stats.merge!(stats.to_h)
+        with_sidekiq do
+          job_stats = {}
+
+          Sidekiq::Queue.all.each do |queue|
+            Sidekiq.redis do |conn|
+              stats = conn.evalsha(QUEUE_JOB_STATS_SHA, ["queue:#{queue.name}"])
+              job_stats.merge!(stats.to_h)
+            end
+          rescue Redis::CommandError # Could happen if the script exceeded the maximum run time (5 seconds by default)
+            # FIXME: Should we call SCRIPT KILL?
+            return self
           end
-        rescue Redis::CommandError # Could happen if the script exceeded the maximum run time (5 seconds by default)
-          # FIXME: Should we call SCRIPT KILL?
-          return self
-        end
 
-        job_stats.each do |class_name, count|
-          @metrics.add("sidekiq_enqueued_jobs", count, name: class_name)
+          job_stats.each do |class_name, count|
+            @metrics.add("sidekiq_enqueued_jobs", count, name: class_name)
+          end
         end
 
         self
       end
 
       def probe_workers
-        return self unless connected?
-
-        worker_stats = Hash.new(0)
+        with_sidekiq do
+          worker_stats = Hash.new(0)
 
-        Sidekiq::Workers.new.map do |_pid, _tid, work|
-          job_klass = work["payload"]["class"]
+          Sidekiq::Workers.new.map do |_pid, _tid, work|
+            job_klass = work["payload"]["class"]
 
-          worker_stats[job_klass] += 1
-        end
+            worker_stats[job_klass] += 1
+          end
 
-        worker_stats.each do |class_name, count|
-          @metrics.add("sidekiq_running_jobs", count, name: class_name)
+          worker_stats.each do |class_name, count|
+            @metrics.add("sidekiq_running_jobs", count, name: class_name)
+          end
         end
 
         self
       end
 
       def probe_retries
-        return self unless connected?
+        with_sidekiq do
+          retry_stats = Hash.new(0)
 
-        retry_stats = Hash.new(0)
-
-        Sidekiq::RetrySet.new.map do |job|
-          retry_stats[job.klass] += 1
-        end
+          Sidekiq::RetrySet.new.map do |job|
+            retry_stats[job.klass] += 1
+          end
 
-        retry_stats.each do |class_name, count|
-          @metrics.add("sidekiq_to_be_retried_jobs", count, name: class_name)
+          retry_stats.each do |class_name, count|
+            @metrics.add("sidekiq_to_be_retried_jobs", count, name: class_name)
+          end
         end
 
         self
@@ -113,9 +122,9 @@ module GitLab
         puts "[DEPRECATED] probe_dead is now considered obsolete and will be removed in future major versions,"\
              " please use probe_stats instead"
 
-        return self unless connected?
-
-        @metrics.add("sidekiq_dead_jobs", Sidekiq::Stats.new.dead_size)
+        with_sidekiq do
+          @metrics.add("sidekiq_dead_jobs", Sidekiq::Stats.new.dead_size)
+        end
 
         self
       end
@@ -126,6 +135,19 @@ module GitLab
 
       private
 
+      def with_sidekiq
+        # TODO: this is not concurrent safe as we change global context
+        # It means that we are unable to use many different sidekiq's
+        # which is not a problem as of now
+        Sidekiq.configure_client do |config|
+          config.redis = self.class.connection_pool[redis_options]
+        end
+
+        return unless connected?
+
+        yield
+      end
+
       def redis_options
         options = {
           url: @opts[:redis_url],
@@ -145,26 +167,19 @@ module GitLab
       end
 
       def connected?
-        @connected ||= begin
-                         Sidekiq.redis do |conn|
-                           conn.get("foo")
-                         end
-                         true
-                       end
-      rescue Redis::CannotConnectError, Redis::TimeoutError
-        # Maybe we're trying connecting to a slave
-      end
-
-      def ensure_queue_job_stats_script_loaded
-        return unless connected?
+        return @connected unless @connected.nil?
 
+        # This is also a good "connected check"
         Sidekiq.redis do |conn|
           # Using administrative commands on conn directly (which is a Redis::Namespace)
           # will be removed in redis-namespace 2.0.
-          next if conn.redis.script(:exists, QUEUE_JOB_STATS_SHA)
-
-          conn.redis.script(:load, QUEUE_JOB_STATS_SCRIPT)
+          conn.redis.script(:load, QUEUE_JOB_STATS_SCRIPT) unless conn.redis.script(:exists, QUEUE_JOB_STATS_SHA)
         end
+
+        @connected = true
+      rescue Redis::BaseConnectionError => e
+        @logger&.error "Error connecting to the Redis: #{e}"
+        @connected = false
       end
     end
   end

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "9.1.0".freeze
+    VERSION = "10.0.0".freeze
   end
 end

data/spec/ruby_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+require "gitlab_exporter/ruby"
+require "gitlab_exporter/prober"
+
+describe GitLab::Exporter::RubyProber do
+  let(:prober) { GitLab::Exporter::Prober.new(options) }
+
+  let(:options) do
+    {
+      ruby: {
+        class_name: described_class.to_s,
+        methods: %w[probe_gc],
+        opts: { quantiles: false }
+      }
+    }
+  end
+
+  it "probes and returns GC stats" do
+    prober.probe_all
+
+    output = StringIO.new
+    prober.write_to(output)
+    expect(output.string).to match(/ruby_gc_stat_count \d+ \d+/)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Pablo Carranza
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
 - !ruby/object:Gem::Dependency
   name: quantile
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +187,7 @@ files:
 - lib/gitlab_exporter/prober.rb
 - lib/gitlab_exporter/process.rb
 - lib/gitlab_exporter/prometheus.rb
+- lib/gitlab_exporter/ruby.rb
 - lib/gitlab_exporter/sidekiq.rb
 - lib/gitlab_exporter/sidekiq_queue_job_stats.lua
 - lib/gitlab_exporter/util.rb
@@ -187,6 +202,7 @@ files:
 - spec/git_spec.rb
 - spec/memstats_spec.rb
 - spec/prometheus_metrics_spec.rb
+- spec/ruby_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
 homepage: http://gitlab.com
@@ -222,5 +238,6 @@ test_files:
 - spec/git_spec.rb
 - spec/memstats_spec.rb
 - spec/prometheus_metrics_spec.rb
+- spec/ruby_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb