gds_metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae59f4c6dcfbb57dc0ad51ee689ea926b8c58dc78684df7fc749fac81192e1d0
+  data.tar.gz: c3207917a94edd3fc16b59c7b8c0184f685fcf01e03de63ca6956f0210a5a27b
+SHA512:
+  metadata.gz: aabeeedaaf9d71aef66b729d8088bfff7d1516fa542efb6d0c2a749ece6e6a2e4ce267d7124642ea0ffb6f0cfcaf1377b4b7359e9833fbb2938e7a74f04d97ec
+  data.tar.gz: 55bb3cd96daa713840223d2c109787b73a6f94e12a52b299eafeb132b2a773c14dda90e6222256b7d3b8d11eaa17fadf6c37c4ab7b24c8f6a9bf188ae3f08dfe

data/README.md

@@ -0,0 +1,5 @@
+## GDS Metrics
+
+**This is under development.**
+
+Instrument your web app to export Prometheus metrics.

data/lib/gds_metrics.rb

@@ -0,0 +1,16 @@
+require "rack"
+
+require "prometheus/client"
+require "prometheus/client/rack/collector"
+require "prometheus/client/rack/exporter"
+
+require "gds_metrics/version"
+require "gds_metrics/mmap"
+require "gds_metrics/middleware"
+require "gds_metrics/config"
+require "gds_metrics/auth"
+require "gds_metrics/gzip"
+require "gds_metrics/railtie" if defined?(Rails)
+
+GDS::Metrics::Config.instance.populate_from_env
+GDS::Metrics::Mmap.setup

data/lib/gds_metrics/auth.rb

@@ -0,0 +1,41 @@
+module GDS
+  module Metrics
+    class Auth
+      attr_accessor :app
+
+      def initialize(app)
+        self.app = app
+      end
+
+      def call(env)
+        return app.call(env) unless metrics_path?(env)
+        return app.call(env) unless config.auth_enabled?
+        return app.call(env) if authorized?(env)
+
+        unauthorized
+      end
+
+    private
+
+      def metrics_path?(env)
+        path = env.fetch("PATH_INFO")
+        path == config.prometheus_metrics_path
+      end
+
+      def authorized?(env)
+        header = env.fetch("HTTP_AUTHORIZATION", "")
+        token = header[/Bearer (.*)/i, 1]
+
+        token == config.application_id
+      end
+
+      def config
+        Config.instance
+      end
+
+      def unauthorized
+        [401, { "Content-Type" => "text/plain" }, ["Unauthorized"]]
+      end
+    end
+  end
+end

data/lib/gds_metrics/config.rb

@@ -0,0 +1,42 @@
+module GDS
+  module Metrics
+    def self.configure(&block)
+      block.call(Config.instance)
+    end
+
+    class Config
+      attr_accessor :application_id
+      attr_accessor :prometheus_metrics_path
+      attr_accessor :auth_enabled
+      attr_accessor :mmap_directory
+
+      alias :auth_enabled? :auth_enabled
+
+      def self.instance
+        @singleton ||= Config.new
+      end
+
+      def populate_from_env
+        self.application_id = fetch_application_id
+        self.prometheus_metrics_path = fetch_prometheus_metrics_path
+        self.mmap_directory = fetch_mmap_directory
+        self.auth_enabled = !application_id.nil?
+      end
+
+    private
+
+      def fetch_application_id
+        vcap_application = JSON.parse(ENV.fetch("VCAP_APPLICATION", "{}"))
+        vcap_application["application_id"]
+      end
+
+      def fetch_prometheus_metrics_path
+        ENV.fetch("PROMETHEUS_METRICS_PATH", "/metrics")
+      end
+
+      def fetch_mmap_directory
+        ENV.fetch("MMAP_DIRECTORY", "/tmp")
+      end
+    end
+  end
+end

data/lib/gds_metrics/gzip.rb

@@ -0,0 +1,34 @@
+module GDS
+  module Metrics
+    class Gzip
+      attr_accessor :app
+
+      def initialize(app)
+        self.app = app
+      end
+
+      def call(env)
+        if metrics_path?(env)
+          compress(env)
+        else
+          app.call(env)
+        end
+      end
+
+    private
+
+      def compress(env)
+        Rack::Deflater.new(app).call(env)
+      end
+
+      def metrics_path?(env)
+        path = env.fetch("PATH_INFO")
+        path == config.prometheus_metrics_path
+      end
+
+      def config
+        Config.instance
+      end
+    end
+  end
+end

data/lib/gds_metrics/middleware.rb

@@ -0,0 +1,23 @@
+module GDS
+  module Metrics
+    class Middleware
+      attr_accessor :wrapped_app
+
+      def initialize(app)
+        self.wrapped_app = Rack::Builder.app do
+          use GDS::Metrics::Gzip
+          use GDS::Metrics::Auth
+
+          use Prometheus::Client::Rack::Collector
+          use Prometheus::Client::Rack::Exporter
+
+          run app
+        end
+      end
+
+      def call(env)
+        wrapped_app.call(env)
+      end
+    end
+  end
+end

data/lib/gds_metrics/mmap.rb

@@ -0,0 +1,10 @@
+module GDS
+  module Metrics
+    module Mmap
+      def self.setup
+        directory = Config.instance.mmap_directory
+        Prometheus::Client.configuration.multiprocess_files_dir = directory
+      end
+    end
+  end
+end

data/lib/gds_metrics/railtie.rb

@@ -0,0 +1,9 @@
+module GDS
+  module Metrics
+    class Railtie < Rails::Railtie
+      initializer "gds_metrics.use_middleware" do |app|
+        app.middleware.use GDS::Metrics::Middleware
+      end
+    end
+  end
+end

data/lib/gds_metrics/version.rb

@@ -0,0 +1,5 @@
+module GDS
+  module Metrics
+    VERSION = "0.0.1".freeze
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: gds_metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Government Digital Service
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client-mmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: govuk-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+description: Instrument your web app to export Prometheus metrics.
+email: reliability-engineering-tools-team@digital.cabinet-office.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/gds_metrics.rb
+- lib/gds_metrics/auth.rb
+- lib/gds_metrics/config.rb
+- lib/gds_metrics/gzip.rb
+- lib/gds_metrics/middleware.rb
+- lib/gds_metrics/mmap.rb
+- lib/gds_metrics/railtie.rb
+- lib/gds_metrics/version.rb
+homepage: https://github.com/alphagov/gds_metrics_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: GDS Metrics
+test_files: []