logstash-output-stackify 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b2320f9ea79745878a8cbc29761a30f1b1c545d9566ae3a3ddc55b4fc218401
-  data.tar.gz: 604531df1db73e71429b7e19f4bf319caa96742fd0f5f3f6a4b19dbea73345c6
+  metadata.gz: 2d53735b4035d55142125702ab144d9911c342e56978ba947cc542d204b35c9b
+  data.tar.gz: 3f2793baec04fa289103e4fa345eb780027166c0cb57d57db22efbea435ea21a
 SHA512:
-  metadata.gz: 521ae011b795fbe0b6e430fa38bbb855703ac7b4f1a8c603a6adf720794669f3ed86353e9ba990706462cb326efca591e212e6496717b749e3c15190a062137e
-  data.tar.gz: 458ec4060d1a30b0956cea9a1ee1d37f5c1cd32f4d90af730d7087470f52afe61568e3109e870f70c2c41aabd1f510c3ba352f7788b3692f87f8e910e3528226
+  metadata.gz: 8058d7db838a42892b6b952cff162bd0d3c761ea8451803105977824e51986b2c94c037bd2114bfedfa47b2701b11449445843e24a3ba8d966989062977cd03c
+  data.tar.gz: f86a936b37e833c08af6deff16dcaeb6ba6760bf690a5598bcc2968fabbed209a07dc4fe883bab4caf4da648f1b8b8a22a9826b2ff540ccc7757d5547fd39ab0

data/Gemfile

@@ -1,3 +1,11 @@
 source 'https://rubygems.org'
 
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

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

@@ -1,2 +1,31 @@
-# Logstash Plugin 
-This is a plugin for Logstash
+
+# Stackify Logstash Output Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+## Usage  
+
+1. Download `logstash-output-stackify-#.#.#.gem` file from https://rubygems.org/gems/logstash-output-stackify.
+
+2. Install
+`bin/logstash-plugin install /path/to/logstash-output-stackify-#.#.#.gem`
+
+3. Add plugin to pipeline configuration: 
+```
+output {
+  stackify {
+     key => "[ACTIVATION KEY]" 
+  }
+}
+```
+
+**Optional Configuration Options**:
+
+* `default_env_name` - used if `env_name_field` is not defined - defaults to `Production`
+* `default_app_name` - used if `app_name_field` is not defined - defaults to `Logstash`
+* `env_name_field` - field to use for env name
+* `server_name_field` - field to use for server name
+* `app_name_field` - field to use for application name
+* `level_field` - field to use for log level
+* `message_field` - field to use for message - defaults to `message`
+

data/docs/DEVELOPMENT.md

@@ -0,0 +1,28 @@
+ 
+## References 
+
+* Guide https://www.elastic.co/guide/en/logstash/5.6/_how_to_write_a_logstash_output_plugin.html 
+ 
+## Install JRuby 
+```
+brew install jruby 
+jruby -S gem install bundle
+```
+
+## Build 
+```
+
+jruby -S bundle install
+jruby -S bundle exec rspec
+jruby -S gem build logstash-output-stackify.gemspec
+``` 
+
+## Install 
+
+```
+/logstash-5.6.16/bin/logstash-plugin install logstash-output-stackify-#.#.#.gem
+/logstash-5.6.16/bin/logstash-plugin list
+```
+
+
+

data/lib/logstash/outputs/stackify.rb

@@ -8,32 +8,32 @@ require "net/https"
 require "logstash/outputs/base"
 require "logstash/namespace"
 
-# An example output that does nothing.
+# Use logstash to ship logs to Stackify
 class LogStash::Outputs::Stackify < LogStash::Outputs::Base
   config_name "stackify"
 
-  # activation key
+  # Your Stackify Activation Key
   config :key, :validate => :string, :required => true
 
-  # default env_name
+  # Default Environment Name to associate to log events, used if env_name_field is not defined.
   config :default_env_name, :validate => :string, :required => false, :default => 'Production'
 
-  # default app_name
+  # Default Application Name to associate to log events, used if server_name_field is not defined.
   config :default_app_name, :validate => :string, :required => false, :default => 'Logstash'
 
-  # environment name field
+  # Event Field to use to populate event Environment Name.
   config :env_name_field, :validate => :string, :required => false, :default => nil
 
-  # server name field
+  # Event Field to use to populate event Server name.
   config :server_name_field, :validate => :string, :required => false, :default => nil
 
-  # application name field
+  # Event Field to use to populate event Application name.
   config :app_name_field, :validate => :string, :required => false, :default => nil
 
-  # log level field
+  # Event Field to use to populate event level.
   config :level_field, :validate => :string, :required => false, :default => nil
 
-  # event field to use for message
+  # Event Field to use to populate event message.
   config :message_field, :validate => :string, :required => false, :default => 'message'
 
   public
@@ -162,7 +162,6 @@ class LogStash::Outputs::Stackify < LogStash::Outputs::Base
               'X-Stackify-Key' => @key.to_s
           }
 
-
           uri = URI.parse('https://api.stackify.com/Log/Save')
           https = Net::HTTP.new(uri.host, uri.port)
           https.use_ssl = true

data/logstash-output-stackify.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-output-stackify'
-  s.version = '1.0.0'
+  s.version = '1.0.1'
   s.licenses = ['Apache License (2.0)']
   s.summary = "Sends logs to Stackify"
   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"
@@ -10,7 +10,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
+
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
@@ -18,8 +19,9 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  #
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
-  s.add_runtime_dependency "logstash-codec-plain"
+
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-codec-plain'
+  s.add_development_dependency 'rake', '~> 12.2.1' # for JRuby 1.7, Ruby 1.9
 end

data/spec/outputs/stackify_spec.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/outputs/stackify'
+
+def logger_for(plugin)
+  plugin.instance_variable_get('@logger')
+end
+
+describe 'outputs/stackify' do
+  let(:config) {{'key' => 'abcdef123456'}}
+
+  let(:output) do
+    LogStash::Outputs::Stackify.new(config).tap do |output|
+      output.register
+    end
+  end
+
+  let(:event) do
+    LogStash::Event.new(
+        'message' => 'fantastic log entry',
+        'source' => 'someapp',
+        'type' => 'nginx',
+        '@timestamp' => LogStash::Timestamp.now)
+  end
+
+  context 'when initializing' do
+    subject {LogStash::Outputs::Stackify.new(config)}
+
+    it 'should register' do
+      expect {subject.register}.to_not raise_error
+    end
+
+    it 'should have default config values' do
+      expect(subject.default_env_name).to eq('Production')
+      expect(subject.default_app_name).to eq('Logstash')
+      expect(subject.message_field).to eq('message')
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-stackify
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stackify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2019-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -36,9 +36,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-plain
+  name: logstash-devutils
   prerelease: false
-  type: :runtime
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -50,7 +50,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
+  name: logstash-codec-plain
   prerelease: false
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.2.1
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.2.1
 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
@@ -67,9 +81,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- LICENSE
 - README.md
+- docs/DEVELOPMENT.md
 - lib/logstash/outputs/stackify.rb
 - logstash-output-stackify.gemspec
+- spec/outputs/stackify_spec.rb
 homepage: https://www.stackify.com
 licenses:
 - Apache License (2.0)
@@ -96,4 +113,5 @@ rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
 summary: Sends logs to Stackify
-test_files: []
+test_files:
+- spec/outputs/stackify_spec.rb