logstash-output-graphtastic 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmY2OWQ5YmJiMWNlNTRmMDcxNjBkZTg1MjJkZDUzZjhjN2E4MGYyNA==
+  data.tar.gz: !binary |-
+    MWRiZTc5OThhMWI1N2YyMjIwM2JlOGZhNWIyODExNjVkNWE5ZmVlYQ==
+SHA512:
+  metadata.gz: !binary |-
+    OTdiZTIwM2ZkNTAyMzFkMTQzNDBhYzM4NzE4MmUyYjk0MDhhYTIwNDU1ZDhj
+    ZDk2NzUwNjNiYjYyZDY0MWI1YTIzYjQ5MjI4NDhiMzQxMjcyMWJkNmU0ODY4
+    YTA1YTQ0NDczMmE2NmMwNTlkN2E3YjYxYjllZmIzZmFhNDMxZjA=
+  data.tar.gz: !binary |-
+    NGFjNWMzNjI1ZGE0OGQzOWYwMzBkMzdlYWIzZjY2ZWNlNmUzZDRkODNiODdm
+    YmE3MWJmODk5YjIyZmNhYTNkNjNmNWVmNDcyMWE0ODQzMjRmZDk0NmIwMDQ2
+    NjUyZWYwMDYzMzA0NTgxNDBmMjgxZDAwMGU1MGVjMmEwMDdhOTQ=

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+.bundle
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+gem 'rake'
+gem 'gem_publisher'
+gem 'archive-tar-minitar'

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,6 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+

data/lib/logstash/outputs/graphtastic.rb

@@ -0,0 +1,186 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+
+# A plugin for a newly developed Java/Spring Metrics application
+# I didn't really want to code this project but I couldn't find
+# a respectable alternative that would also run on any Windows
+# machine - which is the problem and why I am not going with Graphite
+# and statsd.  This application provides multiple integration options
+# so as to make its use under your network requirements possible. 
+# This includes a REST option that is always enabled for your use
+# in case you want to write a small script to send the occasional 
+# metric data. 
+#
+# Find GraphTastic here : https://github.com/NickPadilla/GraphTastic
+class LogStash::Outputs::GraphTastic < LogStash::Outputs::Base
+  
+  config_name "graphtastic"
+  milestone 2
+  
+  # options are udp(fastest - default) - rmi(faster) - rest(fast) - tcp(don't use TCP yet - some problems - errors out on linux)
+  config :integration, :validate => ["udp","tcp","rmi","rest"], :default => "udp"
+  
+  # if using rest as your end point you need to also provide the application url
+  # it defaults to localhost/graphtastic.  You can customize the application url
+  # by changing the name of the .war file.  There are other ways to change the 
+  # application context, but they vary depending on the Application Server in use.
+  # Please consult your application server documentation for more on application
+  # contexts.
+  config :context, :validate => :string, :default => "graphtastic"
+  
+  # metrics hash - you will provide a name for your metric and the metric 
+  # data as key value pairs.  so for example:
+  #
+  # metrics => { "Response" => "%{response}" } 
+  #
+  # example for the logstash config
+  #
+  # metrics => [ "Response", "%{response}" ]
+  #
+  # NOTE: you can also use the dynamic fields for the key value as well as the actual value
+  config :metrics, :validate => :hash, :default => {}
+   
+  # host for the graphtastic server - defaults to 127.0.0.1
+  config :host, :validate => :string, :default => "127.0.0.1"
+  
+  # port for the graphtastic instance - defaults to 1199 for RMI, 1299 for TCP, 1399 for UDP, and 8080 for REST
+  config :port, :validate => :number
+  
+  # number of attempted retry after send error - currently only way to integrate
+  # errored transactions - should try and save to a file or later consumption
+  # either by graphtastic utility or by this program after connectivity is
+  # ensured to be established. 
+  config :retries, :validate => :number, :default => 1
+  
+  # the number of metrics to send to GraphTastic at one time. 60 seems to be the perfect 
+  # amount for UDP, with default packet size. 
+  config :batch_number, :validate => :number, :default => 60
+  
+  # setting allows you to specify where we save errored transactions
+  # this makes the most sense at this point - will need to decide
+  # on how we reintegrate these error metrics
+  # NOT IMPLEMENTED!
+  config :error_file, :validate => :string, :default => ""
+  
+  public
+   def register
+     @batch = []
+     begin
+       if @integration.downcase == "rmi"
+         if RUBY_ENGINE != "jruby"
+            raise Exception.new("LogStash::Outputs::GraphTastic# JRuby is needed for RMI to work!")
+         end
+         require "java"
+         if @port.nil?
+           @port = 1199
+         end
+         registry = java.rmi.registry.LocateRegistry.getRegistry(@host, @port);
+         @remote = registry.lookup("RmiMetricService")
+       elsif @integration.downcase == "rest"
+         require "net/http"         
+         if @port.nil?
+           @port = 8080
+           gem "mail" #outputs/email, # License: MIT License
+         end
+         @http = Net::HTTP.new(@host, @port)
+       end
+       @logger.info("GraphTastic Output Successfully Registered! Using #{@integration} Integration!")
+     rescue 
+       @logger.error("*******ERROR :  #{$!}")
+     end
+   end
+
+  public
+  def receive(event)
+    return unless output?(event)
+    # Set Intersection - returns a new array with the items that are the same between the two
+    if !@tags.empty? && (event["tags"] & @tags).size == 0
+       # Skip events that have no tags in common with what we were configured
+       @logger.debug("No Tags match for GraphTastic Output!")
+       return
+    end
+    @retry = 1
+    @logger.debug("Event found for GraphTastic!", :tags => @tags, :event => event)
+    @metrics.each do |name, metric|
+      postMetric(event.sprintf(name),event.sprintf(metric),(event["@timestamp"]*1000))# unix_timestamp is what I need in seconds - multiply by 1000 to make milliseconds.
+    end
+  end
+  
+  def postMetric(name, metric, timestamp)
+    message = name+","+metric+","+timestamp.to_s
+    if @batch.length < @batch_number
+      @batch.push(message)
+    else
+      flushMetrics()      
+    end    
+  end
+  
+  def flushMetrics()
+    begin
+      if @integration.downcase == "tcp"
+        flushViaTCP()
+      elsif @integration.downcase == "rmi"
+        flushViaRMI() 
+      elsif @integration.downcase == "udp"
+        flushViaUDP()
+      elsif @integration.downcase == "rest"
+        flushViaREST()
+      else
+        @logger.error("GraphTastic Not Able To Find Correct Integration - Nothing Sent - Integration Type : ", :@integration => @integration)
+      end
+      @batch.clear
+    rescue
+      @logger.error("*******ERROR :  #{$!}")
+      @logger.info("*******Attempting #{@retry} out of #{@retries}")
+      while @retry < @retries
+        @retry = @retry + 1
+        flushMetrics()
+      end
+    end
+  end
+  
+  # send metrics via udp
+  def flushViaUDP()
+    if @port.nil?
+     @port = 1399
+    end
+    udpsocket.send(@batch.join(','), 0, @host, @port)
+    @logger.debug("GraphTastic Sent Message Using UDP : #{@batch.join(',')}")
+  end
+  
+  # send metrics via REST
+  def flushViaREST()
+    request = Net::HTTP::Put.new("/#{@context}/addMetric/#{@batch.join(',')}")
+    response = @http.request(request)
+    if response == 'ERROR'
+      raise 'Error happend when sending metric to GraphTastic using REST!'
+    end
+    @logger.debug("GraphTastic Sent Message Using REST : #{@batch.join(',')}", :response => response.inspect)    
+  end
+  
+  # send metrics via RMI
+  def flushViaRMI()
+    if RUBY_ENGINE != "jruby"
+       raise Exception.new("LogStash::Outputs::GraphTastic# JRuby is needed for RMI to work!")
+    end
+    @remote.insertMetrics(@batch.join(','))
+    @logger.debug("GraphTastic Sent Message Using RMI : #{@batch.join(',')}")
+  end
+  
+  # send metrics via tcp
+  def flushViaTCP()
+    # to correctly read the line we need to ensure we send \r\n at the end of every message.
+    if @port.nil?
+      @port = 1299
+    end
+    tcpsocket = TCPSocket.open(@host, @port)
+    tcpsocket.send(@batch.join(',')+"\r\n", 0)
+    tcpsocket.close
+    @logger.debug("GraphTastic Sent Message Using TCP : #{@batch.join(',')}")
+  end
+
+  def udpsocket; @socket ||= UDPSocket.new end
+  
+end

data/logstash-output-graphtastic.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-output-graphtastic'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Send metrics to GraphTastic"
+  s.description     = "Send metrics to GraphTastic"
+  s.authors         = ["Elasticsearch"]
+  s.email           = 'richard.pijnenburg@elasticsearch.com'
+  s.homepage        = "http://logstash.net/"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
+
+end
+

data/rakelib/publish.rake

@@ -0,0 +1,9 @@
+require "gem_publisher"
+
+desc "Publish gem to RubyGems.org"
+task :publish_gem do |t|
+  gem_file = Dir.glob(File.expand_path('../*.gemspec',File.dirname(__FILE__))).first
+  gem = GemPublisher.publish_if_updated(gem_file, :rubygems)
+  puts "Published #{gem}" if gem
+end
+

data/rakelib/vendor.rake

@@ -0,0 +1,169 @@
+require "net/http"
+require "uri"
+require "digest/sha1"
+
+def vendor(*args)
+  return File.join("vendor", *args)
+end
+
+directory "vendor/" => ["vendor"] do |task, args|
+  mkdir task.name
+end
+
+def fetch(url, sha1, output)
+
+  puts "Downloading #{url}"
+  actual_sha1 = download(url, output)
+
+  if actual_sha1 != sha1
+    fail "SHA1 does not match (expected '#{sha1}' but got '#{actual_sha1}')"
+  end
+end # def fetch
+
+def file_fetch(url, sha1)
+  filename = File.basename( URI(url).path )
+  output = "vendor/#{filename}"
+  task output => [ "vendor/" ] do
+    begin
+      actual_sha1 = file_sha1(output)
+      if actual_sha1 != sha1
+        fetch(url, sha1, output)
+      end
+    rescue Errno::ENOENT
+      fetch(url, sha1, output)
+    end
+  end.invoke
+
+  return output
+end
+
+def file_sha1(path)
+  digest = Digest::SHA1.new
+  fd = File.new(path, "r")
+  while true
+    begin
+      digest << fd.sysread(16384)
+    rescue EOFError
+      break
+    end
+  end
+  return digest.hexdigest
+ensure
+  fd.close if fd
+end
+
+def download(url, output)
+  uri = URI(url)
+  digest = Digest::SHA1.new
+  tmp = "#{output}.tmp"
+  Net::HTTP.start(uri.host, uri.port, :use_ssl => (uri.scheme == "https")) do |http|
+    request = Net::HTTP::Get.new(uri.path)
+    http.request(request) do |response|
+      fail "HTTP fetch failed for #{url}. #{response}" if [200, 301].include?(response.code)
+      size = (response["content-length"].to_i || -1).to_f
+      count = 0
+      File.open(tmp, "w") do |fd|
+        response.read_body do |chunk|
+          fd.write(chunk)
+          digest << chunk
+          if size > 0 && $stdout.tty?
+            count += chunk.bytesize
+            $stdout.write(sprintf("\r%0.2f%%", count/size * 100))
+          end
+        end
+      end
+      $stdout.write("\r      \r") if $stdout.tty?
+    end
+  end
+
+  File.rename(tmp, output)
+
+  return digest.hexdigest
+rescue SocketError => e
+  puts "Failure while downloading #{url}: #{e}"
+  raise
+ensure
+  File.unlink(tmp) if File.exist?(tmp)
+end # def download
+
+def untar(tarball, &block)
+  require "archive/tar/minitar"
+  tgz = Zlib::GzipReader.new(File.open(tarball))
+  # Pull out typesdb
+  tar = Archive::Tar::Minitar::Input.open(tgz)
+  tar.each do |entry|
+    path = block.call(entry)
+    next if path.nil?
+    parent = File.dirname(path)
+    
+    mkdir_p parent unless File.directory?(parent)
+
+    # Skip this file if the output file is the same size
+    if entry.directory?
+      mkdir path unless File.directory?(path)
+    else
+      entry_mode = entry.instance_eval { @mode } & 0777
+      if File.exists?(path)
+        stat = File.stat(path)
+        # TODO(sissel): Submit a patch to archive-tar-minitar upstream to
+        # expose headers in the entry.
+        entry_size = entry.instance_eval { @size }
+        # If file sizes are same, skip writing.
+        next if stat.size == entry_size && (stat.mode & 0777) == entry_mode
+      end
+      puts "Extracting #{entry.full_name} from #{tarball} #{entry_mode.to_s(8)}"
+      File.open(path, "w") do |fd|
+        # eof? check lets us skip empty files. Necessary because the API provided by
+        # Archive::Tar::Minitar::Reader::EntryStream only mostly acts like an
+        # IO object. Something about empty files in this EntryStream causes
+        # IO.copy_stream to throw "can't convert nil into String" on JRuby
+        # TODO(sissel): File a bug about this.
+        while !entry.eof?
+          chunk = entry.read(16384)
+          fd.write(chunk)
+        end
+          #IO.copy_stream(entry, fd)
+      end
+      File.chmod(entry_mode, path)
+    end
+  end
+  tar.close
+  File.unlink(tarball) if File.file?(tarball)
+end # def untar
+
+def ungz(file)
+
+  outpath = file.gsub('.gz', '')
+  tgz = Zlib::GzipReader.new(File.open(file))
+  begin
+    File.open(outpath, "w") do |out|
+      IO::copy_stream(tgz, out)
+    end
+    File.unlink(file)
+  rescue
+    File.unlink(outpath) if File.file?(outpath)
+   raise
+  end
+  tgz.close
+end
+
+desc "Process any vendor files required for this plugin"
+task "vendor" do |task, args|
+
+  @files.each do |file| 
+    download = file_fetch(file['url'], file['sha1'])
+    if download =~ /.tar.gz/
+      prefix = download.gsub('.tar.gz', '').gsub('vendor/', '')
+      untar(download) do |entry|
+        if !file['files'].nil?
+          next unless file['files'].include?(entry.full_name.gsub(prefix, ''))
+          out = entry.full_name.split("/").last
+        end
+        File.join('vendor', out)
+      end
+    elsif download =~ /.gz/
+      ungz(download)
+    end
+  end
+
+end

data/spec/outputs/graphtastic_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-graphtastic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elasticsearch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Send metrics to GraphTastic
+email: richard.pijnenburg@elasticsearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- lib/logstash/outputs/graphtastic.rb
+- logstash-output-graphtastic.gemspec
+- rakelib/publish.rake
+- rakelib/vendor.rake
+- spec/outputs/graphtastic_spec.rb
+homepage: http://logstash.net/
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  group: output
+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.1
+signing_key: 
+specification_version: 4
+summary: Send metrics to GraphTastic
+test_files:
+- spec/outputs/graphtastic_spec.rb