gitlab-exporter 14.5.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08d5fac10fb60048757b6f0ad48ac3672d34d64d01e096eac72b1e1d2e859ed2'
-  data.tar.gz: f33f247f22c6d9f1022d33e8d22b01ced782eea825cd22529cabcbe54e9f08f0
+  metadata.gz: aa3c6ff71709207bbbe1c85dea19eab223c678c721baf437eed2275ad73816b9
+  data.tar.gz: f263b55d0e45ece0a7d3124511c684eacbe78532eae81e2f4c11f3ec4279af9b
 SHA512:
-  metadata.gz: 155b43cb6cb074afd58462dc0c2f2e6bdef31310d3e8e8a9781340b1e07aab321ef2d5f5d5f9a95cd69e710aadb21d32cc7d6a5901d171c92f68259d95124f54
-  data.tar.gz: 237c25cfe1df48c137ba7f6a513e566f0f4bb0305f43c99e4a94014dc961a2f6deebd923b4adbfcedd8d0cd9ae893841013c290bbb7d127bd61765ecf3452d93
+  metadata.gz: 8db3f5dd5db87f02d7a85fb58c13e8a48df40726c5718fd82d5b7ae792675948bd43664da3f94075527e5242c0dcf8bc5e150f8606611097677a812981d73354
+  data.tar.gz: 9411698d4c809eba8997bd8fc0f9cc4295dac625daa35a8faf37604909a20fde621afb161534bd82fa912087cf50de45e5e192186627cb95f5c8b5643de1742e

data/.gitlab-ci.yml

@@ -50,9 +50,32 @@ rspec_integration:
     - bundle exec rspec spec -t integration -f d -c
   before_script: *before_scripts
   services:
-    - redis:latest
+    - name: redis:${REDIS_VERSION}
+      alias: redis-master
+    - name: bitnami/redis-sentinel:${REDIS_SENTINEL_VERSION}
+      alias: redis-sentinel
+      command:
+        - /bin/sh
+        - -c
+        - |
+          echo "Starting Redis Sentinel..."
+          cat <<EOF > /opt/bitnami/redis-sentinel/etc/sentinel.conf
+          user default off
+          user ${REDIS_SENTINEL_USERNAME} on >${REDIS_SENTINEL_PASSWORD} +@all
+          sentinel monitor mymaster redis-master 6379 2
+          sentinel resolve-hostnames yes
+          sentinel down-after-milliseconds mymaster 5000
+          EOF
+          redis-sentinel /opt/bitnami/redis-sentinel/etc/sentinel.conf
+
   variables:
     REDIS_URL: "redis://redis"
+    REDIS_SENTINEL_URL: "redis://mymaster"
+    REDIS_SENTINELS: "redis-sentinel:26379"
+    REDIS_VERSION: latest
+    REDIS_SENTINEL_VERSION: latest
+    REDIS_SENTINEL_USERNAME: "my-sentinel-username"
+    REDIS_SENTINEL_PASSWORD: "my-sentinel-password"
   parallel:
     matrix:
       - RUBY_VERSION: ["2.7", "3.0", "3.1", "3.2"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (14.5.0)
+    gitlab-exporter (15.0.0)
       connection_pool (= 2.2.5)
       deep_merge (~> 1.2.2)
       faraday (>= 1.8.0, <= 2.8.1)

data/config/gitlab-exporter.yml.example

@@ -98,6 +98,14 @@ probes:
       # redis_username: 'redis-username'
       # redis_password: 'redis-password'
       redis_enable_client: true
+      # Uncomment if Redis Sentinels are needed
+      # redis_sentinels:
+      #   - host: 'localhost'
+      #     port: 26380
+      #   - host: 'localhost'
+      #     port: 26381
+      # redis_sentinel_username: 'redis-sentinel-username'
+      # redis_sentinel_password: 'redis-sentinel-password'
 
   ruby: &ruby
     class_name: RubyProber

data/lib/gitlab_exporter/cli.rb

@@ -297,12 +297,24 @@ module GitLab
           @target = File.open(@target, "a") if @target.is_a?(String)
         end
 
-        def options(args)
+        def options(args) # rubocop:disable Metrics/MethodLength
           args.options do |opts|
             opts.banner = "Usage: #{EXECUTABLE_NAME} #{COMMAND_NAME} [options]"
             opts.on("--redis-url=\"redis://localhost:6379\"", "Redis URL") do |val|
               @redis_url = val
             end
+            opts.on("--redis-sentinel-username=\"my-sentinel-username\"", "Redis Sentinel username") do |val|
+              @redis_sentinel_username = val
+            end
+            opts.on("--redis-sentinel-password=\"my-sentinel-password\"", "Redis Sentinel password") do |val|
+              @redis_sentinel_password = val
+            end
+            opts.on("--redis-sentinels=HOST1:PORT1,HOST2:PORT2", Array, "List of Redis Sentinels") do |val|
+              @redis_sentinels = val.map { |item|
+                host, port = item.split(":")
+                { host: host, port: port.to_i }
+              }
+            end
           end
         end
 
@@ -313,13 +325,19 @@ module GitLab
         def run
           validate!
 
-          ::GitLab::Exporter::SidekiqProber.new(redis_url: @redis_url)
-                                           .probe_stats
-                                           .probe_queues
-                                           .probe_jobs_limit
-                                           .probe_workers
-                                           .probe_retries
-                                           .write_to(@target)
+          prober = ::GitLab::Exporter::SidekiqProber.new(redis_url: @redis_url,
+                                                         redis_sentinels: @redis_sentinels,
+                                                         redis_sentinel_username: @redis_sentinel_username,
+                                                         redis_sentinel_password: @redis_sentinel_password,
+                                                         logger: Logger.new(STDERR))
+
+          prober
+            .probe_stats
+            .probe_queues
+            .probe_jobs_limit
+            .probe_workers
+            .probe_retries
+            .write_to(@target)
         end
 
         private

data/lib/gitlab_exporter/database/base.rb

@@ -62,6 +62,10 @@ module GitLab
             conn.reset
             raise e
           end
+        rescue PG::ConnectionBad => e
+          @logger.error "Bad connection to the database, resetting pool: #{e}" if @logger
+          connection_pool.reload(&:close)
+          raise e
         rescue PG::Error => e
           @logger.error "Error connecting to the database: #{e}" if @logger
           raise e

data/lib/gitlab_exporter/sidekiq.rb

@@ -7,7 +7,7 @@ module GitLab
     # A prober for Sidekiq queues
     #
     # It takes the Redis URL Sidekiq is connected to
-    class SidekiqProber
+    class SidekiqProber # rubocop:disable Metrics/ClassLength
       # The maximum depth (from the head) of each queue to probe. Probing the
       # entirety of a very large queue will take longer and run the risk of
       # timing out. But when we have a very large queue, we are most in need of
@@ -195,6 +195,7 @@ module GitLab
       def redis_options
         options = {
           url: @opts[:redis_url],
+          sentinels: redis_sentinel_options,
           connect_timeout: 1,
           reconnect_attempts: 0
         }
@@ -207,6 +208,19 @@ module GitLab
         options
       end
 
+      def redis_sentinel_options
+        sentinels = @opts[:redis_sentinels]
+
+        return sentinels unless sentinels.is_a?(Array)
+
+        sentinels.each do |sentinel_config|
+          sentinel_config[:username] = @opts[:redis_sentinel_username] if @opts.key?(:redis_sentinel_username)
+          sentinel_config[:password] = @opts[:redis_sentinel_password] if @opts.key?(:redis_sentinel_password)
+        end
+
+        sentinels
+      end
+
       def redis_enable_client?
         return true if @opts[:redis_enable_client].nil?
 
@@ -221,6 +235,8 @@ module GitLab
         end
       rescue Redis::BaseConnectionError => e
         @logger&.error "Error connecting to the Redis: #{e}"
+        pool = self.class.connection_pool[redis_options]
+        pool.reload(&:close)
         @connected = false
       end
     end

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "14.5.0".freeze
+    VERSION = "15.0.0".freeze
   end
 end

data/spec/database/ci_builds_spec.rb

@@ -290,6 +290,22 @@ describe GitLab::Exporter::Database do
           expect(output).to match(/^ci_stale_builds 0.0$/m)
         end
       end
+
+      context "when PG connection shuts down" do
+        before do
+          allow(connection).to receive(:exec).and_raise(PG::ConnectionBad)
+        end
+
+        it "responds with Prometheus metrics" do
+          expect(connection_pool).to receive(:reload)
+
+          prober.probe_db
+          prober.write_to(writer)
+          output = writer.string
+
+          expect(output).to be_empty
+        end
+      end
     end
 
     context "when executed on EE" do

data/spec/integration/cli_spec.rb

@@ -6,6 +6,13 @@ module GitLab
     module CLI
       describe SidekiqRunner, :integration do
         let(:redis_url) { ENV.fetch("REDIS_URL", "redis://localhost:6379") }
+        let(:redis_sentinel_url) { ENV.fetch("REDIS_SENTINEL_URL", "redis://mymaster:6379") }
+        let(:redis_sentinel_username) { ENV.fetch("REDIS_SENTINEL_USERNAME", "my-sentinel-user") }
+        let(:redis_sentinel_password) { ENV.fetch("REDIS_SENTINEL_PASSWORD", "my-sentinel-password") }
+        let(:redis_sentinels) do
+          sentinels = ENV.fetch("REDIS_SENTINELS", "localhost:26379")
+          sentinels.split(" ")
+        end
         let(:io) { StringIO.new }
 
         it "can properly reach out to redis" do
@@ -14,6 +21,16 @@ module GitLab
 
           expect { runner.run }.not_to raise_error
         end
+
+        it "can properly reach out to redis-sentinel" do
+          args = CLIArgs.new([io], options: { /^--redis-url/ => redis_sentinel_url,
+                                              /^--redis-sentinel-username/ => redis_sentinel_username,
+                                              /^--redis-sentinel-password/ => redis_sentinel_password,
+                                              /^--redis-sentinels/ => redis_sentinels })
+          runner = SidekiqRunner.new(args)
+
+          expect { runner.run }.not_to raise_error
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 14.5.0
+  version: 15.0.0
 platform: ruby
 authors:
 - Pablo Carranza