logstash-output-thetapoint 0.3.0 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20cbc4ec8b453142d66b1d01b492c27f22cf71b6645a6d56a11f61f6bd942292
-  data.tar.gz: 89260c472479ffe2ba243d02084e2772aec5e338a8a775f28de1314697c8317a
+  metadata.gz: b8150caebfcaf3b54efe3d9a0ac2b38426bc1cfcfbef73c04a28d323c7303425
+  data.tar.gz: ec97d7e8c72b3fb768529861ba5ef40638827098717a26d7904fa0538b4c013d
 SHA512:
-  metadata.gz: 4ca3d48d1dfcf8674aa657b7f0e041f9cee1f8de6fd1fcc5d91b82d825652ed25266ff25c1af2ffd59dde6bc0f11af666212e45131e4009b0d667bfecbc70d2b
-  data.tar.gz: 55c4788405fbbd3d2da4e7ee0815b1a00d9dc2d38b3501a6417e7ee832c35e2e0dc09f3f7c7da957ad89ec5cbcb7e980720989b9e8764717dd133890af335c73
+  metadata.gz: 4100f2bb99b79a7b9b2c5a63c9f4689577dfef9814b0e8d8426dca65c9317fd0f87527c4e7c70c878c64f290131793ff9f7770dddbe940533fdddef9b7cbcd64
+  data.tar.gz: 3e200576da9997dadf4caa867f5a0dfa76b6e3daedef4a4ac123cf40b390b282560bffd3c816fbafe76ca99d83458ea65cec8d053b605ff20f50d414e4441123

data/CHANGELOG.md

@@ -1,2 +0,0 @@
-## 0.1.0
-  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -2,7 +2,8 @@ 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

data/DEVELOPER.md

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

data/Gemfile

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

data/LICENSE

@@ -1,3 +1,5 @@
+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

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elastic/logstash).
+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.elastic.co/guide/en/logstash/current/).
+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/elastic/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -53,7 +53,7 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
 - Install plugin
 ```sh
-bin/logstash-plugin install --no-verify
+bin/plugin install --no-verify
 ```
 - Run Logstash with your plugin
 ```sh
@@ -71,7 +71,7 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
 ```
 - Start Logstash and proceed to test the plugin
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/thetapoint.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-require "logstash/outputs/base"
+# 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'
 require 'json'
@@ -12,13 +10,7 @@ require 'json'
 # 
 # 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"
 
   # The hostname to send logs to. 
@@ -30,10 +22,6 @@ class LogStash::Outputs::ThetaPoint < LogStash::Outputs::Base
   #     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
@@ -53,104 +41,75 @@ class LogStash::Outputs::ThetaPoint < LogStash::Outputs::Base
 
   # 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 :batch, :validate => :boolean, :default => false, :deprecated => true
+  config :batch_events, :validate => :number, :default => 100, :deprecated => true
+  config :batch_timeout, :validate => :number, :default => 5, :deprecated => true
 
-  config :compress, :validate => :boolean, :default => false
+  config :compress, :validate => :boolean, :default => true
 
   public
   def register
-    if @batch
-        buffer_initialize(
-            :max_items => @batch_events,
-            :max_interval => @batch_timeout,
-            :logger => @logger
-        )
-    end
-
+    @logger.debug "Initializing ThetaPoint Output", @config
   end
 
   public
   def receive(event)
-    return unless output?(event)
+    @logger.debug("receive(#{event})")
 
-    @logger.info("receive: #{event}")
+    send_data(event.to_json)
+  end # def receive
 
-    if @batch
-        # Stud::Buffer
-        @logger.info("receive: Buffer Event")
-        buffer_receive(event, event.sprintf(@key))
-        return
-    end
+  def multi_receive(events)
+    @logger.debug("multi_receive(#{events.length})")
 
-    @logger.info("receive: Send Single Event")
-    send_data(event.to_json, event.sprintf(@key))
+    send_data(events.to_json)
+  end # def multi_receive
 
-  end # def receive
 
-  def send_data(data, key)
+  def send_data(data)
+    @logger.debug("send_data(#{data.length})")
+
+    uri = "#{@proto}://#{@host}"
+    post_data = data
 
     # Comress data
     if @compress
-      @logger.info("Deflate start", :now => Time.now.rfc2822, :length => data.length)
       post_data = Zlib::Deflate.deflate(data, Zlib::BEST_COMPRESSION)
-      @logger.info("Deflate end", :now => Time.now.rfc2822, :length => post_data.length, :ratio => post_data.length/data.length)
-      @path = "zbulk"
+      uri << "/zbulk/#{@key}"
     else
-      post_data = data
+      uri << "/#{@key}"
     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 ? @proxy_password.value : nil)
-    @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
+    @logger.debug("URI: #{uri}")
+    url = URI.parse(uri)
+
+    http = Net::HTTP::Proxy(@proxy_host,
+      @proxy_port,
+      @proxy_user,
+      @proxy_password.value).new(url.host, url.port)
+
+    if url.scheme == 'https'
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
 
+    request = Net::HTTP::Post.new(url.path)
+    request.body = post_data
+
     begin
-      @logger.info("Submit start", :now => Time.now.rfc2822)
-      uri = "/#{@path}/#{key}"
-      response = @http.request_post(uri, post_data)
-      @logger.info("Submit end", :now => Time.now.rfc2822)
-      @logger.info("response", :response => response)
+      response = http.request(request)
+      @logger.debug "Response: #{response}"
+
       if response.is_a?(Net::HTTPSuccess)
-        @logger.info("Event send to ThetaPoint OK!")
+        @logger.debug("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 send_data
+    rescue StandardError => e
+        @logger.error("An unexpected error occurred", :exception => e.class.name, :error => e.to_s, :backtrace => e.backtrace)
+    end # rescue
 
-  # called from Stud::Buffer#buffer_flush when there are events to flush
-  def flush(events, key, teardown=false)
-    @logger.info("Flush #{events.length} events")
-    send_data(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 # def send_data
 
 end # class LogStash::Outputs::ThetaPoint

data/logstash-output-thetapoint.gemspec

@@ -1,24 +1,24 @@
 Gem::Specification.new do |s|
-  s.name          = 'logstash-output-thetapoint'
-  s.version       = '0.3.0'
-  s.licenses      = ['Apache-2.0']
-  s.summary       = 'Send data to ThetaPoint'
-  s.description   = 'Send data to ThetaPoint using HTTPS to submit plain or compressed messages'
-  s.homepage      = 'https://github.com/harryrh/logstash-output-thetapoint'
-  s.authors       = ['Harry Halladay']
-  s.email         = 'harry@theta-point.com'
-  s.require_paths = ['lib']
+  s.name = 'logstash-output-thetapoint'
+  s.version  = "2.0"
+  s.licenses = ["Apache License (2.0)"]
+  s.summary = "If you don't know, you don't need this"
+  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 = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
-   # Tests
+
+  # 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-plugin-api", "~> 2.0"
-  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_development_dependency "logstash-devutils"
 end

data/spec/outputs/thetapoint_spec.rb

@@ -1,22 +1,30 @@
-# encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/outputs/thetapoint"
-require "logstash/codecs/plain"
-require "logstash/event"
 
-describe LogStash::Outputs::Thetapoint do
-  let(:sample_event) { LogStash::Event.new }
-  let(:output) { LogStash::Outputs::Thetapoint.new }
-
-  before do
-    output.register
+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
 
-  describe "receive message" do
-    subject { output.receive(sample_event) }
+  context 'when initializing' do
+    subject { LogStash::Outputs::ThetaPoint.new(config) }
+    
+    it 'should register' do
+      expect { subject.register }.to_not raise_error
+    end
 
-    it "returns a string" do
-      expect(subject).to eq("Event received")
+    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

@@ -1,43 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-thetapoint
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: '2.0'
 platform: ruby
 authors:
-- Harry Halladay
+- ThetaPoint
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.99'
   name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-codec-plain
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -52,8 +44,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Send data to ThetaPoint using HTTPS to submit plain or compressed messages
-email: harry@theta-point.com
+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: []
@@ -65,12 +59,11 @@ files:
 - LICENSE
 - README.md
 - lib/logstash/outputs/thetapoint.rb
-- lib/logstash/outputs/thetapoint.rb.org
 - logstash-output-thetapoint.gemspec
 - spec/outputs/thetapoint_spec.rb
-homepage: https://github.com/harryrh/logstash-output-thetapoint
+homepage: http://www.theta-point.com
 licenses:
-- Apache-2.0
+- Apache License (2.0)
 metadata:
   logstash_plugin: 'true'
   logstash_group: output
@@ -93,6 +86,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
-summary: Send data to ThetaPoint
+summary: If you don't know, you don't need this
 test_files:
 - spec/outputs/thetapoint_spec.rb

data/lib/logstash/outputs/thetapoint.rb.org

@@ -1,17 +0,0 @@
-# encoding: utf-8
-require "logstash/outputs/base"
-require "logstash/namespace"
-
-# An thetapoint output that does nothing.
-class LogStash::Outputs::Thetapoint < LogStash::Outputs::Base
-  config_name "thetapoint"
-
-  public
-  def register
-  end # def register
-
-  public
-  def receive(event)
-    return "Event received"
-  end # def event
-end # class LogStash::Outputs::Thetapoint