bc-prometheus-ruby 0.1.0

data/lib/bigcommerce/prometheus/servers/thin/controllers/base_controller.rb

@@ -0,0 +1,63 @@
+# 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 Servers
+      module Thin
+        module Controllers
+          ##
+          # Base thin controller for prometheus metrics
+          #
+          class BaseController
+            ##
+            # @param [Rack::Request] request
+            # @param [Rack::Response] response
+            # @param [Bigcommerce::Prometheus::Servers::Thin::ServerMetrics]
+            # @param [PrometheusExporter::Server::Collector] collector
+            # @param [Logger] logger
+            #
+            def initialize(request:, response:, server_metrics:, collector:, logger:)
+              @request = request
+              @response = response
+              @collector = collector
+              @server_metrics = server_metrics
+              @logger = logger
+            end
+
+            def handle
+              call
+              @response.finish
+            end
+
+            ##
+            # @param [String] key
+            # @param [String] value
+            #
+            def set_header(key, value)
+              if @response.respond_to?(:add_header) # rack 2.0+
+                @response.add_header(key.to_s, value.to_s)
+              else
+                @response[key.to_s] = value.to_s
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/servers/thin/controllers/error_controller.rb

@@ -0,0 +1,36 @@
+# 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 Servers
+      module Thin
+        module Controllers
+          ##
+          # Handle 500s
+          #
+          class ErrorController < BaseController
+            def call
+              @response.body << ''
+              @response.status = 500
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/servers/thin/controllers/metrics_controller.rb

@@ -0,0 +1,87 @@
+# 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
+        module Controllers
+          ##
+          # GET /metrics
+          #
+          class MetricsController < BaseController
+            ##
+            # Handle outputting of metrics
+            #
+            def call
+              collected_metrics = metrics
+              if @request.accept_encoding.to_s.include?('gzip')
+                write_gzip(metrics)
+              else
+                @response.write(collected_metrics)
+              end
+              @response
+            end
+
+            private
+
+            ##
+            # Output via gzip
+            #
+            def write_gzip(metrics)
+              sio = ::StringIO.new
+              begin
+                writer = ::Zlib::GzipWriter.new(sio)
+                writer.write(metrics)
+              ensure
+                writer.close
+              end
+              @response.body << sio.string
+              set_header('Content-Encoding', 'gzip')
+            end
+
+            ##
+            # Gather all metrics
+            #
+            def metrics
+              metric_text = ''
+              working = true
+
+              begin
+                ::Timeout.timeout(@timeout) do
+                  metric_text = @collector.prometheus_metrics_text
+                end
+              rescue ::Timeout::Error
+                working = false
+                @logger.error 'Generating Prometheus metrics text timed out'
+              end
+
+              output = []
+              output << @server_metrics.to_prometheus_text(working: working)
+              output << metric_text
+              output.join("\n")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/servers/thin/controllers/not_found_controller.rb

@@ -0,0 +1,36 @@
+# 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 Servers
+      module Thin
+        module Controllers
+          ##
+          # Handle invalid requests to server
+          #
+          class NotFoundController < BaseController
+            def call
+              @response.status = 404
+              @response.body << 'Not Found! The Prometheus Ruby Exporter only listens on /metrics and /send-metrics'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bigcommerce/prometheus/servers/thin/controllers/send_metrics_controller.rb

@@ -0,0 +1,92 @@
+# 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 Servers
+      module Thin
+        module Controllers
+          ##
+          # POST /send-metrics
+          #
+          class SendMetricsController < BaseController
+            class BadMetricsError < StandardError; end
+            class InvalidRequestError < StandardError; end
+
+            ##
+            # Handle incoming metrics
+            #
+            def call
+              raise InvalidRequestError unless @request.post?
+
+              @server_metrics.add_session
+              process_metrics
+              succeed!
+            rescue InvalidRequestError => _e
+              fail!('Invalid request type. Only POST is supported.')
+            rescue BadMetricsError => e
+              fail!(e.message)
+            end
+
+            private
+
+            ##
+            # Succeed the request
+            #
+            def succeed!
+              @response['Content-Type'] = 'text/plain'
+              @response.write('OK')
+              @response.status = 200
+              @response
+            end
+
+            ##
+            # Fail the request
+            #
+            # @param [String]
+            #
+            def fail!(message)
+              @response['Content-Type'] = 'application/json'
+              @response.write([message].to_json)
+              @response.status = 500
+              @response
+            end
+
+            ##
+            # Process the metrics
+            #
+            def process_metrics
+              @server_metrics.add_metric
+              @collector.process(body)
+            rescue StandardError => e
+              @logger.error "[bigcommerce-prometheus] Error collecting metrics: #{e.inspect} - #{e.backtrace[0..4].join("\n")}"
+              @server_metrics.add_bad_metric
+              raise BadMetricsError, e.message
+            end
+
+            ##
+            # @return [String]
+            #
+            def body
+              @request.body.read
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# 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 Servers
+      module Thin
+        ##
+        # Handles metrics requests as a Rack App on the Thin server
+        #
+        class RackApp
+          ##
+          #
+          def initialize(collector: nil, timeout: nil, logger: nil)
+            @timeout = timeout || ::Bigcommerce::Prometheus.server_timeout
+            @collector = collector || ::PrometheusExporter::Server::Collector.new
+            @logger = logger || ::Bigcommerce::Prometheus.logger
+            @server_metrics = ::Bigcommerce::Prometheus::Servers::Thin::ServerMetrics.new(logger: @logger)
+          end
+
+          def call(env)
+            request = ::Rack::Request.new(env)
+            response = ::Rack::Response.new
+            controller = route(request)
+            handle(controller: controller, request: request, response: response)
+          rescue StandardError => e
+            @logger.error "Error: #{e.message}"
+            handle(controller: ::Bigcommerce::Prometheus::Servers::Thin::Controllers::ErrorController, request: request, response: response)
+          end
+
+          ##
+          # Add a type collector to this server
+          #
+          # @param [PrometheusExporter::Server::TypeCollector] collector
+          #
+          def add_type_collector(collector)
+            @collector.register_collector(collector)
+          end
+
+          private
+
+          ##
+          # Determine the controller route
+          #
+          # @param [Rack::Request] request
+          #
+          def route(request)
+            if request.fullpath == '/metrics' && request.request_method.to_s.downcase == 'get'
+              Bigcommerce::Prometheus::Servers::Thin::Controllers::MetricsController
+            elsif request.fullpath == '/send-metrics' && request.request_method.to_s.downcase == 'post'
+              Bigcommerce::Prometheus::Servers::Thin::Controllers::SendMetricsController
+            else
+              Bigcommerce::Prometheus::Servers::Thin::Controllers::NotFoundController
+            end
+          end
+
+          ##
+          # Handle a controller request
+          #
+          def handle(controller:, request:, response:)
+            con = controller.new(
+              request: request,
+              response: response,
+              server_metrics: @server_metrics,
+              collector: @collector,
+              logger: @logger
+            )
+            con.handle
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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 Servers
+      module Thin
+        ##
+        # Thin adapter for server
+        #
+        class Server < ::Thin::Server
+          def initialize(port:, host: nil, timeout: nil, logger: nil)
+            @port = port || ::PrometheusExporter::DEFAULT_PORT
+            @host = host || '0.0.0.0'
+            @timeout = timeout || ::PrometheusExporter::DEFAULT_TIMEOUT
+            @logger = logger || ::Bigcommerce::Prometheus.logger
+            @rack_app = ::Bigcommerce::Prometheus::Servers::Thin::RackApp.new(timeout: timeout, logger: logger)
+            super(@host, @port, @rack_app)
+            ::Thin::Logging.logger = @logger
+          end
+
+          ##
+          # Add a type collector to this server
+          #
+          # @param [PrometheusExporter::Server::TypeCollector] collector
+          #
+          def add_type_collector(collector)
+            @rack_app.add_type_collector(collector)
+          end
+        end
+      end
+    end
+  end
+end