newrelic_logger_extension 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47b4bac116ae08eddbd49abfb642f504bd857322
+  data.tar.gz: 690e8dcec9f206835fcbd13938ded8587074f048
+SHA512:
+  metadata.gz: 5801bded28b2c026fc4895f5e6fffcc450a0821192b8b22bd81617739c571cc606afdb562268a48f41ad27a8cbf719473bf4664d53bed97cd2192f3444eb2da6
+  data.tar.gz: 0d8c898bceee4ce13b6ccce55095a3a3370f98c9fd63d885c27b5a6d226264ec67d868ef90d10347686cf52c01b963e885570cdf5a9443dbd160c67300f225f9

data/.codeqa.rb

@@ -0,0 +1,16 @@
+Codeqa.configure do |config|
+  config.excludes = ['coverage/*',
+                     'pkg/*']
+
+  config.enabled_checker.delete 'CheckRubySyntax'
+  config.enabled_checker << 'RubocopLint'
+  config.enabled_checker << 'RubocopFormatter'
+
+  config.rubocop_formatter_cops << 'AlignHash'
+  config.rubocop_formatter_cops << 'SignalException'
+  config.rubocop_formatter_cops << 'DeprecatedClassMethods'
+  config.rubocop_formatter_cops << 'RedundantBegin'
+  config.rubocop_formatter_cops << 'RedundantSelf'
+  config.rubocop_formatter_cops << 'RedundantReturn'
+  config.rubocop_formatter_cops << 'CollectionMethods'
+end

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+
+Metrics/LineLength:
+  Max: 99
+
+Style/Documentation:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false
+Style/PerlBackrefs:
+  Enabled: false
+

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newrelic_logger_extension.gemspec
+gemspec
+
+group :development do
+  gem 'rubocop', require: false
+  gem 'codeqa', require: false
+
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rb-inotify', require: false
+end
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
+end

data/Guardfile

@@ -0,0 +1,20 @@
+notification :tmux,
+             display_message: true,
+             timeout: 3 # in seconds
+
+# ignore /doc/
+
+group :red_green_refactor, halt_on_fail: true do
+  guard 'rspec', cmd: 'bundle exec rspec --color --format p', all_after_pass: true do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})               { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')            { 'spec' }
+    watch(%r{^spec/support/(.+)\.rb})       { 'spec' }
+    watch(%r{^spec/fixtures/(.+)})          { 'spec' }
+  end
+
+  guard :rubocop, cli: %w(--display-cop-names --auto-correct) do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andreas Eger
+
+MIT License
+
+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,42 @@
+# Newrelic Logger Extension
+
+patch a logger instance to send a specified servity level as custom metric to
+newrelic. The original logger handling is kept unchanged.
+
+The login message is not send to newrelic only the location where the logging
+happend is sent.
+
+Also keep in mind that newrelic as a limit of ~2000 custom metrics which means
+if you have to many locations where logging happend this might become an issue.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'newrelic_logger_extension'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+to use this in for example an Rails application, first make sure newrelic is
+setup and then create a new initilizer like this
+
+``` ruby
+%w(info warn error).each do |level|
+  NewrelicLoggerExtension.inject_logger(Rails.logger, level)\
+end
+```
+
+This will add the newrelic custom metric logging to the servity level `info`,
+`warn` and `error`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/newrelic_logger_extension/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+
+desc 'Run all specs'
+task :specs do
+  opts = %w(rspec -c)
+  opts += ['--require', File.join(File.dirname(__FILE__), 'spec', 'spec_helper')]
+  # opts += ['-I', YARD::ROOT]
+  if ENV['DEBUG']
+    $DEBUG = true
+    opts += ['-d']
+  end
+  opts += FileList['spec/**/*_spec.rb'].sort
+  cmd = opts.join(' ')
+  puts cmd if Rake.application.options.trace
+  system(cmd)
+  fail "Command failed with status (#{$CHILD_STATUS.to_i}): #{cmd}" if $CHILD_STATUS.to_i != 0
+end
+task spec: :specs
+task default: :specs

data/lib/newrelic_logger_extension.rb

@@ -0,0 +1,35 @@
+require 'newrelic_logger_extension/version'
+# require 'newrelic_rpm'
+
+module NewrelicLoggerExtension
+  SEPARATOR = '__'
+  def self.inject_logger(logger, level = 'warn')
+    return unless logger.respond_to? level.to_sym
+    inject_servity_method(logger, level)
+    inject_shared_methods(logger) unless logger.respond_to? :log_to_newrelic
+  end
+  def self.inject_servity_method(logger, level)
+    logger.singleton_class.class_eval do
+      define_method("#{level}_with_newrelic") do |*args|
+        send("#{level}_without_newrelic", *args)
+        log_to_newrelic("#{level.capitalize}", caller_locations(1).first)
+      end
+
+      alias_method "#{level}_without_newrelic", level
+      alias_method level, "#{level}_with_newrelic"
+    end
+  end
+  def self.inject_shared_methods(logger)
+    logger.singleton_class.class_eval do
+      def log_to_newrelic(category, kaller)
+        ::NewRelic::Agent.increment_metric("Custom/#{category}/#{format_caller(kaller)}")
+      end
+
+      def format_caller(kaller)
+        (kaller.path.split(/\/|\./)[-4..-2] << kaller.lineno).join(SEPARATOR)
+      rescue
+        File.basename(kaller.path)
+      end
+    end
+  end
+end

data/lib/newrelic_logger_extension/version.rb

@@ -0,0 +1,3 @@
+module NewrelicLoggerExtension
+  VERSION = '0.0.1'
+end

data/newrelic_logger_extension.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'newrelic_logger_extension/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'newrelic_logger_extension'
+  spec.version       = NewrelicLoggerExtension::VERSION
+  spec.authors       = ['Andreas Eger']
+  spec.email         = ['andreas.eger@experteer.com']
+  spec.summary       = 'extend Logger instance with newrelic custom metrics'
+  spec.description   = <<-EOS
+extend a Logger instance to send warnings, errors and info to newrelic as
+custom metric
+EOS
+  spec.homepage      = 'https://www.github.com/experteer/newrelic_logger_extension'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'newrelic_rpm', '>= 3.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>=3.0'
+end

data/spec/lib/newrelic_logger_extension_spec.rb

@@ -0,0 +1,34 @@
+require 'logger'
+
+module NewRelic
+end
+describe NewrelicLoggerExtension do
+  SPEC_LOG_PATH = 'tmp/newrelic_logger_extension_spec.log'
+  let(:logger) { Logger.new(SPEC_LOG_PATH) }
+  after(:each) do
+    File.delete(SPEC_LOG_PATH)
+    ::NewRelic.send(:remove_const, 'Agent')
+  end
+
+  before(:each) do
+    ::NewRelic::Agent = double('Agent', increment_metric: true)
+    NewrelicLoggerExtension.inject_logger(logger, 'warn')
+  end
+
+  it 'should not interfere with the actuall logging' do
+    logger.warn('test warning')
+    filelog = IO.read(SPEC_LOG_PATH)
+    expect(filelog).to match 'WARN -- :'
+    expect(filelog).to match 'test warning'
+  end
+  it 'should call :increment_metric on the NewRelic::Agent' do
+    expect(::NewRelic::Agent).to receive(:increment_metric)
+    logger.warn('test warning')
+  end
+  it 'should call correctly set the custom metric nameing' do
+    expect(::NewRelic::Agent)
+      .to receive(:increment_metric)
+         .with('Custom/Warn/spec__lib__newrelic_logger_extension_spec__32')
+    logger.warn('test warning') # this is line 32
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler.setup
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+Bundler.require(:default, :test)
+
+require 'newrelic_logger_extension'
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end
+# Dir['./spec/support/**/*.rb'].sort.each{ |f| require f }

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_logger_extension
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andreas Eger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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: |
+  extend a Logger instance to send warnings, errors and info to newrelic as
+  custom metric
+email:
+- andreas.eger@experteer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeqa.rb"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/newrelic_logger_extension.rb
+- lib/newrelic_logger_extension/version.rb
+- newrelic_logger_extension.gemspec
+- spec/lib/newrelic_logger_extension_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/experteer/newrelic_logger_extension
+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.2.2
+signing_key: 
+specification_version: 4
+summary: extend Logger instance with newrelic custom metrics
+test_files:
+- spec/lib/newrelic_logger_extension_spec.rb
+- spec/spec_helper.rb