bc-prometheus-ruby 0.1.0

data/lib/bigcommerce/prometheus/instrumentors/hutch.rb

@@ -0,0 +1,72 @@
+# 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 Instrumentors
+      ##
+      # Instrumentors for hutch process
+      #
+      class Hutch
+        include Bigcommerce::Prometheus::Loggable
+
+        def initialize(app:)
+          @app = app
+          @enabled = Bigcommerce::Prometheus.enabled
+          @process_name = Bigcommerce::Prometheus.process_name
+          @server_port = Bigcommerce::Prometheus.server_port
+          @server_timeout = Bigcommerce::Prometheus.server_timeout
+          @server_prefix = Bigcommerce::Prometheus.server_prefix
+        end
+
+        ##
+        # Start the web instrumentor
+        #
+        def start
+          unless @enabled
+            logger.debug "[bigcommerce-prometheus][#{@process_name}] Prometheus disabled, skipping hutch start..."
+            return
+          end
+
+          server.add_type_collector(PrometheusExporter::Server::ActiveRecordCollector.new)
+          server.add_type_collector(PrometheusExporter::Server::HutchCollector.new)
+          server.start
+          setup_middleware
+        rescue StandardError => e
+          logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start hutch instrumentation - #{e.message} - #{e.backtrace[0..4].join("\n")}"
+        end
+
+        private
+
+        def server
+          @server ||= ::Bigcommerce::Prometheus::Server.new(
+            port: @server_port,
+            timeout: @server_timeout,
+            prefix: @server_prefix
+          )
+        end
+
+        def setup_middleware
+          logger.info "[bigcommerce-prometheus][#{@process_name}] Setting up hutch prometheus middleware"
+          require 'hutch'
+          ::Hutch::Config.set(:tracer, PrometheusExporter::Instrumentation::Hutch)
+          @app.middleware.unshift(PrometheusExporter::Middleware, client: Bigcommerce::Prometheus.client)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# 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 Instrumentors
+      ##
+      # Instrumentors for resque process
+      #
+      class Resque
+        include Bigcommerce::Prometheus::Loggable
+
+        def initialize(app:)
+          @app = app
+          @enabled = Bigcommerce::Prometheus.enabled
+          @process_name = Bigcommerce::Prometheus.process_name
+          @server_port = Bigcommerce::Prometheus.server_port
+          @server_timeout = Bigcommerce::Prometheus.server_timeout
+          @server_prefix = Bigcommerce::Prometheus.server_prefix
+        end
+
+        ##
+        # Start the web instrumentor
+        #
+        def start
+          unless @enabled
+            logger.debug "[bigcommerce-prometheus][#{@process_name}] Prometheus disabled, skipping resque start..."
+            return
+          end
+
+          server.add_type_collector(PrometheusExporter::Server::ActiveRecordCollector.new)
+          server.add_type_collector(Bigcommerce::Prometheus::TypeCollectors::Resque.new)
+          server.start
+          setup_middleware
+        rescue StandardError => e
+          logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start resque instrumentation - #{e.message} - #{e.backtrace[0..4].join("\n")}"
+        end
+
+        private
+
+        def server
+          @server ||= ::Bigcommerce::Prometheus::Server.new(
+            port: @server_port,
+            timeout: @server_timeout,
+            prefix: @server_prefix
+          )
+        end
+
+        def setup_middleware
+          logger.info "[bigcommerce-prometheus][#{@process_name}] Setting up resque prometheus middleware"
+          ::Resque.before_first_fork do
+            ::Bigcommerce::Prometheus::Integrations::Resque.start
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/instrumentors/web.rb

@@ -0,0 +1,84 @@
+# 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 Instrumentors
+      ##
+      # Instrumentors for web process
+      #
+      class Web
+        include Bigcommerce::Prometheus::Loggable
+
+        def initialize(app:)
+          @app = app
+          @enabled = Bigcommerce::Prometheus.enabled
+          @server_port = Bigcommerce::Prometheus.server_port
+          @server_timeout = Bigcommerce::Prometheus.server_timeout
+          @server_prefix = Bigcommerce::Prometheus.server_prefix
+          @process_name = Bigcommerce::Prometheus.process_name
+        end
+
+        ##
+        # Start the web instrumentor
+        #
+        def start
+          unless @enabled
+            logger.debug "[bigcommerce-prometheus][#{@process_name}] Prometheus disabled, skipping web start..."
+            return
+          end
+
+          setup_before_fork
+          setup_after_fork
+          setup_middleware
+        rescue StandardError => e
+          logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start web instrumentation - #{e.message} - #{e.backtrace[0..4].join("\n")}"
+        end
+
+        private
+
+        def server
+          @server ||= ::Bigcommerce::Prometheus::Server.new(
+            port: @server_port,
+            timeout: @server_timeout,
+            prefix: @server_prefix
+          )
+        end
+
+        def setup_before_fork
+          @app.config.before_fork_callbacks = [] unless @app.config.before_fork_callbacks
+          @app.config.before_fork_callbacks << lambda do
+            server.add_type_collector(PrometheusExporter::Server::ActiveRecordCollector.new)
+            server.add_type_collector(PrometheusExporter::Server::WebCollector.new)
+            server.start
+          end
+        end
+
+        def setup_after_fork
+          @app.config.after_fork_callbacks = [] unless @app.config.after_fork_callbacks
+          @app.config.after_fork_callbacks << lambda do
+            ::Bigcommerce::Prometheus::Integrations::Puma.start
+          end
+        end
+
+        def setup_middleware
+          @app.middleware.unshift(PrometheusExporter::Middleware, client: Bigcommerce::Prometheus.client)
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/integrations/puma.rb

@@ -0,0 +1,55 @@
+# 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 Integrations
+      ##
+      # Plugin for puma
+      #
+      class Puma
+        ##
+        # Start the puma collector
+        #
+        def self.start
+          ::PrometheusExporter::Instrumentation::Puma.start(
+            client: ::Bigcommerce::Prometheus.client,
+            frequency: ::Bigcommerce::Prometheus.puma_collection_frequency
+          )
+          if active_record_enabled?
+            ::PrometheusExporter::Instrumentation::ActiveRecord.start(
+              client: ::Bigcommerce::Prometheus.client,
+              frequency: ::Bigcommerce::Prometheus.puma_collection_frequency
+            )
+          end
+          ::PrometheusExporter::Instrumentation::Process.start(
+            client: ::Bigcommerce::Prometheus.client,
+            type: ::Bigcommerce::Prometheus.puma_process_label,
+            frequency: ::Bigcommerce::Prometheus.puma_collection_frequency
+          )
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def self.active_record_enabled?
+          defined?(ActiveRecord) && ::ActiveRecord::Base.connection_pool.respond_to?(:stat)
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/integrations/railtie.rb

@@ -0,0 +1,31 @@
+# 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 Integrations
+      ##
+      # Railtie for automatic configuration of Rails environments
+      #
+      class Railtie < ::Rails::Railtie
+        initializer 'zzz_bigcommerce.prometheus.configure_rails_initialization' do |app|
+          Bigcommerce::Prometheus::Instrumentors::Web.new(app: app).start
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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 Integrations
+      ##
+      # Plugin for resque
+      #
+      class Resque
+        ##
+        # Start the resque integration
+        #
+        def self.start
+          ::PrometheusExporter::Instrumentation::Process.start(
+            client: ::Bigcommerce::Prometheus.client,
+            type: ::Bigcommerce::Prometheus.resque_process_label
+          )
+          ::Bigcommerce::Prometheus::Collectors::Resque.start(
+            client: ::Bigcommerce::Prometheus.client,
+            frequency: ::Bigcommerce::Prometheus.resque_collection_frequency
+          )
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/loggable.rb

@@ -0,0 +1,32 @@
+# 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 for logging support
+    #
+    module Loggable
+      ##
+      # @return [::Logger]
+      #
+      def logger
+        Bigcommerce::Prometheus.logger
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/server.rb

@@ -0,0 +1,117 @@
+# 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
+    ##
+    # Server implementation for Prometheus
+    #
+    class Server
+      ##
+      # @param [String] host
+      # @param [Integer] port
+      # @param [Integer] timeout
+      # @param [String] prefix
+      #
+      def initialize(host: nil, port: nil, timeout: nil, prefix: nil, logger: nil)
+        @host = host || ::Bigcommerce::Prometheus.server_host
+        @port = (port || ::Bigcommerce::Prometheus.server_port).to_i
+        @timeout = (timeout || ::Bigcommerce::Prometheus.server_timeout).to_i
+        @prefix = (prefix || ::PrometheusExporter::DEFAULT_PREFIX).to_s
+        @process_name = ::Bigcommerce::Prometheus.process_name
+        @logger = logger || ::Bigcommerce::Prometheus.logger
+        @server = ::Bigcommerce::Prometheus::Servers::Thin::Server.new(port: @port, timeout: @timeout, logger: @logger)
+        @running = false
+        ::PrometheusExporter::Metric::Base.default_prefix = @prefix
+        setup_signal_handlers
+      end
+
+      ##
+      # Start the server
+      #
+      def start
+        @logger.info "[bigcommerce-prometheus][#{@process_name}] Starting prometheus exporter on port #{@host}:#{@port}"
+
+        @run_thread = ::Thread.start do
+          @server.start
+        end
+        @running = true
+
+        @logger.info "[bigcommerce-prometheus][#{@process_name}] Prometheus exporter started on #{@host}:#{@port}"
+
+        @server
+      rescue ::StandardError => e
+        @logger.error "[bigcommerce-prometheus][#{@process_name}] Failed to start exporter: #{e.message}"
+        stop
+      end
+
+      ##
+      # Start the server and run it until stopped
+      #
+      def start_until_stopped
+        start
+        yield
+        @run_thread.join
+      rescue StandardError => e
+        @logger.error "[bigcommerce-prometheus] Server crashed: #{e.message}"
+      end
+
+      ##
+      # Stop the server
+      #
+      def stop
+        @server.stop!
+        @run_thread.kill
+        @running = false
+        @logger.info "[bigcommerce-prometheus][#{@process_name}] Prometheus exporter cleanly shut down"
+      rescue ::StandardError => e
+        @logger.error "[bigcommerce-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 [PrometheusExporter::Server::TypeCollector] collector
+      #
+      def add_type_collector(collector)
+        @logger.info "[bigcommerce-prometheus][#{@process_name}] Registering collector #{collector&.type}"
+        @server.add_type_collector(collector)
+      end
+
+      private
+
+      ##
+      # Register signal handlers
+      #
+      # :nocov:
+      def setup_signal_handlers
+        ::Signal.trap('INT', &method(:stop))
+        ::Signal.trap('TERM', &method(:stop))
+      end
+      # :nocov:
+    end
+  end
+end