gitlab-exporter 14.0.0 → 14.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6420230ed0ec27d530fa71e46c0776ea2cb21b036a198335229fc304dcdfe3e0
-  data.tar.gz: 91205ee62a32b2e00f7978f9fc7ec063be203d593cade97ea481f85ee1388bbd
+  metadata.gz: dd25ebf8533fde9c59b0db768540fcbdf338c961715617459c2a4aa2eb2cc912
+  data.tar.gz: 12e190d1ea1f1cf0a16aa68ab54995c4953555807c7e3c80ecf8a40072d811dd
 SHA512:
-  metadata.gz: 3be9966a1abe20b42169a4a85e20815649c87e46a31f853002dd5fb0eaff6437a692f5904334d42172fb1950627b0d3bba31a67c6992e5533051f367ed74144f
-  data.tar.gz: 20aefc5c04ee63033feeb80e986e6f239a711d9d88197859c154fe4e429573344d52d5c58ca9d9e611dace90804da5fba8341ed45ed5f592e33a5df8c3c6cc7e
+  metadata.gz: f482931b5c30361f7d9e2899c47de30e4fe296b02028818c83bf189defcd8e0dd6fa30f411c1a96e2abab809c1d45ea4c679479b61ac093c09d678154a8b6ce5
+  data.tar.gz: 5942a5b4b0ea8ecdccdab0de8a5bfdad2f7b1f125e200bfc94e64cf4328ca750cf866ccd394dbe14dfc91fe3dcc5915332e5519c9f9d37682f49251ac2a7b581

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (14.0.0)
+    gitlab-exporter (14.1.0)
       connection_pool (= 2.2.5)
+      deep_merge (~> 1.2.2)
       faraday (~> 1.8.0)
       pg (= 1.5.3)
       puma (= 5.6.5)
@@ -18,6 +19,7 @@ GEM
   specs:
     ast (2.4.1)
     connection_pool (2.2.5)
+    deep_merge (1.2.2)
     diff-lcs (1.5.0)
     faraday (1.8.0)
       faraday-em_http (~> 1.0)

data/README.md

@@ -95,6 +95,25 @@ Once running, you can point your browser or curl to the following URLs:
 * http://localhost:9168/sidekiq
 * http://localhost:9168/metrics (to get all of the above combined)
 
+If it is undesirable to have secrets (e.g. Redis password or PostgreSQL credentials) in the config file,
+then you can specify an external command (with the `--extra-config-command <command>` flag) that outputs
+such credentials in a YAML form (same structure as the config file) and it will be merged with the file configuration.
+
+For example:
+
+```
+$ vault kv get -format=yaml secrets/gitlab/gitlab-exporter
+probes:
+  sidekiq:
+    opts:
+      redis_url: redis://hunter1@localhost:9765
+  database:
+    opts:
+      connection_string: postgres://db-admin:hunter1@localhost:6543/main-db
+
+$ bin/gitlab-exporter web -c config/gitlab-exporter.yml --extra-config-command "vault kv get -format=yaml secrets/gitlab/gitlab-exporter"
+```
+
 ### Database Bloat Metrics
 
 Database bloat is measured for indexes (`btree`) and/or tables

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 "deep_merge", "~> 1.2.2"
   s.add_runtime_dependency "faraday", "~> 1.8.0"
   s.add_runtime_dependency "pg", "1.5.3"
   s.add_runtime_dependency "puma", "5.6.5"

data/lib/gitlab_exporter/cli.rb

@@ -1,4 +1,6 @@
 require "yaml"
+require "deep_merge"
+require "English"
 
 # TODO: Remove this once we're on Ruby 3
 # https://gitlab.com/gitlab-org/gitlab/-/issues/393651
@@ -188,6 +190,10 @@ module GitLab
             opts.on("-c config.yml", "Monitoring config") do |val|
               @config_file = val
             end
+            opts.on("--extra-config-command command", "Shell command that returns YAML config to be merged
+                    with the config file") do |val|
+              @extra_config_command = val
+            end
           end
         end
 
@@ -195,12 +201,17 @@ module GitLab
           @options.help
         end
 
+        def merged_config
+          config_from_file = Utils.deep_symbolize_hash_keys(YAML.safe_load_file(@config_file, aliases: true))
+          config_from_command = extra_config_from_command
+
+          config_from_file.deep_merge!(config_from_command)
+        end
+
         def run
           validate!
 
-          config = Utils.deep_symbolize_hash_keys(YAML.safe_load_file(@config_file, aliases: true))
-
-          WebExporter.setup(config)
+          WebExporter.setup(merged_config)
           WebExporter.run!
         end
 
@@ -209,6 +220,22 @@ module GitLab
         def validate!
           fail InvalidCLICommand.new(help) unless @config_file
         end
+
+        def run_extra_config_command
+          puts "Using extra config by running command `#{@extra_config_command}`"
+
+          output = `#{@extra_config_command}`
+          return output if $CHILD_STATUS == 0
+
+          puts "ERROR: command `#{@extra_config_command}` returned a non-zero code."
+          exit(2)
+        end
+
+        def extra_config_from_command
+          return {} unless @extra_config_command
+
+          Utils.deep_symbolize_hash_keys(YAML.safe_load(run_extra_config_command))
+        end
       end
 
       # Process runner

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "14.0.0".freeze
+    VERSION = "14.1.0".freeze
   end
 end

data/spec/cli_spec.rb

@@ -1,5 +1,6 @@
 require "spec_helper"
 require "gitlab_exporter/cli"
+require "optparse"
 
 context "With valid pair of repositories" do
   let(:repos) { GitRepoBuilder.new }
@@ -29,3 +30,49 @@ context "With valid pair of repositories" do
     end
   end
 end
+
+describe GitLab::Exporter::CLI::Server do
+  context "extra-config-command is passed" do
+    let(:argv) do
+      ["-c", "spec/fixtures/config.yml", "--extra-config-command", extra_config_command]
+        .extend(OptionParser::Arguable)
+    end
+    let(:extra_config_command) { "vault kv get top-secrets" }
+    let(:server_cmd) { described_class.new(argv) }
+
+    before do
+      allow(server_cmd).to receive(:run_extra_config_command).and_return(<<~YAML
+        probes:
+          sidekiq:
+            methods:
+              - probe_workers
+            opts:
+              redis_url: redis://hunter1@localhost:9765
+          database:
+            opts:
+              connection_string: postgres://db-admin:hunter1@localhost:6543/main-db
+      YAML
+                                                                        )
+    end
+
+    it "merges the returned YAML from the command with the passed config" do
+      expect(server_cmd.merged_config).to eq({
+                                               probes: {
+                                                 sidekiq: {
+                                                   methods: %w[probe_stats probe_workers],
+                                                   opts: {
+                                                     redis_url: "redis://hunter1@localhost:9765"
+                                                   }
+                                                 },
+                                                 database: {
+                                                   methods: ["probe_db"],
+                                                   opts: {
+                                                     connection_string:
+                                                      "postgres://db-admin:hunter1@localhost:6543/main-db"
+                                                   }
+                                                 }
+                                               }
+                                             })
+    end
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,10 @@
+probes:
+  sidekiq:
+    methods:
+      - probe_stats
+
+  database:
+    methods:
+      - probe_db
+    opts:
+      connection_string: to-be-overridden

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 14.0.0
+  version: 14.1.0
 platform: ruby
 authors:
 - Pablo Carranza
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.2.5
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -229,6 +243,7 @@ files:
 - spec/database/ci_builds_spec.rb
 - spec/database/row_count_spec.rb
 - spec/elasticsearch_spec.rb
+- spec/fixtures/config.yml
 - spec/fixtures/smaps/sample.txt
 - spec/git_process_proper_spec.rb
 - spec/git_spec.rb
@@ -267,6 +282,7 @@ test_files:
 - spec/database/ci_builds_spec.rb
 - spec/database/row_count_spec.rb
 - spec/elasticsearch_spec.rb
+- spec/fixtures/config.yml
 - spec/fixtures/smaps/sample.txt
 - spec/git_process_proper_spec.rb
 - spec/git_spec.rb