fluent-plugin-newrelic-summary 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb1d7b35a023071695c587d10932bebfd592c978
+  data.tar.gz: 54af1a983795b693f809d19538bccbae29139584
+SHA512:
+  metadata.gz: e47d3a9bdfee83471b3abcdd95802b556c63c00574c96c105ba1ce4c99b7c5f64ddfb42ca59a0a54a6c7a2918e5c03f3fcf188e9d3ce8c9a9ea4643c290f41c5
+  data.tar.gz: c1062e83171a82e42cfea8c4ad8fbdeac55281b4945dbb0904ddfa951f7975e346dd87f99ca6467d0df5281a7f55148f682cc202b155c3e28b7cbd0ae157dbfe

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-newrelic-summary.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# fluent-plugin-newrelic-summary
+
+Fluentd input plugin to receive NewRelic summary data.
+
+Please visit below link for the specification of NewRelic summary API.
+https://docs.newrelic.com/docs/apis/rest-api-v2/application-examples-v2/summary-data-examples-v2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-newrelic-summary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-newrelic-summary
+
+## Usage
+
+The following is an example of configuration.
+
+```
+<source>
+  type newrelic_summary
+  api_key xxxxxxxxx
+  interval 60 # sec. default is 60 sec.
+  summary applications|servers|key_transactions
+</source>
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/hiroakis/fluent-plugin-newrelic-summary/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 new Pull Request
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-newrelic-summary.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-newrelic-summary"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Hiroaki Sano"]
+  spec.email         = ["hiroaki.sano.9stories@gmail.com"]
+
+  spec.summary       = %q{Fluent input plugin to get NewRelic application summary.}
+  spec.homepage      = "https://github.com/hiroakis/fluent-plugin-newrelic-summary"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/in_newrelic_summary.rb

@@ -0,0 +1,75 @@
+require 'net/https'
+
+module Fluent
+  class NewRelicSummaryInput < Input
+    Plugin.register_input('newrelic_summary', self)
+
+    NEW_RELIC_API_DOMAIN = 'api.newrelic.com'
+    SUMMARIES = %w(applications servers key_transactions)
+
+    config_param :tag, :string, :default => nil
+    config_param :api_key, :string, :defaut => nil, :secret => true
+    config_param :summary, :string, :default => "applications"
+    config_param :interval, :integer, :default => 60 # sec
+
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    def initialize
+      super
+    end
+
+    def configure(conf)
+      log.trace "in_newrelic_summary: configure"
+      super
+
+      if @tag.nil?
+        raise Fluent::ConfigError, "newrelic_summary: 'tag' parameter is required"
+      end
+      unless SUMMARIES.include?(@summary)
+        raise Fluent::ConfigError, "newrelic_summary: no such 'summary' parameter. summary should be applications, servers or key_transactions"
+      end
+    end
+
+    def start
+      log.trace "in_newrelic_summary: start"
+      super
+
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      log.trace "in_newrelic_summary: shutdown"
+      super
+
+      Thread.kill(@thread)
+    end
+
+    def run
+      log.trace "in_newrelic_summary: run"
+
+      loop do
+        http = Net::HTTP.new(NEW_RELIC_API_DOMAIN, 443)
+        http.use_ssl = true
+        uri = "/v2/#{@summary}.json"
+        req = Net::HTTP::Get.new(uri)
+        req["NewRelic-Api-Key"] = @api_key
+        res = http.request(req)
+
+        case res
+        when Net::HTTPSuccess
+          emit_data(JSON.parse(res.body))
+        else
+          log.error "in_newrelic_summary: error"
+        end
+        sleep @interval
+      end
+    end # The end of run method
+
+    def emit_data(data)
+      log.trace "in_newrelic_summary: emit_data"
+      Engine.emit("#{tag}", Engine.now, data)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/in_newrelic_summary'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_in_newrelic_summary.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+class NewRelicSummaryTest < Test::Unit::TestCase
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    type newrelic_summary
+    api_key NEWRELIC_API_KEY
+    interval 5
+    summary applications
+    tag newrelic.summary
+  ]
+
+  def create_driver(conf=CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::NewRelicSummaryInput, tag).configure(conf)
+  end
+
+  def test_configuration
+    d = create_driver
+    assert_equal 'NEWRELIC_API_KEY', d.instance.api_key
+    assert_equal 5, d.instance.interval
+    assert_equal 'applications', d.instance.summary
+    assert_equal 'newrelic.summary', d.instance.tag
+  end
+
+  def test_configuration_with_empty_tag
+    assert_raise(Fluent::ConfigError) {
+      create_driver %[
+        type newrelic_summary
+        api_key NEWRELIC_API_KEY
+        interval 5
+        summary applications
+        # tag newrelic.summary
+      ]
+    }
+  end
+
+  def test_configuration_with_unknown_summary
+    assert_raise(Fluent::ConfigError) {
+      create_driver %[
+        type newrelic_summary
+        api_key NEWRELIC_API_KEY
+        interval 5
+        summary XXXXXXX
+        tag newrelic.summary
+      ]
+    }
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-newrelic-summary
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hiroaki Sano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
+dependencies:
+- !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: test-unit
+  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: fluentd
+  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'
+description: 
+email:
+- hiroaki.sano.9stories@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- fluent-plugin-newrelic-summary.gemspec
+- lib/fluent/plugin/in_newrelic_summary.rb
+- test/helper.rb
+- test/plugin/test_in_newrelic_summary.rb
+homepage: https://github.com/hiroakis/fluent-plugin-newrelic-summary
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Fluent input plugin to get NewRelic application summary.
+test_files:
+- test/helper.rb
+- test/plugin/test_in_newrelic_summary.rb