logstash-output-riak 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODhlM2FlY2Q0MjhhNmVlOTRiNTliNmM1ODVmOGJiODA2MTlmNjI5Yw==
+  data.tar.gz: !binary |-
+    MTc4ODdmNDAyMDcxNDY2ZDZhZTZlMjE1NjM3YjQxNjgxZjc3YTE0OA==
+SHA512:
+  metadata.gz: !binary |-
+    OTE3YTY3ZWFkMjczNWFlYWMxZmJkNTdlMzZlNzhiMDJlYzVmMzdjMTZiYzYx
+    MDU1YjU5MjZhYjJhYTI5ZDJlODllNzk1MjIzMTM0Y2UyZmNhYmRiN2I2NDMy
+    NTZjZjY3OTdmZGE0ZDcyOWZhZjUyYjE5NzY5MTcwZmIxOWQzYzA=
+  data.tar.gz: !binary |-
+    ODA3NDQ3MDk1ODE3NTgyMjk1NTdmZDEwNzg2ZjM2ZWFmZjgyMzJjYTE2NTM0
+    OWI1YzEzNTEyMjMyZmRiYzYxYzk3ZTM2YWQzYjRmYTA2N2E1YjI1NTUzNTQ4
+    YzU5MWE2NTRlNWJhMDFmNjY0MDIzOTM4ZTdmZmJlMGMxMmRkZGE=

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/riak.rb

@@ -0,0 +1,153 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+
+# Riak is a distributed k/v store from Basho.
+# It's based on the Dynamo model.
+
+class LogStash::Outputs::Riak < LogStash::Outputs::Base
+  config_name "riak"
+  milestone 1
+
+  # The nodes of your Riak cluster
+  # This can be a single host or
+  # a Logstash hash of node/port pairs
+  # e.g
+  # ["node1", "8098", "node2", "8098"]
+  config :nodes, :validate => :hash, :default => {"localhost" =>  "8098"}
+
+  # The protocol to use
+  # HTTP or ProtoBuf
+  # Applies to ALL backends listed above
+  # No mix and match
+  config :proto, :validate => ["http", "pb"], :default => "http"
+
+  # The bucket name to write events to
+  # Expansion is supported here as values are 
+  # passed through event.sprintf
+  # Multiple buckets can be specified here
+  # but any bucket-specific settings defined
+  # apply to ALL the buckets.
+  config :bucket, :validate => :array, :default => ["logstash-%{+YYYY.MM.dd}"]
+
+  # The event key name
+  # variables are valid here.
+  #
+  # Choose this carefully. Best to let riak decide....
+  config :key_name, :validate => :string
+
+  # Bucket properties (NYI)
+  # Logstash hash of properties for the bucket
+  # i.e.
+  # `bucket_props => ["r", "one", "w", "one", "dw", "one"]`
+  # or
+  # `bucket_props => ["n_val", "3"]`
+  # Note that the Logstash config language cannot support
+  # hash or array values
+  # Properties will be passed as-is
+  config :bucket_props, :validate => :hash
+
+  # Indices
+  # Array of fields to add 2i on
+  # e.g.
+  # `indices => ["source_host", "type"]
+  # Off by default as not everyone runs eleveldb
+  config :indices, :validate => :array
+
+  # Search
+  # Enable search on the bucket defined above
+  config :enable_search, :validate => :boolean, :default => false
+
+  # SSL
+  # Enable SSL
+  config :enable_ssl, :validate => :boolean, :default => false
+
+  # SSL Options
+  # Options for SSL connections
+  # Only applied if SSL is enabled
+  # Logstash hash that maps to the riak-client options
+  # here: https://github.com/basho/riak-ruby-client/wiki/Connecting-to-Riak
+  # You'll likely want something like this:
+  # `ssl_opts => ["pem", "/etc/riak.pem", "ca_path", "/usr/share/certificates"]
+  # Per the riak client docs, the above sample options
+  # will turn on SSL `VERIFY_PEER`
+  config :ssl_opts, :validate => :hash
+
+  # Metadata (NYI)
+  # Allow the user to set custom metadata on the object
+  # Should consider converting logstash data to metadata as well
+  #
+
+  public
+  def register
+    require 'riak'
+    riak_opts = {}
+    cluster_nodes = Array.new
+    @logger.debug("Setting protocol", :protocol => @proto)
+    proto_type = "#{@proto}_port".to_sym
+    @nodes.each do |node,port|
+      @logger.debug("Adding node", :node => node, :port => port)
+      cluster_nodes << {:host => node, proto_type => port}
+    end
+    @logger.debug("Cluster nodes", :nodes => cluster_nodes)
+    if @enable_ssl
+      @logger.debug("SSL requested")
+      if @ssl_opts
+        @logger.debug("SSL options provided", @ssl_opts)
+        riak_opts.merge!(@ssl_opts.inject({}) {|h,(k,v)| h[k.to_sym] = v; h})
+      else
+        riak_opts.merge!({:ssl => true})
+      end
+    @logger.debug("Riak options:", :riak_opts => riak_opts)
+    end
+    riak_opts.merge!({:nodes => cluster_nodes})
+    @logger.debug("Riak options:", :riak_opts => riak_opts)
+    @client = Riak::Client.new(riak_opts)
+  end # def register
+
+  public
+  def receive(event)
+    return unless output?(event)
+    
+    @bucket.each do |b|
+      # setup our bucket(s)
+      bukkit = @client.bucket(event.sprintf(b))
+      # Disable bucket props for now
+      # Need to detect params passed that should be converted to int
+      # otherwise setting props fails =(
+      # Logstash syntax only supports strings and bools
+      # likely fix is to either hack in is_numeric?
+      # or whitelist certain params and call to_i
+      ##@logger.debug("Setting bucket props", :props => @bucket_props)
+      ##bukkit.props = @bucket_props if @bucket_props
+      ##@logger.debug("Bucket", :bukkit => bukkit.inspect)
+     
+      if @enable_search
+        @logger.debug("Enable search requested", :bucket => bukkit.inspect)
+        # Check if search is enabled
+        @logger.debug("Checking bucket status", :search_enabled => bukkit.is_indexed?)
+        bukkit.enable_index! unless bukkit.is_indexed?
+        @logger.debug("Rechecking bucket status", :search_enabled => bukkit.is_indexed?)
+      end
+      @key_name.nil? ? evt_key=nil : evt_key=event.sprintf(@key_name)
+      evt = Riak::RObject.new(bukkit, evt_key)
+      @logger.debug("RObject", :robject => evt.to_s)
+      begin
+        evt.content_type = "application/json"
+        evt.data = event
+        if @indices
+          @indices.each do |k|
+            idx_name = "#{k.gsub('@','')}_bin"
+            @logger.debug("Riak index name", :idx => idx_name)
+            @logger.info("Indexes", :indexes => evt.indexes.to_s)
+            evt.indexes[idx_name] << event.sprintf("%{#{k}}")
+          end
+        end
+        evt.store
+      rescue Exception => e
+        @logger.warn("Exception storing", :message => e.message)
+      end
+    end
+  end # def receive
+end # class LogStash::Outputs::Riak

data/logstash-output-riak.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-output-riak'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Send events to Riak"
+  s.description     = "Riak is a distributed k/v store from Basho"
+  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'
+
+  s.add_runtime_dependency 'riak-client', ['1.0.3']
+
+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/riak_spec.rb

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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-riak
+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
+- !ruby/object:Gem::Dependency
+  name: riak-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: Riak is a distributed k/v store from Basho
+email: richard.pijnenburg@elasticsearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- lib/logstash/outputs/riak.rb
+- logstash-output-riak.gemspec
+- rakelib/publish.rake
+- rakelib/vendor.rake
+- spec/outputs/riak_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 events to Riak
+test_files:
+- spec/outputs/riak_spec.rb