logstash-output-seq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3aef33aac0f8557023bcbed88315a492e7438384
+  data.tar.gz: 8284cb19c116ec0efec0564c1b726306233b04e4
+SHA512:
+  metadata.gz: 4989e95c4ffc91f244dbaa84c099ea738ae3274a4c6690e5131c33f02e44e4090c8b01efccb2ee9f2e62fbef9f3c3a46bb8f3cffcc38210cca05e815d6b0c93f
+  data.tar.gz: 40ceb7fdb6cd09696e0eb311105e8197f7a15f37f9bf07b2a5a45299214060fc396943c9dc5156c0da0b728cc3302d90ee8b43838b3a9279e3aa3d0b88771dba

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 2.0.1
+ - Add encoding: utf-8 to spec files. This can help prevent issues during testing.
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped the Seq plugin for Logstash along its way.
+
+Contributors:
+* Adam Friedman (tintoy)
+
+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-seq
+Seq output plugin.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 tin oscillator
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,92 @@
+# Seq Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/tintoy/logstash-output-seq.svg)](https://travis-ci.org/tintoy/logstash-output-seq)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is MIT, meaning you are pretty much free to use it however you want in whatever way.
+
+Note that this plugin is just a skeleton for now; this documentation will be updated as work progresses.
+
+## 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/).
+
+- 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
+
+## 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-output-seq", :path => "/your/local/logstash-output-seq"
+```
+- Install plugin
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'output {seq {}}'
+```
+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-output-seq.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/tintoy/logstash-output-seq/blob/master/.github/CONTRIBUTING.md) file.

data/lib/logstash/outputs/seq.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+require 'json/ext'
+require 'logstash/outputs/base'
+require 'logstash/plugin_mixins/http_client'
+require 'logstash/json'
+require 'logstash/namespace'
+
+# An output that sends events to Seq.
+class LogStash::Outputs::Seq < LogStash::Outputs::Base
+  include LogStash::PluginMixins::HttpClient
+
+  @@ignore_properties = {
+      '@timestamp' => true,
+      '@level' => true,
+      '@version' => true,
+      'message' => true
+  }
+  
+  config_name 'seq'
+
+  # The Seq server URL
+  config :url, :validate => :string, :required => :true
+
+  # The Seq API key
+  config :api_key, :validate => :string, :optional => :true
+
+  public
+  def register
+    url = @url
+
+    url += '/' unless url.end_with? '/'
+    url += 'api/events/raw'
+
+    @url = url
+
+    @default_headers = {
+        'X-Seq-ApiKey' => @api_key,
+        'Content-Type' => 'application/json'
+    }
+
+    # We count outstanding requests with this queue; it tracks outstanding requests to create backpressure
+    # When this queue is empty no new requests may be sent, tokens must be added back by the client on success
+    @request_tokens = SizedQueue.new(@pool_max)
+    @pool_max.times {|t| @request_tokens << true }
+  end # def register
+
+  public
+  def multi_receive(events)
+    payload = {
+        'Events' => events.map {|event| to_seq_payload(event)}
+    }
+    post_to_seq(payload)
+
+    "#{events.length} events received"
+  end # def multi_receive
+
+  public
+  def receive(event)
+    payload = {
+        'Events' => [to_seq_payload(event)]
+    }
+    post_to_seq(payload)
+
+    'Event received'
+  end # def receive
+
+  private
+  def post_to_seq(payload)
+    token = @request_tokens.pop
+
+    request = client.post(@url, {
+      headers: @default_headers,
+      body:    payload.to_json,
+      async:   true
+    })
+
+    request.on_complete do
+      @request_tokens << token
+    end
+
+    request.on_success do |response|
+      if response.code < 200 || response.code > 299
+        log_failure("Encountered non-200 HTTP code #{200}",
+          :response_code => response.code,
+          :url => url,
+          :event => event
+        )
+      end
+    end
+
+    request.on_failure do |exception|
+      log_failure("Could not submit POST request.",
+        :url => url,
+        :method => @http_method,
+        :body => body,
+        :headers => headers,
+        :message => exception.message,
+        :class => exception.class.name,
+        :backtrace => exception.backtrace
+      )
+    end
+
+    request_async_background(request)
+  end # def post_to_seq
+
+  # Convert a Logstash event to a Seq event payload.
+  #
+  # Note that we return a hash here, not the JSON, because it's more efficient to convert batched events to JSON all-in-one go.
+  private
+  def to_seq_payload(event)
+    props = {
+        '@Version' => event['@version']
+    }
+    payload = {
+        :Timestamp => event['@timestamp'],
+        :Level => get_level(event),
+        :MessageTemplate => event['message'],
+        :Properties => props
+    }
+
+    event.instance_variable_get(:@data).each do |property, value|
+      props[property] = value unless @@ignore_properties.has_key? property
+    end
+
+    payload
+  end # def to_seq_payload
+
+  private
+  def get_level(event)
+    level = event['@level']
+
+    level ? level : 'Verbose'
+  end # def get_level
+
+  # Manticore doesn't provide a way to attach handlers to background or async requests well
+  # It wants you to use futures. The #async method kinda works but expects single thread batches
+  # and background only returns futures.
+  # Proposed fix to manticore here: https://github.com/cheald/manticore/issues/32
+  private
+  def request_async_background(request)
+    @method ||= client.executor.java_method(:submit, [java.util.concurrent.Callable.java_class])
+    @method.call(request)
+  end
+end # class LogStash::Outputs::Seq

data/logstash-output-seq.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-seq'
+  s.version       = "0.0.1"
+  s.licenses      = ["MIT"]
+  s.summary       = "This plugin outputs log entries to Seq (https://getseq.net)."
+  s.description   = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
+  s.authors       = ["tintoy"]
+  s.email         = "tintoy@tintoy.io"
+  s.homepage      = "https://github.com/tintoy/logstash-output-seq"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE']
+   # 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", ">= 2.3.4", "< 3.0.0"
+  s.add_runtime_dependency "logstash-mixin-http_client", ">= 2.2.4", "< 3.0.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  
+  s.add_development_dependency "logstash-devutils", "~> 0.0.15"
+  s.add_development_dependency "sinatra"
+  s.add_development_dependency "webrick"
+end

data/spec/outputs/seq_spec.rb

@@ -0,0 +1,238 @@
+# encoding: utf-8
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/outputs/seq'
+require 'logstash/codecs/plain'
+require 'logstash/event'
+
+require "json"
+require "sinatra"
+
+describe LogStash::Outputs::Seq do
+  # Output and its configuration
+  let(:port) { PORT }
+  let(:url) { "http://localhost:#{port}/" }
+  let(:output) {
+    LogStash::Outputs::Seq.new({
+      'url' => url,
+      'pool_max' => 1 # Required so we can block until the request completes.
+    })
+  }
+
+  # Captured request
+  let(:request_failed) { TestApp.last_request_failed }
+  let(:last_request) { TestApp.last_request }
+  let(:request_body) { last_request.body.read }
+  let(:request_content_type) { last_request ? last_request.env["CONTENT_TYPE"] : nil }
+  let(:posted_events) { JSON.parse(request_body) }
+
+  # Sample events
+  let(:sample_event) {
+    LogStash::Event.new({
+      '@timestamp' => '2016-07-23T10:09:08.12345+10:00',
+      'host' => 'localhost',
+      'message' => 'Hi, Single Event'
+    })
+  }
+  let(:sample_events) {
+    [
+      LogStash::Event.new({
+        '@timestamp' => '2016-07-23T00:09:08.123Z',
+        '@level' => 'Info',
+        'host' => 'localhost',
+        'message' => 'Hello, World!',
+        'name' => 'World'
+      }),
+      LogStash::Event.new({
+        '@timestamp' => '2016-07-23T00:09:00.456Z',
+        '@level' => 'Warning',
+        'host' => 'localhost',
+        'message' => 'Goodbye Moon?',
+        'name' => 'Moon'
+      })
+    ]
+  }
+
+  before do
+    TestApp.reset
+  end
+
+  before do
+    output.register
+  end
+
+  describe 'receive message' do
+    before do
+      output.receive(sample_event)
+      wait_for_request
+    end
+
+    it 'makes a request' do
+      expect(last_request).to_not be_nil
+    end
+
+    it 'does an HTTP POST' do
+      expect(request_failed).to be(false)
+    end
+
+    it 'sends JSON' do
+      expect(request_content_type).to eq('application/json')
+    end
+
+    it 'sends a valid event event data payload' do
+      expect(posted_events).to eq(
+          {
+              'Events' => [
+                  {
+                      'Timestamp' => '2016-07-23T00:09:08.123Z',
+                      'Level' => 'Verbose',
+                      'MessageTemplate' => 'Hi, Single Event',
+                      'Properties' => {
+                          '@Version' => "1",
+                          'host' => 'localhost'
+                      }
+                  }
+              ]
+          }
+      )
+    end
+  end
+
+  describe 'receive messages' do
+    before do
+      output.multi_receive(sample_events)
+      wait_for_request
+    end
+
+    it 'makes a request' do
+      expect(last_request).to_not be_nil
+    end
+
+    it 'does an HTTP POST' do
+      expect(request_failed).to be(false)
+    end
+
+    it 'sends JSON' do
+      expect(request_content_type).to eq('application/json')
+    end
+
+    it 'sends a valid event event data payload' do
+      expect(posted_events).to eq(
+          {
+              'Events' => [
+                  {
+                      'Timestamp' => '2016-07-23T00:09:08.123Z',
+                      'Level' => 'Info',
+                      'MessageTemplate' => 'Hello, World!',
+                      'Properties' => {
+                          '@Version' => "1",
+                          'host' => 'localhost',
+                          'name' => 'World'
+                      }
+                  },
+                  {
+                      'Timestamp' => '2016-07-23T00:09:00.456Z',
+                      'Level' => 'Warning',
+                      'MessageTemplate' => 'Goodbye Moon?',
+                      'Properties' => {
+                          '@Version' => "1",
+                          'host' => 'localhost',
+                          'name' => 'Moon'
+                      }
+                  }
+              ]
+          }
+      )
+    end
+  end
+
+  def wait_for_request()
+    # Wait for the current request to complete.
+    output.request_tokens.pop
+  end
+end
+
+# Enable access to request tokens from the test.
+class LogStash::Outputs::Seq
+  attr_reader :request_tokens
+end
+
+PORT = rand(65535-1024) + 1025
+
+RSpec.configure do |config|
+  #http://stackoverflow.com/questions/6557079/start-and-call-ruby-http-server-in-the-same-script
+  def sinatra_run_wait(app, opts)
+    queue = Queue.new
+
+    Thread.new(queue) do |queue|
+      begin
+        app.run!(opts) do |server|
+          queue.push("started")
+        end
+      rescue
+        # ignore
+      end
+    end
+
+    queue.pop # blocks until the run! callback runs
+  end
+
+  config.before(:suite) do
+    sinatra_run_wait(TestApp, :port => PORT, :server => 'webrick')
+  end
+end
+
+# note that Sinatra startup and shutdown messages are directly logged to stderr so
+# it is not really possible to disable them without reopening stderr which is not advisable.
+#
+# == Sinatra (v1.4.6) has taken the stage on 51572 for development with backup from WEBrick
+# == Sinatra has ended his set (crowd applauds)
+
+class TestApp < Sinatra::Base
+
+  # disable WEBrick logging
+  def self.server_settings
+    { :AccessLog => [], :Logger => WEBrick::BasicLog::new(nil, WEBrick::BasicLog::FATAL) }
+  end
+
+  def self.reset()
+    @last_request_failed = false
+    @last_request = nil
+  end
+
+  def self.last_request_failed=(last_request_failed)
+    @last_request_failed = last_request_failed
+  end
+
+  def self.last_request_failed
+    @last_request_failed
+  end
+
+  def self.last_request=(request)
+    @last_request = request
+  end
+
+  def self.last_request
+    @last_request
+  end
+
+  def self.multiroute(methods, path, &block)
+    methods.each do |method|
+      method.to_sym
+      self.send method, path, &block
+    end
+  end
+
+  post "/api/events/raw" do
+    self.class.last_request = request
+    # Success after failure stills means failure until reset
+
+    [200, '{"MinimumLevelAccepted": null}']
+  end
+
+  multiroute(%w(get post put patch delete), "/*") do
+    self.class.last_request = request
+    self.class.last_request_failed = true
+
+    [500, "{\"Error\": \"Unexpected request: #{request.request_method} '#{request.url}'\"}"]
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-seq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tintoy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-mixin-http_client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: sinatra
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: webrick
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
+email: tintoy@tintoy.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/seq.rb
+- logstash-output-seq.gemspec
+- spec/outputs/seq_spec.rb
+homepage: https://github.com/tintoy/logstash-output-seq
+licenses:
+- MIT
+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.8
+signing_key:
+specification_version: 4
+summary: This plugin outputs log entries to Seq (https://getseq.net).
+test_files:
+- spec/outputs/seq_spec.rb