logstash-output-seq 0.0.1 → 0.0.3.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aef33aac0f8557023bcbed88315a492e7438384
-  data.tar.gz: 8284cb19c116ec0efec0564c1b726306233b04e4
+  metadata.gz: fb7b2933ecba5476a1a8449dc3c39bea6a9f7be7
+  data.tar.gz: ee7ca93235178e3f2c7596c4b783a4542053f23b
 SHA512:
-  metadata.gz: 4989e95c4ffc91f244dbaa84c099ea738ae3274a4c6690e5131c33f02e44e4090c8b01efccb2ee9f2e62fbef9f3c3a46bb8f3cffcc38210cca05e815d6b0c93f
-  data.tar.gz: 40ceb7fdb6cd09696e0eb311105e8197f7a15f37f9bf07b2a5a45299214060fc396943c9dc5156c0da0b728cc3302d90ee8b43838b3a9279e3aa3d0b88771dba
+  metadata.gz: 1c022cb3868a4840e205c584d1bfdf14c0e23f39496e99d2fcb17489ca7bc54c5a5d9c7fa8d875666f00ead09a49008138624118f5fcf8db21c9ef1ecc895da6
+  data.tar.gz: 2ac79b1772ce6500e711cc0b73c5cb11986414d50bccce320ef90b934000a59b721e52ddaf67ae4aed7376104dc9f6094e0a0fde87d47a6a5cc4d6902b6ea492

data/DEVELOPING.md

@@ -0,0 +1,69 @@
+## 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

data/README.md

@@ -1,89 +1,31 @@
-# Seq Logstash Plugin
+# Seq output plugin for Logstash
 
 [![Travis Build Status](https://travis-ci.org/tintoy/logstash-output-seq.svg)](https://travis-ci.org/tintoy/logstash-output-seq)
+[![Gem Version](https://badge.fury.io/rb/logstash-output-seq.svg)](https://badge.fury.io/rb/logstash-output-seq)
+[![Coverage Status (master)](https://coveralls.io/repos/github/tintoy/logstash-output-seq/badge.svg?branch=master)](https://coveralls.io/github/tintoy/logstash-output-seq?branch=master)
 
-This is a plugin for [Logstash](https://github.com/elastic/logstash).
+This is an output plugin for [Logstash](https://github.com/elastic/logstash) that publishes events to [Seq](https://getseq.net/).
 
 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.
+## Usage
 
-## Documentation
+To install the Seq output plugin for Logstash:
 
-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 {}}'
+${LOGSTASH_HOME}/bin/logstash-plugin install logstash-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:
+The plugin has the following configuration options:
 
-- 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
+* `url` (Required) - The Seq server URL (e.g. `http://localhost:5341/`)
+* `api_key` (Optional) - The Seq API key (if any) to use for authentication.
+* Any parameters from the Logstash HttpClient mix-in (e.g. configuring SSL behaviour, etc).
 
-# Prior to Logstash 2.3
-bin/plugin install --no-verify
+## Developing
 
-```
-- Start Logstash and proceed to test the plugin
+[Developing](DEVELOPING.md)
 
 ## Contributing
 

data/lib/logstash/outputs/seq.rb

@@ -1,10 +1,11 @@
 # encoding: utf-8
-require 'json/ext'
 require 'logstash/outputs/base'
 require 'logstash/plugin_mixins/http_client'
 require 'logstash/json'
 require 'logstash/namespace'
 
+require 'jrjackson'
+
 # An output that sends events to Seq.
 class LogStash::Outputs::Seq < LogStash::Outputs::Base
   include LogStash::PluginMixins::HttpClient
@@ -70,7 +71,7 @@ class LogStash::Outputs::Seq < LogStash::Outputs::Base
 
     request = client.post(@url, {
       headers: @default_headers,
-      body:    payload.to_json,
+      body:    JrJackson::Json.dump(payload),
       async:   true
     })
 

data/lib/version-info.rb

@@ -0,0 +1,7 @@
+module LogStash
+  module Output
+    module Seq
+      VERSION = '0.0.3-alpha1'
+    end
+  end
+end

data/logstash-output-seq.gemspec

@@ -1,28 +1,39 @@
-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"]
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'version-info'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logstash-output-seq'
+  spec.version       = LogStash::Output::Seq::VERSION
+  spec.licenses      = ["MIT"]
+  spec.summary       = "This plugin outputs log entries to Seq (https://getseq.net)."
+  spec.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 logstash-output-seq. This gem is not a stand-alone program"
+  spec.authors       = ["tintoy"]
+  spec.email         = "tintoy@tintoy.io"
+  spec.homepage      = "https://github.com/tintoy/logstash-output-seq"
+  spec.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE']
+  spec.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE']
    # Tests
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  spec.test_files = spec.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" }
+  spec.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"
+  spec.add_runtime_dependency "logstash-core", ">= 2.3.4", "< 3.0.0"
+  spec.add_runtime_dependency "logstash-mixin-http_client", ">= 2.2.4", "< 3.0.0"
+  spec.add_runtime_dependency "logstash-codec-plain"
+
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "logstash-devutils", "~> 0.0.15"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+  spec.add_development_dependency "webrick", "~> 1.3"
 end

data/spec/outputs/seq_spec.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 require 'logstash/devutils/rspec/spec_helper'
-require 'logstash/outputs/seq'
 require 'logstash/codecs/plain'
 require 'logstash/event'
 
-require "json"
+require "jrjackson"
 require "sinatra"
 
+require "spec/spec_helper"
+
 describe LogStash::Outputs::Seq do
   # Output and its configuration
   let(:port) { PORT }
@@ -23,7 +24,7 @@ describe LogStash::Outputs::Seq do
   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) }
+  let(:posted_events) { JrJackson::Json.parse(request_body) }
 
   # Sample events
   let(:sample_event) {

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'logstash/outputs/seq'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-seq
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3.pre.alpha1
 platform: ruby
 authors:
 - tintoy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +64,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  name: coveralls
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -81,32 +109,74 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   name: sinatra
   prerelease: false
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   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
+        version: '1.3'
+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 logstash-output-seq. This gem is not a stand-alone program
 email: tintoy@tintoy.io
 executables: []
 extensions: []
@@ -115,12 +185,15 @@ files:
 - CHANGELOG.md
 - CONTRIBUTORS
 - DEVELOPER.md
+- DEVELOPING.md
 - Gemfile
 - LICENSE
 - README.md
 - lib/logstash/outputs/seq.rb
+- lib/version-info.rb
 - logstash-output-seq.gemspec
 - spec/outputs/seq_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/tintoy/logstash-output-seq
 licenses:
 - MIT
@@ -138,9 +211,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project:
 rubygems_version: 2.4.8
@@ -149,3 +222,4 @@ specification_version: 4
 summary: This plugin outputs log entries to Seq (https://getseq.net).
 test_files:
 - spec/outputs/seq_spec.rb
+- spec/spec_helper.rb