gitlab-exporter 11.5.0 → 11.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e350149b9ffdf7a61ddf79b266992fb0acec022e83c30f0dec627d8222569d
-  data.tar.gz: e3d3f1e9f38ab27199b6048fe29cfde62380422f03c5dc681257f5f6c1804044
+  metadata.gz: 69d4dca6d2e5a8ea5a6d746d620f5693286823a035802f0794cd15f51debe680
+  data.tar.gz: 44ea6a07b45a79e82d3d41f49f53378ae4d767c72605674e776293a4ed87cafc
 SHA512:
-  metadata.gz: 4e98d5ac89e78c049235f1419eaebeedd36e109e52e398cbf15d28f4c229a1420753ce2105eba24967de4b2a3d3fb69f3b51912f743f0c5f9b58e95ba3e3719e
-  data.tar.gz: a474f550f66341ee303fbabe0319e4876f42c7ca5220fe2414da06b44b7da02bcad8fac9c0d38eebf51b68a40be1077e5faf4136919e73fb8ce787cec7a2ea30
+  metadata.gz: 6aa85a6e99d14fb186ebea05f2b6067220784639a445d85edc96a3aa4eff4403461b73297b8b5a0de1f1424d249f87f9069e3d994318a3f8735d589dcfc52f53
+  data.tar.gz: 124e02b31dfff3071e50f4c87a488f54fae0386e4c120a5a2d8d420b5af59e1879c4f990d8e9c7a17391d26145a9e6634191c6244ebb355e024b2b1b06756038

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (11.5.0)
+    gitlab-exporter (11.6.0)
       connection_pool (= 2.2.5)
+      faraday (~> 1.8.0)
       pg (= 1.2.3)
       puma (= 5.3.2)
       quantile (= 0.2.1)
@@ -17,6 +18,26 @@ GEM
     ast (2.4.1)
     connection_pool (2.2.5)
     diff-lcs (1.3)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    multipart-post (2.1.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.5.8)

data/README.md

@@ -59,6 +59,8 @@ metrics.
     * `sidekiq_schedule_set_backlog_count`
     * `sidekiq_retry_set_processing_delay_seconds`
     * `sidekiq_retry_set_backlog_count`
+1. [Elasticsearch](lib/gitlab_exporter/elasticsearch.rb)
+  * [Migrations](https://docs.gitlab.com/ee/integration/elasticsearch.html#advanced-search-migrations) -- `elasticsearch_migrations_state`
 
 ### Setup with GitLab Development Kit
 

data/config/gitlab-exporter.yml.example

@@ -99,6 +99,22 @@ probes:
     opts:
       quantiles: false
 
+
+  # Uncomment below to add GitLab specific Elasticsearch metrics.
+  #
+  # To support multiple authorization types, opts are passed to a Faraday connection object.
+  # See: https://www.rubydoc.info/github/lostisland/faraday/Faraday%2FConnection:initialize
+  #
+  # elasticsearch: &elasticsearch
+  #   methods:
+  #     - probe_migrations
+  #
+  #   opts:
+  #     - url: http://localhost:9200
+  #       options:
+  #         headers:
+  #           Authorization: "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
+
   metrics:
     multiple: true
     git_process:

data/gitlab-exporter.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.license       = "MIT"
 
   s.add_runtime_dependency "connection_pool", "2.2.5"
+  s.add_runtime_dependency "faraday", "~> 1.8.0"
   s.add_runtime_dependency "pg", "1.2.3"
   s.add_runtime_dependency "puma", "5.3.2"
   s.add_runtime_dependency "quantile", "0.2.1"

data/lib/gitlab_exporter/elasticsearch.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module GitLab
+  module Exporter
+    # Exports GitLab specific Elasticsearch metrics.
+    #
+    # For generic operational metrics, see elasticsearch_exporter.
+    # https://github.com/prometheus-community/elasticsearch_exporter
+    class ElasticsearchProber
+      MIGRATION_STATE_MAP = {
+        unknown: -9,
+        # TODO: failed: -1
+        pending: 0,
+        running: 1,
+        halted: 2,
+        completed: 3
+      }.freeze
+
+      def initialize(metrics: PrometheusMetrics.new, logger: nil, **opts)
+        @metrics = metrics
+        @logger  = logger
+        @opts    = opts
+      end
+
+      # Probes the state of Advanced Search Migrations
+      # https://docs.gitlab.com/ee/integration/elasticsearch.html#advanced-search-migrations
+      def probe_migrations
+        elastic_probe do |conn|
+          resp = conn.get "/gitlab-*-migrations/_search"
+          return unless resp.status == 200
+
+          JSON.parse(resp.body).dig("hits", "hits").each do |hit|
+            @metrics.add(
+              "elasticsearch_migrations_info", 1, # 1 is a noop.
+              state: inferred_migration_state(hit.fetch("_source")),
+              name: hit.fetch("_id")
+            )
+          end
+        end
+      rescue StandardError => e
+        @logger&.error "ElasticsearchProper encountered an error: #{e}"
+      end
+
+      private
+
+      def elastic_probe
+        yield Faraday.new(@opts.fetch(:url), @opts.fetch(:options, {}))
+      end
+
+      def inferred_migration_state(migration)
+        return :pending if migration["started_at"] == ""
+
+        if migration["started_at"] != "" && migration["completed_at"] == "" && !migration.dig("state", "halted")
+          return :running
+        end
+
+        return :completed if migration["completed"]
+        return :halted if migration.dig("state", "halted")
+
+        @logger&.error("Elasticsearch probe doesn't know the state of a migration")
+        :unknown
+      end
+    end
+  end
+end

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "11.5.0".freeze
+    VERSION = "11.6.0".freeze
   end
 end

data/lib/gitlab_exporter.rb

@@ -1,19 +1,20 @@
 module GitLab
   # GitLab Monitoring
   module Exporter
-    autoload :CLI,               "gitlab_exporter/cli"
-    autoload :TimeTracker,       "gitlab_exporter/util"
-    autoload :Utils,             "gitlab_exporter/util"
-    autoload :PrometheusMetrics, "gitlab_exporter/prometheus"
-    autoload :Utils,             "gitlab_exporter/util"
-    autoload :Git,               "gitlab_exporter/git"
-    autoload :GitProber,         "gitlab_exporter/git"
-    autoload :GitProcessProber,  "gitlab_exporter/git"
-    autoload :Database,          "gitlab_exporter/database"
-    autoload :ProcessProber,     "gitlab_exporter/process"
-    autoload :WebExporter,       "gitlab_exporter/web_exporter"
-    autoload :Prober,            "gitlab_exporter/prober"
-    autoload :SidekiqProber,     "gitlab_exporter/sidekiq"
-    autoload :RubyProber,        "gitlab_exporter/ruby"
+    autoload :CLI,                 "gitlab_exporter/cli"
+    autoload :TimeTracker,         "gitlab_exporter/util"
+    autoload :Utils,               "gitlab_exporter/util"
+    autoload :PrometheusMetrics,   "gitlab_exporter/prometheus"
+    autoload :Utils,               "gitlab_exporter/util"
+    autoload :Git,                 "gitlab_exporter/git"
+    autoload :GitProber,           "gitlab_exporter/git"
+    autoload :GitProcessProber,    "gitlab_exporter/git"
+    autoload :Database,            "gitlab_exporter/database"
+    autoload :ProcessProber,       "gitlab_exporter/process"
+    autoload :WebExporter,         "gitlab_exporter/web_exporter"
+    autoload :Prober,              "gitlab_exporter/prober"
+    autoload :SidekiqProber,       "gitlab_exporter/sidekiq"
+    autoload :RubyProber,          "gitlab_exporter/ruby"
+    autoload :ElasticsearchProber, "gitlab_exporter/elasticsearch"
   end
 end

data/spec/elasticsearch_spec.rb

@@ -0,0 +1,132 @@
+require "spec_helper"
+require "gitlab_exporter/elasticsearch"
+
+describe GitLab::Exporter::ElasticsearchProber do
+  subject(:prober) { GitLab::Exporter::Prober.new(**options) }
+  let(:options) do
+    {
+      elasticsearch: {
+        class_name: described_class.to_s,
+        methods: %i[probe_migrations],
+        opts: {
+          url: "http://elasticsearch"
+        }
+      }
+    }
+  end
+
+  let(:connection) { instance_double(Faraday::Connection) }
+
+  describe "probe_migrations" do
+    let(:response) { double(:response, body: results, status: 200) }
+    let(:metric_name) { "elasticsearch_migrations_info" }
+
+    let(:results) do
+      <<-RESULTS
+      {
+        "took": 5,
+        "timed_out": false,
+        "_shards": {
+          "total": 1,
+          "successful": 1,
+          "skipped": 0,
+          "failed": 0
+        },
+        "hits": {
+          "total": {
+            "value": 1,
+            "relation": "eq"
+          },
+          "max_score": 1,
+          "hits": [#{document.to_json}]
+        }
+      }
+      RESULTS
+    end
+
+    let(:document) do
+      { "_id" => "123", "_source" => migration }
+    end
+
+    let(:migration) do
+      {
+        "started_at" => "",
+        "completed_at" => "",
+        "completed" => false,
+        "state" => {}
+      }.tap do |m|
+        case migration_state
+        when "running"
+          m["started_at"] = "2021-09-23T11:47:48,890Z"
+        when "completed"
+          m["started_at"] = "2021-09-23T11:47:48,890Z"
+          m["completed_at"] = "2021-09-24T11:47:48,890Z"
+          m["completed"] = true
+        when "halted"
+          m["started_at"] = "2021-09-23T11:47:48,890Z"
+          m["state"]["halted"] = true
+        end
+      end
+    end
+
+    let(:output) do
+      prober.probe_all
+      StringIO.new.tap do |s|
+        prober.write_to(s)
+      end
+    end
+
+    before do
+      allow_any_instance_of(described_class).to receive(:elastic_probe).and_yield(connection)
+    end
+
+    describe "when an Exception is raised" do
+      before do
+        allow(connection).to receive(:get).with("/gitlab-*-migrations/_search").and_raise("boom")
+      end
+
+      it "does NOT raise an error" do
+        expect { output }.to_not raise_error
+      end
+
+      it "does NOT export any metrics" do
+        expect(output.string).not_to match(/#{metric_name}/)
+      end
+    end
+
+    describe "when elasticsearch is reachable" do
+      let(:expected_output) { /#{metric_name}{state="#{migration_state}",name="123"} 1 \d+/ }
+      before do
+        allow(connection).to receive(:get).with("/gitlab-*-migrations/_search").and_return response
+      end
+
+      context "when there is a pending migration" do
+        let(:migration_state) { "pending" }
+        it "exports state correctly" do
+          expect(output.string).to match(expected_output)
+        end
+      end
+
+      context "when there is a running migration" do
+        let(:migration_state) { "running" }
+        it "exports state correctly" do
+          expect(output.string).to match(expected_output)
+        end
+      end
+
+      context "when there is a halted migration" do
+        let(:migration_state) { "halted" }
+        it "exports state correctly" do
+          expect(output.string).to match(expected_output)
+        end
+      end
+
+      context "when there is a completed migration" do
+        let(:migration_state) { "completed" }
+        it "exports state correctly" do
+          expect(output.string).to match(expected_output)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 11.5.0
+  version: 11.6.0
 platform: ruby
 authors:
 - Pablo Carranza
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.2.5
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +195,7 @@ files:
 - lib/gitlab_exporter/database/remote_mirrors.rb
 - lib/gitlab_exporter/database/row_count.rb
 - lib/gitlab_exporter/database/tuple_stats.rb
+- lib/gitlab_exporter/elasticsearch.rb
 - lib/gitlab_exporter/git.rb
 - lib/gitlab_exporter/memstats.rb
 - lib/gitlab_exporter/memstats/mapping.rb
@@ -196,6 +211,7 @@ files:
 - spec/database/bloat_spec.rb
 - spec/database/ci_builds_spec.rb
 - spec/database/row_count_spec.rb
+- spec/elasticsearch_spec.rb
 - spec/fixtures/smaps/sample.txt
 - spec/git_process_proper_spec.rb
 - spec/git_spec.rb
@@ -232,6 +248,7 @@ test_files:
 - spec/database/bloat_spec.rb
 - spec/database/ci_builds_spec.rb
 - spec/database/row_count_spec.rb
+- spec/elasticsearch_spec.rb
 - spec/fixtures/smaps/sample.txt
 - spec/git_process_proper_spec.rb
 - spec/git_spec.rb