logstash-output-status 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69b0b8f8d17f2f0633ba711d0d2f1f77b1f8c582
+  data.tar.gz: 1769b9b45bb5732de9751abc301d3079f7dc6e52
+SHA512:
+  metadata.gz: 1ed5bc0383582ff03a8d362c6120755b00c83e830b4098434a690bf410656dea34b58c6a865af2b0fe7078dc61871291c6a1e7d379b3d83336ed7b9d7e65389d
+  data.tar.gz: 619747c5289a11b6d047b7952d07e59a0b61c34178d4e6edf86ebaaff61f115b97d2db9d0227dc8e23213a8d9749da8da45da1a23829281d55a4210484392891

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,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,2 @@
+source 'https://rubygems.org'
+gemspec

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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,142 @@
+# Logstash output status
+
+An output plugin for monitoring Logstash.
+
+This output plugin stores the last event, and serves it as HTTP, in JSON.
+
+This code use copy/paste oriented programmation, from http input and elapsed filter.
+
+# Example
+
+```
+input {
+    heartbeat {
+        interval => 10
+        message => "sequence"
+        type => "heart"
+    }
+}
+
+filter {}
+
+output {
+    if [type] == "heart" {
+        stdout { codec => rubydebug }
+        status {
+        }
+    }
+}
+```
+
+Now you use curl to know if logstash is alive :
+
+```
+$ curl -v http://localhost:8080/
+*   Trying ::1...
+* Connected to localhost (::1) port 8080 (#0)
+> GET / HTTP/1.1
+> Host: localhost:8080
+> User-Agent: curl/7.43.0
+> Accept: */*
+>
+< HTTP/1.1 200 OK
+< Content-Type: application/json
+< Content-Length: 138
+<
+* Connection #0 to host localhost left intact
+{"clock":1,"host":"My-Laptop.local","@version":"1","@timestamp":"2016-01-14T16:07:52.424Z","type":"heart","@delta":1.314}
+
+```
+
+A special _@delta_ attribute is the difference between last seen event and now.
+
+
+# Logstash Plugin
+
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-example-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-example-unit/)
+
+This is a plugin for [Logstash](https://github.com/elastic/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/).
+
+- 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
+
+## 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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/status.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+require 'logstash/outputs/base'
+require 'logstash/namespace'
+require 'puma/server'
+require 'puma/minissl'
+require 'base64'
+
+class Puma::Server
+  # ensure this method doesn't mess up our vanilla request
+  def normalize_env(env, client); end
+end
+
+class LogStash::Outputs::Status < LogStash::Outputs::Base
+  attr_accessor :lastbeat
+
+  config_name 'status'
+
+  # The host or ip to bind
+  config :host, validate: :string, default: '0.0.0.0'
+
+  # The TCP port to bind to
+  config :port, validate: :number, default: 8080
+
+  # Maximum number of threads to use
+  config :threads, validate: :number, default: 4
+
+  # Username for basic authorization
+  config :user, validate: :string, required: false
+
+  # Password for basic authorization
+  config :password, validate: :password, required: false
+
+  # SSL Configurations
+  #
+  # Enable SSL
+  config :ssl, validate: :boolean, default: false
+
+  # The JKS keystore to validate the client's certificates
+  config :keystore, validate: :path
+
+  # Set the truststore password
+  config :keystore_password, validate: :password
+
+  # useless headers puma adds to the requests
+  # mostly due to rack compliance
+  REJECTED_HEADERS = ['puma.socket', 'rack.hijack?', 'rack.hijack', 'rack.url_scheme', 'rack.after_reply', 'rack.version', 'rack.errors', 'rack.multithread', 'rack.multiprocess', 'rack.run_once', 'SCRIPT_NAME', 'QUERY_STRING', 'SERVER_PROTOCOL', 'SERVER_SOFTWARE', 'GATEWAY_INTERFACE']
+
+  RESPONSE_HEADERS = { 'Content-Type' => 'application/json' }
+
+  public
+
+  def register
+    @mutex = Mutex.new
+    @lastbeat = {}
+    @server = ::Puma::Server.new(nil) # we'll set the rack handler later
+    if @user && @password
+      token = Base64.strict_encode64("#{@user}:#{@password.value}")
+      @auth_token = "Basic #{token}"
+    end
+    if @ssl
+      if @keystore.nil? || @keystore_password.nil?
+        fail(LogStash::ConfigurationError, 'Settings :keystore and :keystore_password are required because :ssl is enabled.')
+      end
+      ctx = Puma::MiniSSL::Context.new
+      ctx.keystore = @keystore
+      ctx.keystore_pass = @keystore_password.value
+      @server.add_ssl_listener(@host, @port, ctx)
+    else
+      @server.add_tcp_listener(@host, @port)
+    end
+    @server.min_threads = 0
+    @server.max_threads = @threads
+
+    # proc needs to be defined at this context
+    # to capture @codecs, @logger and lowercase_keys
+    p = proc do |req|
+      begin
+        remote_host = req['puma.socket'].peeraddr[3]
+        REJECTED_HEADERS.each { |k| req.delete(k) }
+        body = req.delete('rack.input')
+        last = @lastbeat.clone
+        last['@delta'] = Time.new - last['@timestamp'].time
+        ['200', RESPONSE_HEADERS, [last.to_json]]
+      rescue => e
+        @logger.error("unable to process event #{req.inspect}. exception => #{e.inspect}")
+        ['500', RESPONSE_HEADERS, ['internal error']]
+      end
+    end
+
+    auth = proc do |username, password|
+      username == @user && password == @password.value
+    end if @user && @password
+
+    @server.app = Rack::Builder.new do
+      use(Rack::Auth::Basic, &auth) if auth
+      run(p)
+    end
+    @pid = @server.run
+  end # def register
+
+  public
+
+  def receive(_event)
+    'Event received'
+    @mutex.synchronize do
+      @lastbeat = _event
+    end
+  end # def receive
+
+  public
+
+  def close
+    @pid.join
+    @server.graceful_shutdown
+  end # def close
+end # class LogStash::Outputs::Status

data/logstash-output-status.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-status'
+  s.version       = "0.1.1"
+  s.licenses      = ["Apache License (2.0)"]
+  s.summary       = "Http output status for monitoring"
+  s.description   = ""
+  s.authors       = ["athoune"]
+  s.email         = "mlecarme@bearstech.com"
+  s.homepage      = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files         = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec',
+                        '*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # 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.0.0", "< 3.0.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency 'puma', '~> 2.11.3'
+
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/status_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'logstash/devutils/rspec/spec_helper'
+require 'logstash/outputs/status'
+require 'logstash/codecs/plain'
+require 'logstash/event'
+
+describe LogStash::Outputs::Status do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Status.new }
+
+  before do
+    output.register
+  end
+
+  describe 'receive message' do
+    subject { output.receive(sample_event) }
+
+    it 'returns a string' do
+      expect(output.lastbeat).to notnil
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-status
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- athoune
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !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.0.0
+    - - "<"
+      - !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: 2.11.3
+  name: puma
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: mlecarme@bearstech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/outputs/status.rb
+- logstash-output-status.gemspec
+- spec/outputs/status_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+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.8
+signing_key:
+specification_version: 4
+summary: Http output status for monitoring
+test_files:
+- spec/outputs/status_spec.rb