rack-new_relic-starter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a92bf7276cf3556cc58b9bce14030442760e7a56
+  data.tar.gz: 8c662495b54eec1d6315512432ca70966378669a
+SHA512:
+  metadata.gz: 79d7305e748ec6ff0a566034e6e958709676d0566f117b9f196f44b34d119f451f3acd19a2fe32211f1038aa486d05123b888023c42bd332d1ecf8a5273dd045
+  data.tar.gz: 4e859d5af5b9611587c02f26d944bf8072f7d800887ab3da13036823d7f5426a7929d1c67b217438cfbb19b78f99be5c4b370b20eee66e00b9ea7cd4dc403676

data/.gitignore

@@ -0,0 +1,8 @@
+/.rspec_status
+/.yardoc/
+/Gemfile.lock
+/coverage/
+/doc/
+/lib/rack_new_relic_starter.bundle
+/log/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.3.8

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-new_relic-starter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Satoshi Matsumoto
+
+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,84 @@
+# Rack::NewRelic::Starter
+
+[![Gem](https://img.shields.io/gem/v/rack-new_relic-starter.svg?style=flat-square)](https://rubygems.org/gems/rack-new_relic-starter)
+[![Travis](https://img.shields.io/travis/kaorimatz/rack-new_relic-starter.svg?style=flat-square)](https://travis-ci.org/kaorimatz/rack-new_relic-starter)
+
+A Rack middleware that provides an endpoint to start the New Relic agent.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-new_relic-starter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-new_relic-starter
+
+## Usage
+
+By default, the middleware uses the path `/_new_relic/start` to provide an endpoint to start the New Relic agent:
+
+```ruby
+# config.ru
+require 'rack/new_relic/starter'
+use Rack::NewRelic::Starter
+```
+
+You can specify the path of the endpoint using the `path` option:
+
+```ruby
+# config.ru
+require 'rack/new_relic/starter'
+use Rack::NewRelic::Starter, path: '/foo'
+```
+
+If your Rack web server is a pre-forking web server and doesn't load the Rack application before forking, you will need to create a global latch object before forking:
+
+```ruby
+$latch = Rack::NewRelic::Starter::Latch.new
+
+# config.ru
+require 'rack/new_relic/starter'
+use Rack::NewRelic::Starter, latch: $latch
+```
+
+### Rails
+
+You can configure Rails to add the middleware to the middleware stack with the default options by requiring `rack/new_relic/starter/rails.rb`:
+
+```ruby
+# Gemfile
+gem 'rack-new_relic-starter', require: 'rack/new_relic/starter/rails'
+```
+
+If you need to specify options, you can manually configure the middleware:
+
+```ruby
+# config/initializers/rack_new_relic_starter.rb
+Rails.application.config.middleware.use Rack::NewRelic::Starter, path: '/foo'
+```
+
+## Development
+
+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 https://github.com/kaorimatz/rack-new_relic-starter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+The idea of starting the New Relic agent using the Rack middleware is borrowed from [partiarelic](https://github.com/wata-gh/partiarelic).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('rack_new_relic_starter')
+
+task build: :compile
+task default: %i[clobber compile spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rack/new_relic/starter'
+
+# 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(__FILE__)

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/example/config.ru

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rack/new_relic/starter'
+use Rack::NewRelic::Starter
+run ->(_) { [200, { 'Content-Type' => 'text/plain' }, ['OK']] }

data/example/unicorn.conf.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+worker_processes 2
+preload_app true

data/ext/rack_new_relic_starter/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+create_makefile('rack_new_relic_starter')

data/ext/rack_new_relic_starter/rack_new_relic_starter.c

@@ -0,0 +1,116 @@
+#include <errno.h>
+#include <sys/mman.h>
+#include <unistd.h>
+#include "rack_new_relic_starter.h"
+
+VALUE eError;
+
+static void
+latch_free(void *ptr)
+{
+    munmap(ptr, 1);
+}
+
+static size_t
+latch_size(const void *ptr)
+{
+    return sysconf(_SC_PAGE_SIZE);
+}
+
+static const rb_data_type_t latch_data_type = {
+    "latch",
+    { NULL, latch_free, latch_size, },
+    0, 0, RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE
+latch_s_allocate(VALUE klass)
+{
+    return TypedData_Wrap_Struct(klass, &latch_data_type, 0);
+}
+
+/*
+ * call-seq:
+ *    Rack::NewRelic::Starter::Latch.new -> latch
+ *
+ * Returns a new {Latch} object.
+ *
+ *    Rack::NewRelic::Starter::Latch.new #=> #<Rack::NewRelic::Starter::Latch:0x00007f9a2db15890>
+ */
+static VALUE
+latch_initialize(VALUE self)
+{
+    void *addr = mmap(NULL, 1, PROT_READ|PROT_WRITE, MAP_ANONYMOUS|MAP_SHARED, -1, 0);
+    if (addr == MAP_FAILED) {
+        rb_raise(eError, "failed to create mapping for latch: %s", strerror(errno));
+    }
+
+    DATA_PTR(self) = addr;
+
+    return self;
+}
+
+static inline uint8_t *
+check_latch(VALUE self)
+{
+      return rb_check_typeddata(self, &latch_data_type);
+}
+
+/*
+ * call-seq:
+ *    latch.open! -> nil
+ *
+ * Opens the latch.
+ *
+ *    latch = Rack::NewRelic::Starter::Latch.new
+ *    latch.opened? #=> false
+ *    latch.open!
+ *    latch.opened? #=> true
+ */
+static VALUE
+latch_open(VALUE self)
+{
+    uint8_t *l = check_latch(self);
+    *l = 1;
+    return Qnil;
+}
+
+/*
+ * call-seq:
+ *    latch.opened? -> boolean
+ *
+ * Returns true if the latch is opened.
+ *
+ *    latch = Rack::NewRelic::Starter::Latch.new
+ *    latch.opened? #=> false
+ *    latch.open!
+ *    latch.opened? #=> true
+ */
+static VALUE
+latch_opened(VALUE self)
+{
+    return *check_latch(self) == 1 ? Qtrue : Qfalse;
+}
+
+void
+Init_rack_new_relic_starter(void)
+{
+    VALUE mRack, mNewRelic, cStarter, cLatch;
+
+    mRack = rb_define_module("Rack");
+    mNewRelic = rb_define_module_under(mRack, "NewRelic");
+    cStarter = rb_define_class_under(mNewRelic, "Starter", rb_cObject);
+    eError = rb_define_class_under(cStarter, "Error", rb_eStandardError);
+
+    /*
+     * Document-class: Rack::NewRelic::Starter::Latch
+     *
+     * Rack::NewRelic::Starter::Latch is an object to indicate that the New
+     * Relic agent should be started.
+     */
+    cLatch = rb_define_class_under(cStarter, "Latch", rb_cObject);
+    rb_define_alloc_func(cLatch, latch_s_allocate);
+    rb_define_method(cLatch, "initialize", latch_initialize, 0);
+    rb_define_method(cLatch, "open!", latch_open, 0);
+    rb_define_method(cLatch, "opened?", latch_opened, 0);
+}

data/ext/rack_new_relic_starter/rack_new_relic_starter.h

@@ -0,0 +1,6 @@
+#ifndef RACK_NEW_RELIC_STARTER_H
+#define RACK_NEW_RELIC_STARTER_H 1
+
+#include "ruby.h"
+
+#endif /* RACK_NEW_RELIC_STARTER_H */

data/lib/rack/new_relic/starter.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'new_relic/agent'
+require 'rack/body_proxy'
+
+module Rack
+  module NewRelic
+    # Rack::NewRelic::Starter is a Rack middleware that provides an endpoint to
+    # start the New Relic agent.
+    class Starter
+      # Rack::NewRelic::Starter::Error is a base class for errors raised by
+      # {Starter} and {Latch}.
+      class Error < StandardError; end
+
+      autoload :Latch, 'rack_new_relic_starter'
+
+      # Returns a new {Starter} which implements the Rack interface.
+      #
+      # @param app [Object] the Rack application
+      # @param latch [Rack::NewRelic::Starter::Latch] the latch object
+      # @param path [String] the path of the endpoint to start the New Relic
+      #   agent
+      # @return [Rack::NewRelic::Starter] A new starter object
+      def initialize(app, latch: Latch.new, path: nil)
+        @app = app
+        @latch = latch
+        @path = path || '/_new_relic/start'
+        @started = false
+      end
+
+      # Starts the New Relic agent if the path of the request matches with the
+      # path of the endpoint or the latch is opened.
+      #
+      # @param env [Hash] the Rack environment
+      # @return [Array] the Rack response
+      def call(env)
+        start! if !@started && @latch.opened?
+
+        if env['PATH_INFO'] == @path
+          handle
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def handle
+        if @started
+          headers = { 'Content-Type' => 'text/plain' }
+          [200, headers, ['The New Relic agent is already started.']]
+        else
+          @latch.open!
+          start!
+          headers = { 'Content-Type' => 'text/plain' }
+          [200, headers, ['Started the New Relic agent.']]
+        end
+      end
+
+      def start!
+        ::NewRelic::Agent.manual_start
+        @started = true
+      end
+    end
+  end
+end

data/lib/rack/new_relic/starter/rails.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rack/new_relic/starter'
+
+module Rack
+  module NewRelic
+    class Starter
+      # Rack::NewRelic::Starter::Railtie implements a railtie which creates an
+      # initializer to add the middleware to the middleware stack with the
+      # default options.
+      class Railtie < Rails::Railtie
+        initializer 'rack-new_relic-starter.middleware' do |app|
+          app.middleware.use Rack::NewRelic::Starter
+        end
+      end
+    end
+  end
+end

data/lib/rack/new_relic/starter/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rack
+  module NewRelic
+    class Starter
+      VERSION = '0.1.0'
+    end
+  end
+end

data/rack-new_relic-starter.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/new_relic/starter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-new_relic-starter'
+  spec.version       = Rack::NewRelic::Starter::VERSION
+  spec.authors       = ['Satoshi Matsumoto']
+  spec.email         = ['kaorimatz@gmail.com']
+
+  spec.summary       = 'A Rack middleware to start the New Relic agent.'
+  spec.description   = <<-DESCRIPTION
+  A Rack middleware that provides an endpoint to start the New Relic agent.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/kaorimatz/rack-new_relic-starter'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  end
+  spec.require_paths = ['lib']
+  spec.extensions    = ['ext/rack_new_relic_starter/extconf.rb']
+
+  spec.add_runtime_dependency 'newrelic_rpm'
+  spec.add_runtime_dependency 'rack'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'unicorn'
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: rack-new_relic-starter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Satoshi Matsumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicorn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "  A Rack middleware that provides an endpoint to start the New Relic
+  agent.\n"
+email:
+- kaorimatz@gmail.com
+executables: []
+extensions:
+- ext/rack_new_relic_starter/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/config.ru
+- example/unicorn.conf.rb
+- ext/rack_new_relic_starter/extconf.rb
+- ext/rack_new_relic_starter/rack_new_relic_starter.c
+- ext/rack_new_relic_starter/rack_new_relic_starter.h
+- lib/rack/new_relic/starter.rb
+- lib/rack/new_relic/starter/rails.rb
+- lib/rack/new_relic/starter/version.rb
+- rack-new_relic-starter.gemspec
+homepage: https://github.com/kaorimatz/rack-new_relic-starter
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: A Rack middleware to start the New Relic agent.
+test_files: []