prometheus_exporter 2.0.6 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a7a452c5d92b7dbaca7f68ae2fa0553b5e280cd0b194f8ad0914d1e372c6b54
-  data.tar.gz: fdb40f93499fbc98cf4b94b2f52864fa1581df70b0dac448e06d8ebbf357f6f5
+  metadata.gz: af71a5656b5fe6a90de6fe6ad1b76efa05ccfb67d4fdb3cdcc740f539097546f
+  data.tar.gz: cd6ef704ecdc7110d5f78dd999354e1ea093adcba51f2355a0211e99e0fb3c67
 SHA512:
-  metadata.gz: 55eb9c1051984906ee30be3cbb2a9d4c3cb0c5f2fe58c9da0178b48187beb940a8314677052cf6b29bb0c2e5d6d364de30b36a32b56eb061065d48feab01e903
-  data.tar.gz: 794b19bab0a66404058ca2d550659d2fbca891e894a5b234db974eefc6b0652475c94d607b0be0b0f84f8d786bebf0a5b6d8721408c7e79ef18f031cd8466446
+  metadata.gz: adf3c09a5609699bd055094bc509e997e320a72833b7c2beca03186d0c3d3fa0fa65fc005708b7faf496a9bf32c68c489cc7a1985525eed7a35ceb6b2d53a9df
+  data.tar.gz: 3975585eb3842c5cf409793d9257a184e33af062d4dd45e5bf64164bbba88c87d14aaea946bed519f9db1034afb8695fbdeecef337286bcaf00132cd2cd7a5f2

data/.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.6', '2.7', '3.0', '3.1']
+        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2']
         activerecord: [60, 61]
 
     steps:

data/.github/workflows/docker.yml

@@ -0,0 +1,47 @@
+name: Docker
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  packages: write
+
+env:
+  DOCKER_REPO: ghcr.io/discourse/prometheus_exporter
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    steps:
+      - name: Set vars
+        id: vars
+        run: |
+          echo "version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+
+      - uses: actions/checkout@v3
+      - uses: docker/setup-qemu-action@v2
+      - uses: docker/setup-buildx-action@v2
+
+      - name: Login to Github Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push images
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          build-args: |
+            GEM_VERSION=${{ steps.vars.outputs.version }}
+          tags: |
+            ${{ env.DOCKER_REPO }}:${{ steps.vars.outputs.version }}
+            ${{ env.DOCKER_REPO }}:latest

data/CHANGELOG

@@ -1,3 +1,13 @@
+2.0.8 - 2023-01-20
+
+- FEATURE: attempting to make our first docker release
+
+2.0.7 - 2023-01-13
+
+- FEATURE: allow binding server to both ipv4 and v6
+- FIX: expire stale sidekiq metrics
+
+
 2.0.6 - 2022-11-22
 
 - FIX: use user specified labels over default in merge conflict

data/Dockerfile

@@ -0,0 +1,9 @@
+ARG RUBY_VERSION=3.1
+ARG GEM_VERSION=
+
+FROM ruby:${RUBY_VERSION}-slim
+
+RUN gem install --no-doc --version=${GEM_VERSION} prometheus_exporter
+
+EXPOSE 9394
+ENTRYPOINT ["prometheus_exporter", "-b", "ANY"]

data/README.md

@@ -32,6 +32,7 @@ To learn more see [Instrumenting Rails with Prometheus](https://samsaffron.com/a
 * [Transport concerns](#transport-concerns)
 * [JSON generation and parsing](#json-generation-and-parsing)
 * [Logging](#logging)
+* [Docker Usage](#docker-usage)
 * [Contributing](#contributing)
 * [License](#license)
 * [Code of Conduct](#code-of-conduct)
@@ -857,6 +858,9 @@ prometheus_exporter -p 8080 \
                     --prefix 'foo_'
 ```
 
+You can use `-b` option to bind the `prometheus_exporter` web server to any IPv4 interface with `-b 0.0.0.0`, 
+any IPv6 interface with `-b ::`, or `-b ANY` to any IPv4/IPv6 interfaces available on your host system.
+
 #### Enabling Basic Authentication
 
 If you desire authentication on your `/metrics` route, you can enable basic authentication with the `--auth` option.
@@ -960,6 +964,28 @@ You can also pass a log level (default is [`Logger::WARN`](https://ruby-doc.org/
 PrometheusExporter::Client.new(log_level: Logger::DEBUG)
 ```
 
+## Docker Usage
+
+You can run `prometheus_exporter` project using an official Docker image:
+
+```bash
+docker pull discourse/prometheus_exporter:latest
+# or use specific version
+docker pull discourse/prometheus_exporter:x.x.x
+```
+
+The start the container:
+
+```bash
+docker run -p 9394:9394 discourse/prometheus_exporter
+```
+
+Additional flags could be included:
+
+```
+docker run -p 9394:9394 discourse/prometheus_exporter --verbose --prefix=myapp
+```
+
 ## Docker/Kubernetes Healthcheck
 
 A `/ping` endpoint which only returns `PONG` is available so you can run container healthchecks :

data/lib/prometheus_exporter/server/metrics_container.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module PrometheusExporter::Server
+  class MetricsContainer
+    METRIC_MAX_AGE = 60
+    METRIC_EXPIRE_ATTR = "_expire_at"
+
+    attr_reader :data, :ttl
+    attr_accessor :filter
+
+    def initialize(ttl: METRIC_MAX_AGE, expire_attr: METRIC_EXPIRE_ATTR, filter: nil)
+      @data          = []
+      @ttl           = ttl
+      @expire_attr   = expire_attr
+      @filter        = filter
+    end
+
+    def <<(obj)
+      now = get_time
+      obj[@expire_attr] = now + @ttl
+
+      expire(time: now, new_metric: obj)
+
+      @data << obj
+      @data
+    end
+
+    def [](key)
+      @data.tap { expire }[key]
+    end
+
+    def size(&blk)
+      wrap_expire(:size, &blk)
+    end
+    alias_method :length, :size
+
+    def map(&blk)
+      wrap_expire(:map, &blk)
+    end
+
+    def each(&blk)
+      wrap_expire(:each, &blk)
+    end
+
+    def expire(time: nil, new_metric: nil)
+      time ||= get_time
+
+      @data.delete_if do |metric|
+        expired = metric[@expire_attr] < time
+        expired ||= filter.call(new_metric, metric) if @filter && new_metric
+        expired
+      end
+    end
+
+    private
+
+    def get_time
+      ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+    end
+
+    def wrap_expire(method_name, &blk)
+      expire
+      @data.public_send(method_name, &blk)
+    end
+  end
+end

data/lib/prometheus_exporter/server/puma_collector.rb

@@ -14,7 +14,10 @@ module PrometheusExporter::Server
     }
 
     def initialize
-      @puma_metrics = []
+      @puma_metrics = MetricsContainer.new
+      @puma_metrics.filter = -> (new_metric, old_metric) do
+        new_metric["pid"] == old_metric["pid"] && new_metric["hostname"] == old_metric["hostname"]
+      end
     end
 
     def type
@@ -51,15 +54,6 @@ module PrometheusExporter::Server
     end
 
     def collect(obj)
-      now = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-
-      obj["created_at"] = now
-
-      @puma_metrics.delete_if do |current|
-        (obj["pid"] == current["pid"] && obj["hostname"] == current["hostname"]) ||
-          (current["created_at"] + MAX_PUMA_METRIC_AGE < now)
-      end
-
       @puma_metrics << obj
     end
   end

data/lib/prometheus_exporter/server/sidekiq_process_collector.rb

@@ -12,7 +12,7 @@ module PrometheusExporter::Server
     attr_reader :sidekiq_metrics, :gauges
 
     def initialize
-      @sidekiq_metrics = []
+      @sidekiq_metrics = MetricsContainer.new(ttl: MAX_SIDEKIQ_METRIC_AGE)
       @gauges = {}
     end
 
@@ -21,6 +21,8 @@ module PrometheusExporter::Server
     end
 
     def metrics
+      SIDEKIQ_PROCESS_GAUGES.each_key { |name| gauges[name]&.reset! }
+
       sidekiq_metrics.map do |metric|
         labels = metric.fetch('labels', {})
         SIDEKIQ_PROCESS_GAUGES.map do |name, help|
@@ -35,12 +37,7 @@ module PrometheusExporter::Server
     end
 
     def collect(object)
-      now = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-      process = object['process']
-
-      process["created_at"] = now
-      sidekiq_metrics.delete_if { |metric| metric['created_at'] + MAX_SIDEKIQ_METRIC_AGE < now }
-      sidekiq_metrics << process
+      @sidekiq_metrics << object["process"]
     end
   end
 end

data/lib/prometheus_exporter/server/sidekiq_queue_collector.rb

@@ -11,7 +11,7 @@ module PrometheusExporter::Server
     attr_reader :sidekiq_metrics, :gauges
 
     def initialize
-      @sidekiq_metrics = []
+      @sidekiq_metrics = MetricsContainer.new
       @gauges = {}
     end
 
@@ -20,6 +20,8 @@ module PrometheusExporter::Server
     end
 
     def metrics
+      SIDEKIQ_QUEUE_GAUGES.each_key { |name| gauges[name]&.reset! }
+
       sidekiq_metrics.map do |metric|
         labels = metric.fetch("labels", {})
         SIDEKIQ_QUEUE_GAUGES.map do |name, help|
@@ -34,12 +36,9 @@ module PrometheusExporter::Server
     end
 
     def collect(object)
-      now = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
       object['queues'].each do |queue|
-        queue["created_at"] = now
         queue["labels"].merge!(object['custom_labels']) if object['custom_labels']
-        sidekiq_metrics.delete_if { |metric| metric['created_at'] + MAX_SIDEKIQ_METRIC_AGE < now }
-        sidekiq_metrics << queue
+        @sidekiq_metrics << queue
       end
     end
   end

data/lib/prometheus_exporter/server/sidekiq_stats_collector.rb

@@ -18,7 +18,7 @@ module PrometheusExporter::Server
     attr_reader :sidekiq_metrics, :gauges
 
     def initialize
-      @sidekiq_metrics = []
+      @sidekiq_metrics = MetricsContainer.new(ttl: MAX_SIDEKIQ_METRIC_AGE)
       @gauges = {}
     end
 
@@ -27,6 +27,8 @@ module PrometheusExporter::Server
     end
 
     def metrics
+      SIDEKIQ_STATS_GAUGES.each_key { |name| gauges[name]&.reset! }
+
       sidekiq_metrics.map do |metric|
         SIDEKIQ_STATS_GAUGES.map do |name, help|
           if (value = metric['stats'][name])
@@ -40,10 +42,7 @@ module PrometheusExporter::Server
     end
 
     def collect(object)
-      now = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-      object['created_at'] = now
-      sidekiq_metrics.delete_if { |metric| metric['created_at'] + MAX_SIDEKIQ_METRIC_AGE < now }
-      sidekiq_metrics << object
+      @sidekiq_metrics << object
     end
   end
 end

data/lib/prometheus_exporter/server/type_collector.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "prometheus_exporter/server/metrics_container"
+
 module PrometheusExporter::Server
   class TypeCollector
     def type

data/lib/prometheus_exporter/server/web_server.rb

@@ -44,6 +44,11 @@ module PrometheusExporter::Server
 
       @logger.info "Using Basic Authentication via #{@auth}" if @verbose && @auth
 
+      if %w(ALL ANY).include?(@bind)
+        @logger.info "Listening on both 0.0.0.0/:: network interfaces"
+        @bind = nil
+      end
+
       @server = WEBrick::HTTPServer.new(
         Port: @port,
         BindAddress: @bind,

data/lib/prometheus_exporter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrometheusExporter
-  VERSION = '2.0.6'
+  VERSION = "2.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.8
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webrick
@@ -243,11 +243,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/docker.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Appraisals
 - CHANGELOG
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -289,6 +291,7 @@ files:
 - lib/prometheus_exporter/server/collector_base.rb
 - lib/prometheus_exporter/server/delayed_job_collector.rb
 - lib/prometheus_exporter/server/hutch_collector.rb
+- lib/prometheus_exporter/server/metrics_container.rb
 - lib/prometheus_exporter/server/process_collector.rb
 - lib/prometheus_exporter/server/puma_collector.rb
 - lib/prometheus_exporter/server/resque_collector.rb