gruf-prometheus 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b2ac2951ece4595b35a0b951bbcd9d8d246238b755771554316fb22b97ab5ef
-  data.tar.gz: db1793e8f126900fa981fc8cc2f36f665bbce8590f2d8cfab5912b5763180ec3
+  metadata.gz: 8c3aed24d2b55ffbf676b7a27acab6fdcdff134856f294ae1c7b5ffd3f6c39c9
+  data.tar.gz: d6221023c0bdbe602c00e46433aea36b746bcb5d37f107df92809f0590a6e61e
 SHA512:
-  metadata.gz: 6766ed05abc90b57c8b46a587fe16c2f16c8aa46883a62f7493ae61938212a89d0c5b53a805949c1030dfe03a55dc9fd56e1f7972e12c50f7535f15e4397af04
-  data.tar.gz: 6be2cc11e6d60caf4861196852a722c08ba1b20dc37a4e449033cf09ed41337aa66b6ba90d0bd73d66304b82b2d7acf49e3578f52eceb65781419054b1d41747
+  metadata.gz: f3df08b6a3032a196bf88999ca838f4a2bc6042913eaa0534ecdc72077ebfc7a0981878b98fcc1cafa847a4b4ba381eb890ad7dc7a2791d96da1dc4f85aefe45
+  data.tar.gz: d4df8e1ccd75da130d23bd894e6a088005fa7c7c90958b64fca22d486158d92d58df1f0848d2f43fa3fb1aa75c9b98c13dc8f9fdf8c013001335bd4a3471ee84

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the gruf-prometheus gem.
 
 ### Pending Release
 
+### 1.0.0
+
+- *Breaking Changes* Move all prometheus core dependencies to bc-prometheus-ruby  
+
 ### 0.0.2
 
 - Cleaner starting of the gruf server and collectors

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+[![CircleCI](https://circleci.com/gh/bigcommerce/gruf-prometheus/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/gruf-prometheus/tree/master)  [![Gem Version](https://badge.fury.io/rb/gruf-prometheus.svg)](https://badge.fury.io/rb/gruf-prometheus) [![Documentation](https://inch-ci.org/github/bigcommerce/gruf-prometheus.svg?branch=master)](https://inch-ci.org/github/bigcommerce/gruf-prometheus?branch=master)
 
 Adds Prometheus support for [gruf](https://github.com/bigcommerce/gruf) 2.7.0+.
 
@@ -20,24 +20,19 @@ Gruf.configure do |c|
 end
 ```
 
-Then `bundle exec gruf` and you'll automatically have prometheus metrics for gruf servers.
+Then `bundle exec gruf` and you'll automatically have prometheus metrics for your gruf server.
+
+The gruf server will by default run on port 9394, and can be scraped at `/metrics`.
 
 ## Configuration
 
-You can further configure with:
+You can further configure via bc-prometheus-ruby 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 | 	
+| process_name | Label to use for process name in logging | grpc | 	
+| collection_frequency | The period in seconds in which to collect metrics | 30 |
         
 ## License
 

data/gruf-prometheus.gemspec

@@ -42,5 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '>= 0.12'
 
   spec.add_runtime_dependency 'gruf', '>= 2.7'
-  spec.add_runtime_dependency 'prometheus_exporter', '~> 0.4'
+  spec.add_runtime_dependency 'bc-prometheus-ruby', '~> 0.1.3'
 end

data/lib/gruf/prometheus.rb

@@ -21,11 +21,12 @@ require 'prometheus_exporter/client'
 require 'prometheus_exporter/middleware'
 require 'prometheus_exporter/instrumentation'
 require 'gruf'
+require 'net/http'
+require 'logger'
+require 'bigcommerce/prometheus'
 
 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'
@@ -38,7 +39,7 @@ module Gruf
     extend Configuration
 
     def self.client
-      Gruf::Prometheus::Client.instance
+      Bigcommerce::Prometheus::Client.instance
     end
   end
 end

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

@@ -36,24 +36,38 @@ module Gruf
         end
 
         ##
-        # Start the instrumentor
+        # Start the collector
         #
         # @param [Gruf::Server] server
         # @param [Gruf::Prometheus::Client] client
         # @param [Integer] frequency
         #
         def self.start(server:, client: nil, frequency: nil)
+          stop if @thread
+
+          client ||= Bigcommerce::Prometheus::Client.instance
           collector = new(server: server, client: client, frequency: frequency)
-          Thread.new do
+          @thread = Thread.new do
             loop do
               collector.run
             end
           end
         end
 
+        ##
+        # Stop the collector
+        #
+        def self.stop
+          t = @thread
+          return unless t
+
+          t.kill
+          @thread = nil
+        end
+
         def run
           metric = collect
-          logger.debug "[gruf-prometheus] Pushing metrics to collector: #{metric.inspect}"
+          logger.debug "[gruf-prometheus] Pushing gruf metrics to type collector: #{metric.inspect}"
           @client.send_json metric
         rescue StandardError => e
           logger.error "[gruf-prometheus] Failed to collect gruf-prometheus stats: #{e.message}"

data/lib/gruf/prometheus/configuration.rb

@@ -22,16 +22,9 @@ module Gruf
     #
     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
+        collection_frequency: 30
       }.freeze
 
       attr_accessor *VALID_CONFIG_KEYS.keys
@@ -75,13 +68,9 @@ module Gruf
         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.process_name = ENV.fetch('PROMETHEUS_PROCESS_NAME', '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
 
       ##

data/lib/gruf/prometheus/hook.rb

@@ -27,9 +27,12 @@ module Gruf
       # @param [Gruf::Server] server
       #
       def before_server_start(server:)
-        start_collectors(server: server)
-        prometheus_server.add_type_collector(Gruf::Prometheus::TypeCollectors::Grpc)
+        logger.info "[gruf-prometheus][#{::Gruf::Prometheus.process_name}] Starting #{server.class}"
+        prometheus_server.add_type_collector(::Gruf::Prometheus::TypeCollectors::Grpc.new)
+        prometheus_server.add_type_collector(::PrometheusExporter::Server::ActiveRecordCollector.new)
         prometheus_server.start
+        sleep 2 unless ENV['RACK_ENV'] == 'test' # wait for server to come online
+        start_collectors(server: server)
       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
@@ -37,8 +40,8 @@ module Gruf
       ##
       # Handle proper shutdown of the prometheus server
       #
-      def after_server_stop(server:)
-        logger.debug "[gruf-prometheus][#{::Gruf::Prometheus.process_name}] Stopping #{server.class}"
+      def after_server_stop(*)
+        stop_collectors
         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")}"
@@ -52,24 +55,34 @@ module Gruf
       def start_collectors(server:)
         ::PrometheusExporter::Instrumentation::Process.start(
           type: ::Gruf::Prometheus.process_label,
-          client: ::Gruf::Prometheus.client,
+          client: ::Bigcommerce::Prometheus.client,
           frequency: ::Gruf::Prometheus.collection_frequency
         )
         ::Gruf::Prometheus::Collectors::Grpc.start(
           server: server,
-          client: ::Gruf::Prometheus.client,
+          client: ::Bigcommerce::Prometheus.client,
           frequency: ::Gruf::Prometheus.collection_frequency
         )
       end
 
+      ##
+      # Stop collectors for the gRPC process
+      #
+      def stop_collectors
+        ::PrometheusExporter::Instrumentation::Process.stop
+        ::Gruf::Prometheus::Collectors::Grpc.stop
+      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
+        @prometheus_server ||= ::Bigcommerce::Prometheus::Server.new(
+          host: Bigcommerce::Prometheus.server_host,
+          port: Bigcommerce::Prometheus.server_port,
+          timeout: Bigcommerce::Prometheus.server_timeout,
+          prefix: Bigcommerce::Prometheus.server_prefix,
+          logger: logger
         )
       end
     end

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

@@ -67,12 +67,12 @@ module Gruf
           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)
+          @pool_jobs_waiting_total.observe(obj['pool_jobs_waiting_total'].to_i, labels)
+          @pool_ready_workers_total.observe(obj['pool_ready_workers_total'].to_i, labels)
+          @pool_workers_total.observe(obj['pool_workers_total'].to_i, labels)
+          @pool_initial_size.observe(obj['pool_initial_size'].to_i, labels)
+          @poll_period.observe(obj['poll_period'].to_i, labels)
+          @thread_pool_exhausted.observe(obj['thread_pool_exhausted'].to_i, labels)
         end
       end
     end

data/lib/gruf/prometheus/version.rb

@@ -17,6 +17,6 @@
 #
 module Gruf
   module Prometheus
-    VERSION = '0.0.2'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf-prometheus
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -137,19 +137,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: prometheus_exporter
+  name: bc-prometheus-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.1.3
 description: Prometheus support for gruf
 email:
 - shaun.mccormick@bigcommerce.com
@@ -162,11 +162,9 @@ files:
 - 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
@@ -188,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Prometheus support for gruf

data/lib/gruf/prometheus/client.rb

@@ -1,37 +0,0 @@
-# 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/server.rb

@@ -1,124 +0,0 @@
-# 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