librato-rack-source_prefix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b89c225d590caae55fe2331da1a38e1bd26614b3
+  data.tar.gz: 4e6897ef7acfcd61efdda147d7874c6ee6cd6494
+SHA512:
+  metadata.gz: c9157e4412da883869c7a03171e7ffc275e36204d8304bfd9782d7c729d2a9ec883930b2f4ac440b11c3b02b603967815e8d2dfae40f9955deab45c46ccbf04b
+  data.tar.gz: d7d655be87cfb336717ae6ed5838cc5cb15f4ed16f50a5acbccf957a9c872e83b8daf11701f5e2ded66be0b16326c9b5dfacea39bc548ddd13c037f4bf4bfa79

data.tar.gz.sig

@@ -0,0 +1,2 @@
+dQ@M����b�:Z�`U��jV�C���UQ�U���2����%r�W���|�=RR
+�t�k��7�vCO���˳�%$��!�&�W�R�-�� �a���(�u��SV��!�W,���H�,bR6�9R�_ơ��^��z��L�x��|

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### Version 0.1.0
+* Initial release

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012. Librato, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL LIBRATO, INC. BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,75 @@
+# librato-rack-source_prefix
+
+This gem enables the automatic prefixing of metric source names. 
+
+By default, when you submit a metric with a custom source, that source will be passed as-is to the Librato API. For example:
+
+```ruby
+Librato.increment :foo, source: 'some_action'
+```
+
+The code above would result in the following data being POSTed to the Librato API:
+
+```json
+{
+  "gauges": [ 
+    {
+      "name": "foo",
+      "value": 1, 
+      "source": "some_action"
+    }
+  ]
+}
+```
+
+Note that the *source* passed to the API is identical to the value specified in the `increment` call. Even if you had configured a global *source* value (either via the `LIBRATO_SOURCE` environment variable or the *librato.yml* configuration file) the global *source* value is ignored completely.
+
+If you were to configure a global source value of `myapp` and install the *librato-rack-source_prefix* gem, the same code shown above would result in the following data being POSTed:
+
+```json
+{
+  "gauges": [ 
+    {
+      "name": "foo",
+      "value": 1, 
+      "source": "myapp.some_action"
+    }
+  ]
+}
+```
+
+In this case, the *source* value specified as part of the `increment` call is automatically prefixed with the global source `myapp`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'librato-rack-source_prefix'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install librato-rack-source_prefix
+
+### Rack Applications
+
+If your application is using a non-Rails, Rack framework you'll need to add the following line to your app in order to enable the source prefixing behavior:
+
+```ruby
+  Librato::Collector.include(Librato::Rack::SourcePrefix::Extensions::Collector)
+```
+
+You'll want to add this line wherever you've configured your `Librato::Rack` middleware.
+
+### Rails
+
+If you are using Rails, source prefixing will be enabled automatically as a result of adding the *librato-rack-source_prefix* gem to your Gemfile. No additional configuration is required.
+
+## Copyright
+
+Copyright (c) 2015 [Librato Inc.](http://librato.com) See LICENSE for details.

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+task 'before_build' do
+  signing_key = File.expand_path("~/.gem/librato-private_key.pem")
+  if File.exists?(signing_key)
+    puts "Key found: signing gem..."
+    ENV['GEM_SIGNING_KEY'] = signing_key
+  else
+    puts "WARN: signing key not found, gem not signed"
+  end
+end
+task :build => :before_build
+
+require "bundler/gem_tasks"
+
+# Testing
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task :default => :test

data/lib/librato-rack-source_prefix.rb

@@ -0,0 +1,5 @@
+require 'librato/rack/source_prefix/extensions/collector'
+
+if defined?(Rails)
+  require 'librato/rack/source_prefix/railtie'
+end

data/lib/librato/rack/source_prefix/extensions/collector.rb

@@ -0,0 +1,74 @@
+module Librato::Rack::SourcePrefix
+  module Extensions
+    module Collector
+
+      def self.included(klass)
+        # Explicitly removing methods that we intend to override. This is
+        # necessary so that the methods in our module will be used when
+        # they're mixed-in to the real Collector class. Typically you wouldn't
+        # do this, but since the methods we're overriding are just delegates
+        # to other objects, we can safely remove the methods and call the
+        # underlying objects directly from our new implementations.
+        [:increment, :measure, :timing].each do |method|
+          if klass.instance_methods(false).include?(method)
+            klass.send(:remove_method, method)
+          end
+        end
+      end
+
+      def increment(counter, options={})
+        if prefix_needed?(options)
+          options[:source] = apply_prefix(options[:source])
+        end
+
+        counters.increment(counter, options)
+      end
+
+      def measure(*args, &block)
+        # If there are options
+        if args.length > 1 and args[-1].respond_to?(:each)
+          options = args[-1]
+
+          if prefix_needed?(options)
+            options[:source] = apply_prefix(options[:source])
+          end
+        end
+
+        aggregate.measure(*args, &block)
+      end
+      alias :timing :measure
+
+      private
+
+      def prefix_needed?(options)
+        if options[:apply_prefix].nil?
+          apply_prefix = true
+        else
+          apply_prefix = options.delete(:apply_prefix)
+        end
+
+        apply_prefix &&
+          options[:source] &&
+          global_source &&
+          !global_source.empty?
+      end
+
+      def apply_prefix(source)
+        if source_pids
+          "#{global_source}.#{$$}.#{source}"
+        else
+          "#{global_source}.#{source}"
+        end
+      end
+
+      def global_source
+        Librato.tracker.config.source
+      end
+
+      def source_pids
+        Librato.tracker.config.source_pids
+      end
+    end
+  end
+end
+

data/lib/librato/rack/source_prefix/railtie.rb

@@ -0,0 +1,10 @@
+module Librato::Rack::SourcePrefix
+  class Railtie < ::Rails::Railtie
+
+    initializer 'librato.rack.source_prefix.extensions' do
+      Librato::Collector.include(
+        Librato::Rack::SourcePrefix::Extensions::Collector
+      )
+    end
+  end
+end

data/lib/librato/rack/source_prefix/version.rb

@@ -0,0 +1,7 @@
+module Librato
+  class Rack
+    module SourcePrefix
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: librato-rack-source_prefix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian DeHamer
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDLjCCAhagAwIBAgIBADANBgkqhkiG9w0BAQUFADA9MQ0wCwYDVQQDDARtYXR0
+  MRcwFQYKCZImiZPyLGQBGRYHbGlicmF0bzETMBEGCgmSJomT8ixkARkWA2NvbTAe
+  Fw0xNTEwMTIyMjA0MzVaFw0xNjEwMTEyMjA0MzVaMD0xDTALBgNVBAMMBG1hdHQx
+  FzAVBgoJkiaJk/IsZAEZFgdsaWJyYXRvMRMwEQYKCZImiZPyLGQBGRYDY29tMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvfN8RlAsUs+K5kK46SkhpYey
+  54m5bXlGZeqIguOygpG+2FJrUJMCnkQ9RmyK0WUjdmANevW01caQQSx5WatQZso0
+  GfJyJfKn4dGecz9LOEPpblw++qapLXr4vbuOlNXsum2gdUFc4/YV9l3csxClMVEq
+  +ZUmrHjd2koOvzjK+GDRf3iIozCsgY0oeserZ0li/0qRA5ZJeFwWzs9FO9SXPvID
+  Mk07WNaXSRT38llcPGX4L8K+DL7whQwxaFj6IZbobUEtRjzV9v/iP7PiJipijbKB
+  EiefgUuolRR38NxQE+f4M/lEqwEpkY/feYMYF6Q4hXVruG3fswjrDGWyiG5nEQID
+  AQABozkwNzAJBgNVHRMEAjAAMB0GA1UdDgQWBBR8+l0ZSTbj/TT6YVbFFpdGpg7q
+  UDALBgNVHQ8EBAMCBLAwDQYJKoZIhvcNAQEFBQADggEBAKuUiuG2PHv6paQjXjaZ
+  LQOsFunScHyhDhPFh/CcCUDbmXVDOJ3WIyDVQuUgK7I3jPEDaSFezSPBpjwZvgMK
+  0/in7pXLRKjI8CzsY8Y4u122DN9tBxLur+E/kv5fpUbf8FGUSuRT5X3wh6ZBTzsZ
+  EaMe3LpPFUeMShH/H/FEYrexRvaMHo/52Bg0zP0ySSAQDotm+qgMdru2XRDjE5Ms
+  9BheAnoygGHpoKWtExpsklCppL1q2Xlzw2lhoCMLCSSj9T/YyRTL3UQYoK5pPA76
+  hvjx0WJP8pzZMJPKJBRZQXJO5ifEPyKjZyMi5XMHmrtDclHLj3sx4RAvEZjGWkRP
+  JSQ=
+  -----END CERTIFICATE-----
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: librato-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: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: Applies a source prefix to any custom source names supplied when submitting
+  metrics
+email:
+- brian@librato.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/librato-rack-source_prefix.rb
+- lib/librato/rack/source_prefix/extensions/collector.rb
+- lib/librato/rack/source_prefix/railtie.rb
+- lib/librato/rack/source_prefix/version.rb
+homepage: https://github.com/librato/librato-rack-source_prefix
+licenses:
+- BSD 3-clause
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Automatic source prefixing for librato-rack
+test_files: []