prometheus-client-forty_two 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f209f70a2727a37c304186be755185c9d64074f
+  data.tar.gz: ea07ad385e403a1c0da0d6c400a7e2b12f01926f
+SHA512:
+  metadata.gz: f03437e61ce83717f56b92decea86df7ee359f9d94f934eb0e8880ea6d8e86b9a0ebcde021d27dab06d718746393e6a2b8a9cb4118e6a4550dbfc57f6a1b9785
+  data.tar.gz: 79ed96f43dae5d70d7c45a6c29690818de15c1bc80da56d5c3a64a981f95afbd40ff7a3e0b17891926716e3c0536e1174a724d20ebc4a031067bd9b350d09d48

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:2.2.3
+
+ENV SRC_HOME /src
+RUN mkdir $SRC_HOME
+WORKDIR $SRC_HOME
+
+RUN gem install bundler -v 1.13.6
+
+COPY Gemfile* ./
+COPY prometheus-client-forty_two.gemspec ./
+RUN mkdir -p lib/prometheus/client/forty_two
+COPY lib/prometheus/client/forty_two/version.rb lib/prometheus/client/forty_two/
+RUN bundle
+
+CMD rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prometheus-client-forty_two.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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/README.md

@@ -0,0 +1,127 @@
+# Prometheus::Client::FortyTwo
+
+A configurable Collector middleware for prometheus-client at 42.
+
+## Installation
+
+If you're using [Bundler](https://bundler.io/) add this line to your `Gemfile`.
+
+```ruby
+gem 'prometheus-client-forty_two'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prometheus-client-forty_two
+
+## Overview
+
+The Prometheus Ruby Client gem comes with nice standard middlewares to collect
+simple metrics on routes visited on the app, but it fails in some specific cases:
+
+1.  Non-numeric, non-uuid identifiers are not cleaned up.
+2.  When static files are served by the server, those queries are collected.
+
+This gem offers another Collector that can be customized to:
+
+1.  Clean custom identifiers.
+
+        use Prometheus::FortyTwo::Collector,
+            specific_id_stripper: lambda { |path|
+              path
+                .gsub(%r{/users/[^/]*}, '/users/:name')
+                .gsub(%r{/[en|es|fr]/}, '/:locale/')
+            }
+
+        # '/en/users/albert/posts/10/articles'
+        # '/fr/users/julie/posts/223/articles'
+        # '/es/users/zoe/posts/68/articles'
+        # would be stripped as one route:
+        # '/:locale/users/:name/posts/:id/articles'
+
+2.  Not collect metrics on static files.
+
+        use Prometheus::FortyTwo::Collector,
+            static_files_path: File.join(File.dirname(__FILE__), 'public')
+
+        # this will recursively list all files in the `/public` directory
+        # and not collect any metrics on those
+
+See [Prometheus Client](https://github.com/prometheus/client_ruby) to build your
+own metrics.
+
+## Usage
+
+```ruby
+# config.ru
+
+require 'rack'
+require 'prometheus/forty_two/collector'
+require 'prometheus/middleware/exporter'
+
+use Rack::Deflater
+use Prometheus::FortyTwo::Collector,
+  # TODO: add your configuration for the collector
+use Prometheus::Middleware::Exporter
+
+run ->(_) { [200, {'Content-Type' => 'text/html'}, ['OK']] }
+```
+
+## Development
+
+### Using docker
+
+This gem has been built for ruby 2.2.3 compatibility. Since this version is now
+deprecated, and therefore difficult to install on a recent system, this
+repository has been provided a `Dockerfile` and a `docher-compose.yml` to work
+inside a container.
+
+To build the container:
+
+```sh
+$ docker-compose build gem
+```
+
+To run commands in the container:
+
+```sh
+$ docker-compose run gem {COMMAND}
+```
+
+To run as session in the container:
+
+```sh
+$ docker-compose run gem bash
+```
+
+See next section for development commands
+
+### Directly on your system
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [42School/prometheus-client-forty_two](https://github.com/42School/prometheus-client-forty_two).
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org)
+code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prometheus/client/forty_two"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.2'
+
+services:
+  gem:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - ./:/src
+    entrypoint:
+      - "rspec"

data/lib/prometheus/forty_two/collector.rb

@@ -0,0 +1,94 @@
+require 'prometheus/forty_two/version'
+require 'prometheus/middleware/collector'
+require 'find'
+
+module Prometheus
+  module FortyTwo
+    # Collector is a Rack middleware that improves on the basic
+    # collector provided by the prometheus-client gem.
+    #
+    # By default, the original collector will strip routes of their
+    # ids assuming they are either numeric or uuids. Set the
+    # `:specific_id_stripper` option to provide a specific method
+    # to strip ids from urls and replace them by a generic label.
+    # The lambda will receive the route as a string before the
+    # default stripper strips the ids from it, and should return
+    # the cleaned up route.
+    #
+    #   use(
+    #     Prometheus::Client::FortyTwo::Middleware::Collector,
+    #     specific_id_stripper: lambda { |path|
+    #       path
+    #         .gsub(%r{/users/[^/]*}, '/users/:name')
+    #         .gsub(%r{/[en|es|fr]/}, '/:locale/')
+    #     }
+    #   )
+    #
+    #   # '/en/users/albert/posts/10/articles'
+    #   # '/fr/users/julie/posts/223/articles'
+    #   # '/es/users/zoe/posts/68/articles'
+    #   # would be stripped as one route:
+    #   # '/:locale/users/:name/posts/:id/articles'
+    #
+    # If the cleaner fails, the collector will not and only use the
+    # original strip function.
+    #
+    #
+    # When your rails server serves static files, those requests
+    # are not necessarily very relevant to your stats. Set the
+    # `:static_files_path` option to make the middleware list those
+    # files on startup and ignore them.
+    # If the directory does not exist or an exception is raised
+    # when discovering it, the Collector will just ignore it and
+    # start anyways.
+    #
+    #   use(
+    #     Prometheus::Client::FortyTwo::Middleware::Collector,
+    #     static_files_path: File.join(File.dirname(__FILE__), 'public')
+    #   )
+    #
+    #   # all routes pointing to /public will be ignored
+    class Collector < Prometheus::Middleware::Collector
+      def initialize(app, options = {})
+        super
+
+        @static_files = self.class.find_static_files(options[:static_files_path])
+        @specific_id_stripper = options[:specific_id_stripper] || ->(path) { path }
+      end
+
+      def call(env)
+        return @app.call(env) if @static_files.include?(env['PATH_INFO'])
+
+        super
+      end
+
+      protected
+
+      def strip_ids_from_path(path)
+        stripped_path = super
+        begin
+          @specific_id_stripper.call(stripped_path)
+        rescue StandardError
+          stripped_path
+        end
+      end
+
+      class << self
+        def find_static_files(path)
+          find_static_files!(path)
+        rescue StandardError
+          []
+        end
+
+        def find_static_files!(path)
+          return [] unless path
+
+          Find
+            .find(path)
+            .select { |f| File.file?(f) }
+            .map { |f| f.gsub(%r{\A\./}, '/') }
+        end
+      end
+    end
+  end
+end

data/lib/prometheus/forty_two/version.rb

@@ -0,0 +1,5 @@
+module Prometheus
+  module FortyTwo
+    VERSION = '0.1.0'
+  end
+end

data/prometheus-client-forty_two.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prometheus/forty_two/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prometheus-client-forty_two'
+  spec.version       = Prometheus::FortyTwo::VERSION
+  spec.authors       = ['Michel Belleville']
+  spec.email         = ['michel.belleville@gmail.com']
+
+  spec.summary       = 'A configurable Collector middleware for prometheus-client at 42'
+  spec.description   = <<-DESC.strip
+    Using prometheus-client with non-standard routes (i.e. using non-hexadecimal ids) yields problematic results.
+    This gem solves the problem offering a configurable Collector middleware.
+  DESC
+  spec.homepage      = 'https://github.com/42School/prometheus-client-forty_two'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'prometheus-client', '~> 2.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: prometheus-client-forty_two
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michel Belleville
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Using prometheus-client with non-standard routes (i.e. using non-hexadecimal ids) yields problematic results.
+      This gem solves the problem offering a configurable Collector middleware.
+email:
+- michel.belleville@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/prometheus/forty_two/collector.rb
+- lib/prometheus/forty_two/version.rb
+- prometheus-client-forty_two.gemspec
+homepage: https://github.com/42School/prometheus-client-forty_two
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A configurable Collector middleware for prometheus-client at 42
+test_files: []