new_relic-starter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 071bbc4b2947e8e8c3cd27bd000aa0681125cd47
+  data.tar.gz: 9a36ca48347142dfe955b7dd4616afc568f1c0ee
+SHA512:
+  metadata.gz: b44dd21f7b242fe05d92950cbabc3ad4228ed03a5573596eae07c9486b113817730fcd517b0031b870d330d84ac8362172f4c4526de4de0db110292334fe3b82
+  data.tar.gz: 6052fe1c0a8c71cb4abd48fa563c0fa21b34f52924abfdd0e23d8448877eac169a4cc150201cb2abef7064f65c4ebc88d0b31769c5d7064c929162dc0377c652

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,124 @@
+# NewRelic::Starter
+
+[![Gem](https://img.shields.io/gem/v/new_relic-starter.svg?style=flat-square)](https://rubygems.org/gems/new_relic-starter)
+[![Travis](https://img.shields.io/travis/kaorimatz/new_relic-starter.svg?style=flat-square)](https://travis-ci.org/kaorimatz/new_relic-starter)
+
+A library that provides a way to start the New Relic agent in a running process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'new_relic-starter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install new_relic-starter
+
+## Usage
+
+### Rack
+
+The gem provides a Rack middleware which provides an endpoint to start the New Relic agent.
+
+```ruby
+# config.ru
+require 'new_relic/starter/rack'
+use NewRelic::Starter::Rack
+```
+
+By default, the middleware uses the path `/_new_relic/start`:
+
+```
+$ curl -s http://localhost:8080/_new_relic/start
+Started the New Relic agent.
+```
+
+You can specify the path of the endpoint using the `path` option:
+
+```ruby
+# config.ru
+require 'new_relic/starter/rack'
+use NewRelic::Starter::Rack, 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 before forking:
+
+```ruby
+$latch = NewRelic::Starter::Latch.new
+
+# config.ru
+require 'new_relic/starter/rack'
+use NewRelic::Starter::Rack, latch: $latch
+```
+
+Or you will need to create a latch backed by a file:
+
+```ruby
+# config.ru
+require 'new_relic/starter/rack'
+use NewRelic::Starter::Rack, latch: NewRelic::Starter::Latch.new("/path/to/latch")
+```
+
+When a latch is backed by a file, you can also have the middleware start the New Relic agent by writing a single byte 1 to the file:
+
+```sh
+$ echo -n -e '\x1' > /path/to/latch
+```
+
+### Rails
+
+You can configure Rails to add the Rack middleware to the middleware stack with the default options by requiring `new_relic/starter/rails.rb`:
+
+```ruby
+# Gemfile
+gem 'new_relic-starter', require: 'new_relic/starter/rails'
+```
+
+If you want to specify options, you can manually configure the middleware:
+
+```ruby
+# config/initializers/new_relic_starter.rb
+Rails.application.config.middleware.use NewRelic::Starter::Rack, path: '/foo'
+```
+
+### Resque
+
+If your Resque worker forks before processing a job, you can add a hook to start the New Relic agent before forking:
+
+```ruby
+starter = NewRelic::Starter.new(NewRelic::Starter::Latch.new("/path/to/latch"))
+Resque.before_fork do
+  starter.start
+end
+```
+
+Then you can have the starter start the New Relic agent by writing a single byte 1 to the file backing the latch:
+
+```sh
+$ echo -n -e '\x1' > /path/to/latch
+```
+
+## 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/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/ext/new_relic_starter/extconf.rb

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

data/ext/new_relic_starter/new_relic_starter.c

@@ -0,0 +1,176 @@
+#include <errno.h>
+#include <fcntl.h>
+#include <sys/file.h>
+#include <sys/mman.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include "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);
+}
+
+static int
+open_latch_file(const char *path)
+{
+    struct stat st;
+
+    int fd = open(path, O_CREAT|O_RDWR, 0666);
+    if (fd == -1) {
+        rb_raise(eError, "failed to open file %s: %s", path, strerror(errno));
+    }
+
+    if (flock(fd, LOCK_EX) == -1) {
+        int e = errno;
+        close(fd);
+        rb_raise(eError, "failed to acquire an advisory lock for %s: %s", path, strerror(e));
+    }
+
+    if (fstat(fd, &st) == -1) {
+        int e = errno;
+        close(fd);
+        rb_raise(eError, "failed to get file status for %s: %s", path, strerror(e));
+    }
+
+    if (st.st_size == 0) {
+        if (write(fd, "", 1) == -1) {
+            int e = errno;
+            close(fd);
+            rb_raise(eError, "failed to write to file %s: %s", path, strerror(e));
+        }
+    }
+
+    if (flock(fd, LOCK_UN) == -1) {
+        int e = errno;
+        close(fd);
+        rb_raise(eError, "failed to release an advisory lock for %s: %s", path, strerror(e));
+    }
+
+    return fd;
+}
+
+/*
+ * call-seq:
+ *    NewRelic::Starter::Latch.new -> latch
+ *    NewRelic::Starter::Latch.new(path) -> latch
+ *
+ * Returns a new {Latch} object.
+ *
+ * The state of the latch is stored in memory mapped by mmap(2) and shared with
+ * a forked process.
+ *
+ * If +path+ is specified, the memory mapping is backed by the file and the
+ * state of the latch is shared with other latches backed by the same file.
+ *
+ *    NewRelic::Starter::Latch.new #=> #<NewRelic::Starter::Latch:0x00007fbecb04f038>
+ *    NewRelic::Starter::Latch.new("/path/to/latch") #=> #<NewRelic::Starter::Latch:0x00007fbec9808010>
+ */
+static VALUE
+latch_initialize(int argc, VALUE *argv, VALUE self)
+{
+    int fd = -1;
+    void *addr;
+
+    char *path = rb_check_arity(argc, 0, 1) ? RSTRING_PTR(argv[0]) : NULL;
+    if (path != NULL) {
+        fd = open_latch_file(path);
+    }
+
+    addr = mmap(NULL, 1, PROT_READ|PROT_WRITE, (fd == -1 ? MAP_ANONYMOUS|MAP_SHARED : MAP_SHARED), fd, 0);
+    if (addr == MAP_FAILED) {
+        int e = errno;
+        close(fd);
+        rb_raise(eError, "failed to create mapping for latch: %s", strerror(e));
+    }
+    close(fd);
+
+    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 = 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 = 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_new_relic_starter(void)
+{
+    VALUE mNewRelic, cStarter, cLatch;
+
+    mNewRelic = rb_define_module("NewRelic");
+    cStarter = rb_define_class_under(mNewRelic, "Starter", rb_cObject);
+    eError = rb_define_class_under(cStarter, "Error", rb_eStandardError);
+
+    /*
+     * Document-class: NewRelic::Starter::Latch
+     *
+     * NewRelic::Starter::Latch indicates whether 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, -1);
+    rb_define_method(cLatch, "open", latch_open, 0);
+    rb_define_method(cLatch, "opened?", latch_opened, 0);
+}

data/ext/new_relic_starter/new_relic_starter.h

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

data/lib/new_relic/starter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'new_relic/agent'
+
+module NewRelic
+  # NewRelic::Starter starts the New Relic agent by calling
+  # {NewRelic::Agent.manual_start}.
+  class Starter
+    # NewRelic::Starter::Error is a base class for errors.
+    class Error < StandardError; end
+
+    autoload :Latch, 'new_relic_starter'
+    autoload :Rack, 'new_relic/starter/rack'
+
+    # Return a new {Starter} object.
+    #
+    # @param latch [NewRelic::Starter::Latch] the latch object
+    # @return [NewRelic::Starter] A new starter object
+    def initialize(latch)
+      @latch = latch
+      @started = false
+    end
+
+    # Starts the new Relic agent if the agent is not started and the latch is
+    # opened.
+    #
+    # @return [Boolean] true if the new Relic agent is started
+    def start
+      return false if @started || !@latch.opened?
+
+      NewRelic::Agent.manual_start
+      @started = true
+    end
+  end
+end

data/lib/new_relic/starter/rack.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'new_relic/agent'
+
+module NewRelic
+  class Starter
+    # NewRelic::Starter::Rack is a Rack middleware that provides an endpoint to
+    # start the New Relic agent.
+    class Rack
+      # Returns a new {Rack} which implements the Rack interface.
+      #
+      # @param app [Object] the Rack application
+      # @param latch [NewRelic::Starter::Latch] the latch object
+      # @param path [String] the path of the endpoint to start the New Relic
+      #   agent
+      # @return [NewRelic::Starter::Rack] A new rack middleware object
+      def initialize(app, latch: Latch.new, path: nil)
+        @app = app
+        @latch = latch
+        @path = path || '/_new_relic/start'
+        @starter = Starter.new(latch)
+      end
+
+      # Opens a latch and start the New Relic agent if the path of the request
+      # matches with the path of the endpoint.
+      #
+      # When the path doesn't match, if a latch is opened, the agent is started
+      # before calling the next application.
+      #
+      # @param env [Hash] the Rack environment
+      # @return [Array] the Rack response
+      def call(env)
+        if env['PATH_INFO'] == @path
+          handle
+        else
+          @starter.start
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def handle
+        @latch.open
+        headers = { 'Content-Type' => 'text/plain' }
+        body = if @starter.start
+                 'Started the New Relic agent.'
+               else
+                 'The New Relic agent is already started.'
+               end
+        [200, headers, [body]]
+      end
+    end
+  end
+end

data/lib/new_relic/starter/rails.rb

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

data/lib/new_relic/starter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module NewRelic
+  class Starter
+    VERSION = '0.1.1'
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: new_relic-starter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Satoshi Matsumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-01 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: benchmark_driver
+  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: 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'
+description: |2
+    A library that provides a way to start the New Relic agent in a running
+    process.
+email:
+- kaorimatz@gmail.com
+executables: []
+extensions:
+- ext/new_relic_starter/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- ext/new_relic_starter/extconf.rb
+- ext/new_relic_starter/new_relic_starter.c
+- ext/new_relic_starter/new_relic_starter.h
+- lib/new_relic/starter.rb
+- lib/new_relic/starter/rack.rb
+- lib/new_relic/starter/rails.rb
+- lib/new_relic/starter/version.rb
+homepage: https://github.com/kaorimatz/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.6.14.3
+signing_key: 
+specification_version: 4
+summary: Start the New Relic agent in a running process.
+test_files: []