bc-prometheus-ruby 0.1.0

data/lib/bigcommerce/prometheus/servers/thin/server_metrics.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'timeout'
+require 'zlib'
+require 'stringio'
+
+module Bigcommerce
+  module Prometheus
+    module Servers
+      module Thin
+        ##
+        # Server metrics for the collector
+        #
+        class ServerMetrics
+          ##
+          # @param [::Logger] logger
+          #
+          def initialize(logger: nil)
+            @logger = logger || ::Bigcommerce::Prometheus.logger
+            @metrics_total = ::PrometheusExporter::Metric::Counter.new('collector_metrics_total', 'Total metrics processed by exporter.')
+            @sessions_total = ::PrometheusExporter::Metric::Counter.new('collector_sessions_total', 'Total send_metric sessions processed by exporter.')
+            @bad_metrics_total = ::PrometheusExporter::Metric::Counter.new('collector_bad_metrics_total', 'Total mis-handled metrics by collector.')
+            @collector_working_gauge = ::PrometheusExporter::Metric::Gauge.new('collector_working', 'Is the master process collector able to collect metrics')
+            @collector_rss_gauge = ::PrometheusExporter::Metric::Gauge.new('collector_rss', 'total memory used by collector process')
+          end
+
+          def add_session
+            @sessions_total.observe
+          end
+
+          def add_metric
+            @metrics_total.observe
+          end
+
+          def add_bad_metric
+            @bad_metrics_total.observe
+          end
+
+          ##
+          # @param [Boolean] working
+          # @return [String]
+          #
+          def to_prometheus_text(working: true)
+            collect(working: working).map(&:to_prometheus_text).join("\n\n")
+          end
+
+          private
+
+          ##
+          # Collect server metrics
+          #
+          # @param [Boolean] working
+          #
+          def collect(working: true)
+            @collector_working_gauge.observe(working ? 1 : 0)
+            @collector_rss_gauge.observe(rss)
+
+            [
+              @metrics_total,
+              @sessions_total,
+              @bad_metrics_total,
+              @collector_working_gauge,
+              @collector_rss_gauge
+            ]
+          end
+
+          ##
+          # Get RSS size of the current process
+          #
+          # @return [Integer]
+          #
+          def rss
+            _pid, size = `ps ax -o pid,rss | grep -E "^[[:space:]]*#{::Process.pid}"`.strip.split.map(&:to_i)
+            size
+          rescue StandardError => e
+            @logger.error "Failed to get RSS size: #{e.message}"
+            0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/type_collectors/resque.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Bigcommerce
+  module Prometheus
+    module TypeCollectors
+      ##
+      # Collect resque data from collectors and parse them into metrics
+      #
+      class Resque < PrometheusExporter::Server::TypeCollector
+        ##
+        # Initialize the collector
+        #
+        def initialize
+          @workers_total = PrometheusExporter::Metric::Gauge.new('resque_workers_total', 'Number of active workers')
+          @jobs_failed_total = PrometheusExporter::Metric::Gauge.new('jobs_failed_total', 'Number of failed jobs')
+          @jobs_pending_total = PrometheusExporter::Metric::Gauge.new('jobs_pending_total', 'Number of pending jobs')
+          @jobs_processed_total = PrometheusExporter::Metric::Gauge.new('jobs_processed_total', 'Number of processed jobs')
+          @queues_total = PrometheusExporter::Metric::Gauge.new('queues_total', 'Number of total queues')
+          @queue_sizes = PrometheusExporter::Metric::Gauge.new('queue_sizes', 'Size of each queue')
+        end
+
+        ##
+        # @return [String]
+        #
+        def type
+          'resque'
+        end
+
+        ##
+        # @return [Array]
+        #
+        def metrics
+          return [] unless @workers_total
+
+          [
+            @workers_total,
+            @jobs_failed_total,
+            @jobs_pending_total,
+            @jobs_processed_total,
+            @queues_total,
+            @queue_sizes
+          ]
+        end
+
+        ##
+        # Collect resque metrics from input data
+        #
+        def collect(obj)
+          default_labels = { environment: obj['environment'] }
+
+          custom_labels = obj['custom_labels']
+          labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
+
+          @workers_total.observe(obj['workers_total'], labels)
+          @jobs_failed_total.observe(obj['jobs_failed_total'], labels)
+          @jobs_pending_total.observe(obj['jobs_pending_total'], labels)
+          @jobs_processed_total.observe(obj['jobs_processed_total'], labels)
+          @queues_total.observe(obj['queues_total'], labels)
+
+          obj['queues'].each do |name, size|
+            @queue_sizes.observe(size, labels.merge(queue: name))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-present, BigCommerce Pty. Ltd. All rights reserved
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Bigcommerce
+  module Prometheus
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: bc-prometheus-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: null-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: prometheus_exporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Simple integration of ruby and puma servers with prometheus
+email:
+- shaun.mccormick@bigcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- bc-prometheus-ruby.gemspec
+- lib/bigcommerce/prometheus.rb
+- lib/bigcommerce/prometheus/client.rb
+- lib/bigcommerce/prometheus/collectors/resque.rb
+- lib/bigcommerce/prometheus/configuration.rb
+- lib/bigcommerce/prometheus/instrumentors/hutch.rb
+- lib/bigcommerce/prometheus/instrumentors/resque.rb
+- lib/bigcommerce/prometheus/instrumentors/web.rb
+- lib/bigcommerce/prometheus/integrations/puma.rb
+- lib/bigcommerce/prometheus/integrations/railtie.rb
+- lib/bigcommerce/prometheus/integrations/resque.rb
+- lib/bigcommerce/prometheus/loggable.rb
+- lib/bigcommerce/prometheus/server.rb
+- lib/bigcommerce/prometheus/servers/thin/controllers/base_controller.rb
+- lib/bigcommerce/prometheus/servers/thin/controllers/error_controller.rb
+- lib/bigcommerce/prometheus/servers/thin/controllers/metrics_controller.rb
+- lib/bigcommerce/prometheus/servers/thin/controllers/not_found_controller.rb
+- lib/bigcommerce/prometheus/servers/thin/controllers/send_metrics_controller.rb
+- lib/bigcommerce/prometheus/servers/thin/rack_app.rb
+- lib/bigcommerce/prometheus/servers/thin/server.rb
+- lib/bigcommerce/prometheus/servers/thin/server_metrics.rb
+- lib/bigcommerce/prometheus/type_collectors/resque.rb
+- lib/bigcommerce/prometheus/version.rb
+homepage: https://github.com/bigcommerce/bc-prometheus-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Simple integration of ruby and puma servers with prometheus
+test_files: []