gruf-prometheus 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b2ac2951ece4595b35a0b951bbcd9d8d246238b755771554316fb22b97ab5ef
+  data.tar.gz: db1793e8f126900fa981fc8cc2f36f665bbce8590f2d8cfab5912b5763180ec3
+SHA512:
+  metadata.gz: 6766ed05abc90b57c8b46a587fe16c2f16c8aa46883a62f7493ae61938212a89d0c5b53a805949c1030dfe03a55dc9fd56e1f7972e12c50f7535f15e4397af04
+  data.tar.gz: 6be2cc11e6d60caf4861196852a722c08ba1b20dc37a4e449033cf09ed41337aa66b6ba90d0bd73d66304b82b2d7acf49e3578f52eceb65781419054b1d41747

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+Changelog for the gruf-prometheus gem.
+
+### Pending Release
+
+### 0.0.2
+
+- Cleaner starting of the gruf server and collectors
+- Improved logging and visibility around starting/stopping of collectors/server
+
+### 0.0.1
+
+- Initial public release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at splittingred@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -0,0 +1,57 @@
+# gruf-prometheus - Prometheus support for gruf
+
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-prometheus/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-prometheus/tree/master)
+
+Adds Prometheus support for [gruf](https://github.com/bigcommerce/gruf) 2.7.0+.
+
+## Installation
+
+```ruby
+gem 'gruf-prometheus'
+```
+
+In your gruf initializer:
+
+```ruby
+require 'gruf/prometheus'
+
+Gruf.configure do |c|
+  c.hooks.use(Gruf::Prometheus::Hook)
+end
+```
+
+Then `bundle exec gruf` and you'll automatically have prometheus metrics for gruf servers.
+
+## Configuration
+
+You can further configure with:
+
+| Option | Description | Default |
+| ------ | ----------- | ------- |
+| client_custom_labels | A hash of custom labels to send with each client request | `{}` |
+| client_max_queue_size | The max amount of metrics to send before flushing | 10000 |
+| client_thread_sleep | How often to sleep the worker thread that manages the client buffer (seconds) | 0.5 |
+| process_label | The label to use for metric prefixing | grpc |
+| process_name | Label to use for process name in logging | grpc |
+| collection_frequency | How often to poll collection metrics (seconds) | 15 |
+| server_host | The host to run the collector on | '0.0.0.0' |
+| server_port | The port to run the collector on | 9394 |
+| server_prefix | The prefix for all collected metrics | ruby_ |
+| server_timeout | Timeout when exporting metrics (seconds) | 2 | 	
+        
+## License
+
+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.

data/gruf-prometheus.gemspec

@@ -0,0 +1,46 @@
+# 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.
+#
+$:.push File.expand_path('../lib', __FILE__)
+require 'gruf/prometheus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gruf-prometheus'
+  spec.version       = Gruf::Prometheus::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['shaun.mccormick@bigcommerce.com']
+
+  spec.summary       = 'Prometheus support for gruf'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/bigcommerce/gruf-prometheus'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-prometheus.gemspec']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '>= 0.4'
+  spec.add_development_dependency 'bundler-audit', '>= 0.6'
+  spec.add_development_dependency 'rubocop', '>= 0.68'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
+  spec.add_development_dependency 'null-logger', '>= 0.1'
+  spec.add_development_dependency 'pry', '>= 0.12'
+
+  spec.add_runtime_dependency 'gruf', '>= 2.7'
+  spec.add_runtime_dependency 'prometheus_exporter', '~> 0.4'
+end

data/lib/gruf/prometheus.rb

@@ -0,0 +1,44 @@
+# 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 'prometheus_exporter'
+require 'prometheus_exporter/server'
+require 'prometheus_exporter/client'
+require 'prometheus_exporter/middleware'
+require 'prometheus_exporter/instrumentation'
+require 'gruf'
+
+require_relative 'prometheus/version'
+require_relative 'prometheus/configuration'
+require_relative 'prometheus/client'
+require_relative 'prometheus/server'
+require_relative 'prometheus/collectors/grpc'
+require_relative 'prometheus/type_collectors/grpc'
+require_relative 'prometheus/hook'
+
+module Gruf
+  ##
+  # Base top-level gruf prometheus module
+  #
+  module Prometheus
+    extend Configuration
+
+    def self.client
+      Gruf::Prometheus::Client.instance
+    end
+  end
+end

data/lib/gruf/prometheus/client.rb

@@ -0,0 +1,37 @@
+# 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 Gruf
+  module Prometheus
+    ##
+    # Client implementation for Prometheus
+    #
+    class Client < ::PrometheusExporter::Client
+      include Singleton
+
+      def initialize
+        super(
+          host: ::Gruf::Prometheus.server_host,
+          port: ::Gruf::Prometheus.server_port,
+          max_queue_size: ::Gruf::Prometheus.client_max_queue_size,
+          thread_sleep: ::Gruf::Prometheus.client_thread_sleep,
+          custom_labels: ::Gruf::Prometheus.client_custom_labels
+        )
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/collectors/grpc.rb

@@ -0,0 +1,97 @@
+# 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 Gruf
+  module Prometheus
+    module Collectors
+      ##
+      # Prometheus instrumentor for gRPC servers
+      #
+      class Grpc
+        include Gruf::Loggable
+
+        ##
+        # @param [Gruf::Server] server
+        # @param [Gruf::Prometheus::Client] client
+        # @param [Integer] frequency
+        #
+        def initialize(server:, client:, frequency: nil)
+          @server = server
+          @client = client
+          @frequency = frequency || 15
+        end
+
+        ##
+        # Start the instrumentor
+        #
+        # @param [Gruf::Server] server
+        # @param [Gruf::Prometheus::Client] client
+        # @param [Integer] frequency
+        #
+        def self.start(server:, client: nil, frequency: nil)
+          collector = new(server: server, client: client, frequency: frequency)
+          Thread.new do
+            loop do
+              collector.run
+            end
+          end
+        end
+
+        def run
+          metric = collect
+          logger.debug "[gruf-prometheus] Pushing metrics to collector: #{metric.inspect}"
+          @client.send_json metric
+        rescue StandardError => e
+          logger.error "[gruf-prometheus] Failed to collect gruf-prometheus stats: #{e.message}"
+        ensure
+          sleep @frequency
+        end
+
+        private
+
+        def collect
+          metric = {}
+          metric[:type] = 'grpc'
+          rpc_server = @server.server
+          rpc_server.instance_variable_get(:@run_mutex).synchronize do
+            collect_server_metrics(rpc_server, metric)
+          end
+          metric
+        end
+
+        ##
+        # @param [GRPC::RpcServer] rpc_server
+        #
+        def collect_server_metrics(rpc_server, metric)
+          pool = rpc_server.instance_variable_get(:@pool)
+          metric[:pool_jobs_waiting_total] = pool.jobs_waiting.to_i
+          metric[:pool_ready_workers_total] = pool.instance_variable_get(:@ready_workers).size
+          metric[:pool_workers_total] = pool.instance_variable_get(:@workers)&.size
+          metric[:pool_initial_size] = rpc_server.instance_variable_get(:@pool_size).to_i
+          metric[:poll_period] = rpc_server.instance_variable_get(:@poll_period).to_i
+        end
+
+        ##
+        # @return [GRPC::RpcServer]
+        #
+        def grpc_server
+          @server.server
+        end
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/configuration.rb

@@ -0,0 +1,101 @@
+# 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 Gruf
+  module Prometheus
+    ##
+    # General configuration for gruf prometheus integration
+    #
+    module Configuration
+      VALID_CONFIG_KEYS = {
+        client_custom_labels: nil,
+        client_max_queue_size: 10_000,
+        client_thread_sleep: 0.5,
+        process_label: 'grpc',
+        process_name: 'grpc',
+        collection_frequency: 15,
+        server_host: '0.0.0.0',
+        server_port: ::PrometheusExporter::DEFAULT_PORT,
+        server_prefix: ::PrometheusExporter::DEFAULT_PREFIX,
+        server_timeout: ::PrometheusExporter::DEFAULT_TIMEOUT
+      }.freeze
+
+      attr_accessor *VALID_CONFIG_KEYS.keys
+
+      ##
+      # Whenever this is extended into a class, setup the defaults
+      #
+      def self.extended(base)
+        base.reset
+      end
+
+      ##
+      # Yield self for ruby-style initialization
+      #
+      # @yields [Bigcommerce::Prometheus::Configuration]
+      # @return [Bigcommerce::Prometheus::Configuration]
+      #
+      def configure
+        reset unless @configured
+        yield self
+        @configured = true
+      end
+
+      ##
+      # Return the current configuration options as a Hash
+      #
+      # @return [Hash]
+      #
+      def options
+        opts = {}
+        VALID_CONFIG_KEYS.each_key do |k|
+          opts.merge!(k => send(k))
+        end
+        opts
+      end
+
+      ##
+      # Set the default configuration onto the extended class
+      #
+      def reset
+        VALID_CONFIG_KEYS.each do |k, v|
+          send("#{k}=".to_sym, v)
+        end
+        self.client_max_queue_size = ENV.fetch('PROMETHEUS_CLIENT_MAX_QUEUE_SIZE', 10_000).to_i
+        self.client_thread_sleep = ENV.fetch('PROMETHEUS_CLIENT_THREAD_SLEEP', 0.5).to_i
+        self.process_label = ENV.fetch('PROMETHEUS_PROCESS_LABEL', 'grpc').to_s
+        self.collection_frequency = ENV.fetch('PROMETHEUS_COLLECTION_FREQUENCY', 30).to_i
+        self.server_host = ENV.fetch('PROMETHEUS_SERVER_HOST', '0.0.0.0').to_s
+        self.server_port = ENV.fetch('PROMETHEUS_SERVER_PORT', ::PrometheusExporter::DEFAULT_PORT).to_i
+        self.server_timeout = ENV.fetch('PROMETHEUS_SERVER_TIMEOUT', ::PrometheusExporter::DEFAULT_TIMEOUT).to_i
+      end
+
+      ##
+      # Automatically determine environment
+      #
+      # @return [String] The current Ruby environment
+      #
+      def environment
+        if defined?(Rails)
+          Rails.env.to_s
+        else
+          (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development').to_s
+        end
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/hook.rb

@@ -0,0 +1,77 @@
+# 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 Gruf
+  module Prometheus
+    ##
+    # Hook for implementing prometheus stats before a gruf server starts
+    #
+    class Hook < Gruf::Hooks::Base
+      ##
+      # Startup the instrumentors for collection of gRPC and process metrics prior to server start
+      #
+      # @param [Gruf::Server] server
+      #
+      def before_server_start(server:)
+        start_collectors(server: server)
+        prometheus_server.add_type_collector(Gruf::Prometheus::TypeCollectors::Grpc)
+        prometheus_server.start
+      rescue StandardError => e
+        logger.error "[gruf-prometheus][#{::Gruf::Prometheus.process_name}] Failed to start gruf instrumentation - #{e.message} - #{e.backtrace[0..4].join("\n")}"
+      end
+
+      ##
+      # Handle proper shutdown of the prometheus server
+      #
+      def after_server_stop(server:)
+        logger.debug "[gruf-prometheus][#{::Gruf::Prometheus.process_name}] Stopping #{server.class}"
+        prometheus_server.stop
+      rescue StandardError => e
+        logger.error "[gruf-prometheus][#{::Gruf::Prometheus.process_name}] Failed to stop gruf instrumentation - #{e.message} - #{e.backtrace[0..4].join("\n")}"
+      end
+
+      private
+
+      ##
+      # Start collectors for the gRPC process
+      #
+      def start_collectors(server:)
+        ::PrometheusExporter::Instrumentation::Process.start(
+          type: ::Gruf::Prometheus.process_label,
+          client: ::Gruf::Prometheus.client,
+          frequency: ::Gruf::Prometheus.collection_frequency
+        )
+        ::Gruf::Prometheus::Collectors::Grpc.start(
+          server: server,
+          client: ::Gruf::Prometheus.client,
+          frequency: ::Gruf::Prometheus.collection_frequency
+        )
+      end
+
+      ##
+      # @return [Gruf::Prometheus::Server]
+      #
+      def prometheus_server
+        @prometheus_server ||= ::Gruf::Prometheus::Server.new(
+          port: Gruf::Prometheus.server_port,
+          timeout: Gruf::Prometheus.server_timeout,
+          prefix: Gruf::Prometheus.server_prefix
+        )
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/server.rb

@@ -0,0 +1,124 @@
+# 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 Gruf
+  module Prometheus
+    ##
+    # Prometheus server that runs with gruf hooks
+    #
+    class Server
+      include Gruf::Loggable
+
+      ##
+      # @param [Integer] port
+      # @param [Integer] timeout
+      # @param [String] prefix
+      # @param [Boolean] verbose
+      # @param [Class] server_class
+      #
+      def initialize(
+        port:,
+        timeout:,
+        prefix: nil,
+        verbose: false,
+        server_class: nil
+      )
+        @port = (port || ::PrometheusExporter::DEFAULT_PORT).to_i
+        @timeout = (timeout || ::PrometheusExporter::DEFAULT_TIMEOUT).to_i
+        @prefix = (prefix || ::PrometheusExporter::DEFAULT_PREFIX).to_s
+        @verbose = verbose
+        @server_class = server_class || ::PrometheusExporter::Server::WebServer
+        @running = false
+        @process_name = ::Gruf::Prometheus.process_name
+      end
+
+      def start
+        logger.info "[gruf-prometheus][#{@process_name}] Starting prometheus exporter on port #{@port}"
+        server.start
+        logger.info "[gruf-prometheus][#{@process_name}] Prometheus exporter started on port #{@port}"
+
+        @running = true
+        server
+      rescue StandardError => e
+        logger.error "[gruf-prometheus][#{@process_name}] Failed to start exporter: #{e.message}"
+      end
+
+      ##
+      # Stop the server
+      #
+      def stop
+        logger.info "[gruf-prometheus][#{@process_name}] Shutting down prometheus exporter"
+        server.stop
+        logger.info "[gruf-prometheus][#{@process_name}] Prometheus exporter cleanly shut down"
+      rescue StandardError => e
+        logger.error "[gruf-prometheus][#{@process_name}] Failed to stop exporter: #{e.message}"
+      end
+
+      ##
+      # Whether or not the server is running
+      #
+      # @return [Boolean]
+      #
+      def running?
+        @running
+      end
+
+      ##
+      # Add a type collector to this server
+      #
+      # @param [Class] collector A type collector for the prometheus server
+      #
+      def add_type_collector(collector)
+        runner.type_collectors = runner.type_collectors.push(collector)
+      end
+
+      private
+
+      ##
+      # @return [::PrometheusExporter::Server::Runner]
+      #
+      def runner
+        unless @runner
+          @runner = ::PrometheusExporter::Server::Runner.new(
+            timeout: @timeout,
+            port: @port,
+            prefix: @prefix,
+            verbose: @verbose,
+            server_class: @server_class
+          )
+          PrometheusExporter::Metric::Base.default_prefix = @runner.prefix
+        end
+        @runner
+      end
+
+      ##
+      # @return [PrometheusExporter::Server::WebServer]
+      #
+      def server
+        @server ||= begin
+          runner.send(:register_type_collectors)
+          runner.server_class.new(
+            port: runner.port,
+            collector: runner.collector,
+            timeout: runner.timeout,
+            verbose: runner.verbose
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gruf/prometheus/type_collectors/grpc.rb

@@ -0,0 +1,80 @@
+# 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 Gruf
+  module Prometheus
+    module TypeCollectors
+      ##
+      # Type Collector for prometheus and grpc instrumentation
+      #
+      class Grpc < PrometheusExporter::Server::TypeCollector
+        ##
+        # Initialize the collector
+        #
+        def initialize
+          @pool_jobs_waiting_total = PrometheusExporter::Metric::Gauge.new('grpc_pool_jobs_waiting_total', 'Number jobs in the gRPC thread pool that are actively waiting')
+          @pool_ready_workers_total = PrometheusExporter::Metric::Gauge.new('grpc_pool_ready_workers_total', 'The amount of non-busy workers in the thread pool')
+          @pool_workers_total = PrometheusExporter::Metric::Gauge.new('grpc_pool_workers_total', 'Number of workers in the gRPC thread pool')
+          @pool_initial_size = PrometheusExporter::Metric::Gauge.new('grpc_pool_initial_size', 'Initial size of the gRPC thread pool')
+          @poll_period = PrometheusExporter::Metric::Gauge.new('grpc_poll_period', 'Polling period for the gRPC thread pool')
+          @thread_pool_exhausted = PrometheusExporter::Metric::Counter.new('grpc_thread_pool_exhausted', 'Times the gRPC thread pool has been exhausted')
+        end
+
+        ##
+        # @return [String]
+        #
+        def type
+          'grpc'
+        end
+
+        ##
+        # @return [Array]
+        #
+        def metrics
+          return [] unless @pool_jobs_waiting_total
+
+          [
+            @pool_jobs_waiting_total,
+            @pool_ready_workers_total,
+            @pool_workers_total,
+            @pool_initial_size,
+            @poll_period,
+            @thread_pool_exhausted
+          ]
+        end
+
+        ##
+        # Collect the object into the buffer
+        #
+        def collect(obj)
+          default_labels = {}
+          default_labels['environment'] = obj['environment'] if obj['environment']
+
+          custom_labels = obj['custom_labels'] || {}
+          labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
+
+          @pool_jobs_waiting_total.observe(obj['pool_jobs_waiting_total'], labels)
+          @pool_ready_workers_total.observe(obj['pool_ready_workers_total'], labels)
+          @pool_workers_total.observe(obj['pool_workers_total'], labels)
+          @pool_initial_size.observe(obj['pool_initial_size'], labels)
+          @poll_period.observe(obj['poll_period'], labels)
+          @thread_pool_exhausted.observe(obj['thread_pool_exhausted'], labels)
+        end
+      end
+    end
+  end
+end

data/lib/gruf/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 Gruf
+  module Prometheus
+    VERSION = '0.0.2'
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: gruf-prometheus
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-19 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.68'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.68'
+- !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: 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: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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'
+description: Prometheus support for gruf
+email:
+- shaun.mccormick@bigcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- gruf-prometheus.gemspec
+- lib/gruf/prometheus.rb
+- lib/gruf/prometheus/client.rb
+- lib/gruf/prometheus/collectors/grpc.rb
+- lib/gruf/prometheus/configuration.rb
+- lib/gruf/prometheus/hook.rb
+- lib/gruf/prometheus/server.rb
+- lib/gruf/prometheus/type_collectors/grpc.rb
+- lib/gruf/prometheus/version.rb
+homepage: https://github.com/bigcommerce/gruf-prometheus
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Prometheus support for gruf
+test_files: []