logstash-output-thetapoint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee92e8be35167e5f6733532e4d9c2d38e5d6f721
+  data.tar.gz: 705459cd21e91278e020a1796beb81bfe56c21c6
+SHA512:
+  metadata.gz: 50ae2fb42a5bafae6226992e29545aa125577aa3261274571343f570774aceb7aed2b14196f83b279b2cb001a0fadabc1283803e5a3b1e479c8af402e3190699
+  data.tar.gz: 615dcdcb35564b0ccac04b1c8fa001f079fb542eda7ac921c4292416fc7c297db5a34becbfaf8b0caf3961053bd0ad696898b036f9e7ef8505cac37f0cd7eaef

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-example
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+# gem "logstash", :github => "elastic/logstash", :branch => "1.5"

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    logstash-output-thetapoint (0.1.0)
+      logstash-codec-plain
+      logstash-core (>= 1.4.0, < 2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cabin (0.7.1)
+    clamp (0.6.5)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.8-java)
+    filesize (0.0.4)
+    gem_publisher (1.5.0)
+    i18n (0.6.9)
+    insist (1.0.0)
+    jrjackson (0.2.8)
+    logstash-codec-plain (0.1.6)
+      logstash-core (>= 1.4.0, < 2.0.0)
+    logstash-core (1.5.0-java)
+      cabin (~> 0.7.0)
+      clamp (~> 0.6.5)
+      filesize (= 0.0.4)
+      i18n (= 0.6.9)
+      jrjackson (~> 0.2.8)
+      minitar (~> 0.5.4)
+      pry (~> 0.10.1)
+      stud (~> 0.0.19)
+      treetop (< 1.5.0)
+    logstash-devutils (0.0.14-java)
+      gem_publisher
+      insist (= 1.0.0)
+      minitar
+      rake
+      rspec (~> 3.1.0)
+    method_source (0.8.2)
+    minitar (0.5.4)
+    polyglot (0.3.5)
+    pry (0.10.1-java)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rake (10.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    spoon (0.0.4)
+      ffi
+    stud (0.0.19)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  logstash-devutils
+  logstash-output-thetapoint!
+
+BUNDLED WITH
+   1.10.3

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+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/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash/outputs/thetapoint.rb

@@ -0,0 +1,154 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "uri"
+require "net/http"
+require "net/https"
+require "stud/buffer"
+require "zlib"
+require 'time'
+
+# 
+# This is most useful so you can use logstash to parse and structure
+# your logs and ship structured, json events to ThetaPoint.
+#
+# To use this, you'll need to use a ThetaPoint input with type 'http'
+# and 'json logging' enabled.
+class LogStash::Outputs::ThetaPoint < LogStash::Outputs::Base
+
+  include Stud::Buffer
+
+  config_name "thetapoint"
+  milestone 3
+
+  # The hostname to send logs to. 
+  config :host, :validate => :string, :default => "api.theta-point.com"
+  config :port, :validate => :number, :default => 443
+  config :path, :validate => :string, :default => "bulk"
+
+  # The thetapoint http input key to send to.
+  #     https://thetapoint03.theta-point.com/inputs/abcdef12-3456-7890-abcd-ef0123456789
+  #                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  #                                           \---------->   key   <-------------/
+  #
+  # You can use %{foo} field lookups here if you need to pull the api key from
+  # the event. This is mainly aimed at multitenant hosting providers who want
+  # to offer shipping a customer's logs to that customer's loggly account.
+  config :key, :validate => :string, :required => true
+
+  # Should the log action be sent over https instead of plain http
+  config :proto, :validate => :string, :default => "https"
+
+  # Proxy Host
+  config :proxy_host, :validate => :string, :default => nil
+
+  # Proxy Port
+  config :proxy_port, :validate => :number, :default => nil
+
+  # Proxy Username
+  config :proxy_user, :validate => :string, :default => nil
+
+  # Proxy Password
+  config :proxy_password, :validate => :password, :default => nil
+
+  # If true, we send an HTTP POST request every "batch_events" events or
+  # "batch_timeout" seconds (whichever comes first).
+  config :batch, :validate => :boolean, :default => false
+  config :batch_events, :validate => :number, :default => 100
+  config :batch_timeout, :validate => :number, :default => 5
+
+  config :compress, :validate => :boolean, :default => false
+
+  public
+  def register
+    if @batch
+        buffer_initialize(
+            :max_items => @batch_events,
+            :max_interval => @batch_timeout,
+            :logger => @logger
+        )
+    end
+
+  end
+
+  public
+  def receive(event)
+    return unless output?(event)
+
+    if event == LogStash::SHUTDOWN
+      finished
+      return
+    end
+
+    if @batch
+        # Stud::Buffer
+        buffer_receive(event, event.sprintf(@key))
+        return
+    end
+
+    sendEvent(event.to_json, event.sprintf(@key))
+
+  end # def receive
+
+  def sendEvent(data, key)
+    # Comress data
+    if @compress
+      @logger.info("Deflate start", :now => Time.now.rfc2822, :length => data.length)
+      send_data = Zlib::Deflate.deflate(data, Zlib::BEST_COMPRESSION)
+      @logger.info("Deflate end", :now => Time.now.rfc2822, :length => send_data.length, :ratio => send_data.length/data.length)
+      @path = "zbulk"
+    else
+      send_data = data
+    end
+    # Send the data
+    @logger.info("ThetaPoint Connect: ",
+        :host => @host,
+        :port => @port,
+        :proxy_host => @proxy_host,
+        :proxy_port => @proxy_port, 
+        :proxy_user => @proxy_user, 
+        :proxy_password => @proxy_password.value)
+    @http = Net::HTTP.new(@host, @port, @proxy_host, @proxy_port, @proxy_user, @proxy_password.value)
+    @logger.info("http", :http => @http)
+    if @proto == 'https'
+      @http.use_ssl = true
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    begin
+      @logger.info("Submit start", :now => Time.now.rfc2822)
+      uri = "/#{@path}/#{@key}"
+      response = @http.request_post(uri, send_data)
+      @logger.info("Submit end", :now => Time.now.rfc2822)
+      @logger.info("response", :response => response)
+      if response.is_a?(Net::HTTPSuccess)
+        @logger.info("Event send to ThetaPoint OK!")
+      else
+        @logger.warn("HTTP error", :error => response.error!)
+      end
+    rescue Exception => e
+      @logger.error("ThetaPoint Unhandled exception", :pd_error => e.backtrace)
+    end
+
+  end # def sendEvent
+
+  # called from Stud::Buffer#buffer_flush when there are events to flush
+  def flush(events, key, teardown=false)
+    sendEvent(events.to_json, key)
+  end # def flush
+
+  # called from Stud::Buffer#buffer_flush when an error occurs
+  def on_flush_error(e)
+    @logger.warn("Failed to send backlog of events to ThetaPoint",
+        :exception => e,
+        :backtrace => e.backtrace
+    )
+  end # def on_flush_error
+
+  def teardown
+    if @batch
+      buffer_flush(:final => true)
+    end
+  end # def teardown
+
+end # class LogStash::Outputs::ThetaPoint

data/logstash-output-thetapoint.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-thetapoint'
+  s.version         = "0.1.0"
+  s.licenses = ["Apache License (2.0)"]
+  s.summary = "This thetapoint output does nothing."
+  s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors = ["ThetaPoint"]
+  s.email = "info@theta-point.com"
+  s.homepage = "http://www.theta-point.com"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # 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", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 1.4.0", "< 2.0.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/thetapoint_spec.rb

@@ -0,0 +1,32 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/thetapoint"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::ThetaPoint do
+  let(:config) { { 'key' => 'lksjdflskdjflskdjflskdj' } }
+  let(:event) do  
+    LogStash::Outputs::ThetaPoint.new(
+      'message' => 'example message',
+      'type' => 'event',
+      '@timestamp' => Logstash::Timestamp.now)
+  end
+
+  context 'when initializing' do
+    subject { LogStash::Outputs::ThetaPoint.new(config) }
+    
+    it 'should register' do
+      expect { subject.register }.to_not raise_error
+    end
+
+    it 'should have default config values' do
+      insist { subject.host } == 'api.theta-point.com'
+      insist { subject.port } == 443
+      insist { subject.proto } == 'https'
+    end
+
+  end
+
+end
+
+# vim: ts=2:sw=2:

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-thetapoint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ThetaPoint
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+email: info@theta-point.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/outputs/thetapoint.rb
+- logstash-output-thetapoint.gemspec
+- spec/outputs/thetapoint_spec.rb
+homepage: http://www.theta-point.com
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_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.5
+signing_key:
+specification_version: 4
+summary: This thetapoint output does nothing.
+test_files:
+- spec/outputs/thetapoint_spec.rb