logstash-output-websocket-topics 2.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfca6218dcc45082cc58e3a033fa2d51bba3834c
+  data.tar.gz: 73c69b324105cc9aa81125b5b9fdfd7de7bbc36d
+SHA512:
+  metadata.gz: aa8bdc7efa01e7d8623faf7ce34fe6429677fc72ae3ba0301616066eadc1a4a2520d8a6e032d4e68222cd2c67e1b97b962ecc2afdf9a2081ac87dbcec399946e
+  data.tar.gz: 4b937a613c2450a0ffc2099c4c4fa1c23f83214f6f58a676701f62b59b95ed548d469bf936cf4797ecb3df0809234ee60beadc34bfd2a0f8382d1eceb78312fd

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 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,15 @@
+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)
+* John E. Vincent (lusis)
+* Jordan Sissel (jordansissel)
+* Pete Fritchman (fetep)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+
+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/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,89 @@
+# Logstash Plugin
+
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-websocket-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-websocket-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/websocket.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require "logstash/namespace"
+require "logstash/outputs/base"
+
+
+# This output runs a websocket server and publishes any 
+# messages to all connected websocket clients.
+#
+# You can connect to it with ws://<host\>:<port\>/
+#
+# If no clients are connected, any messages received are ignored.
+class LogStash::Outputs::WebSocket < LogStash::Outputs::Base
+  config_name "websocket"
+
+  # The address to serve websocket data from
+  config :host, :validate => :string, :default => "0.0.0.0"
+
+  # The port to serve websocket data from
+  config :port, :validate => :number, :default => 3232
+
+  def make_pubsub(topic)
+      pubsub = Logstash::Outputs::WebSocket::Pubsub.new
+      pubsub.logger = @logger
+  end
+
+  public
+  def register
+    require "ftw"
+    require "logstash/outputs/websocket/app"
+    require "logstash/outputs/websocket/pubsub"
+    @channels = {}
+    @server = Thread.new(@channels) do |channels|
+      begin
+        Rack::Handler::FTW.run(LogStash::Outputs::WebSocket::App.new(channels, @logger),
+                               :Host => @host, :Port => @port)
+      rescue => e
+        @logger.error("websocket server failed", :exception => e)
+        sleep 1
+        retry
+      end
+    end
+  end # def register
+
+  public
+  def receive(event)
+    json = event.to_json
+    topic = json.topic
+    if @channels.has_key?(topic) 
+      @channels[topic].publish(json)
+    else
+      pubsub = make_pubsub(topic) 
+      @channels[topic] = pubsub
+      pubsub.publish(json)
+    end # if
+  end # def receive
+
+end # class LogStash::Outputs::Websocket

data/lib/logstash/outputs/websocket/app.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require "logstash/namespace"
+require "logstash/outputs/websocket"
+require "sinatra/base"
+require "rack/handler/ftw" # from ftw
+require "ftw/websocket/rack" # from ftw
+
+class LogStash::Outputs::WebSocket::App < Sinatra::Base
+  def initialize(channels, logger)
+    @channels = channels
+    @logger = logger
+  end
+
+  set :reload_templates, false
+
+  get "/" do
+    # TODO(sissel): Support filters/etc.
+    ws = ::FTW::WebSocket::Rack.new(env)
+    @logger.debug("New websocket client")
+    stream(:keep_open) do |out|
+      ws.each do |payload|
+        json = payload.to_json
+        if json.type == 'subscribe-topic'
+          @channels[json.topic].subscribe do |event| 
+            ws.publish(event)
+          end 
+        elsif json.type == 'subscribe-all'
+          @channels.values.each do |channel|
+            channel.subscribe do |event|
+              ws.publish(event)
+            end 
+          end
+        end 
+      end # pubsub
+    end # stream
+
+    ws.rack_response
+  end # get /
+end # class LogStash::Outputs::WebSocket::App
+

data/lib/logstash/outputs/websocket/pubsub.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+require "logstash/namespace"
+require "logstash/outputs/websocket"
+
+class LogStash::Outputs::WebSocket::Pubsub
+  attr_accessor :logger
+
+  def initialize
+    @subscribers = []
+    @subscribers_lock = Mutex.new
+  end # def initialize
+
+  def publish(object)
+    @subscribers_lock.synchronize do
+      break if @subscribers.size == 0
+
+      failed = []
+      @subscribers.each do |subscriber|
+        begin
+          subscriber.call(object)
+        rescue => e
+          @logger.error("Failed to publish to subscriber", :subscriber => subscriber, :exception => e)
+          failed << subscriber
+        end
+      end
+
+      failed.each do |subscriber|
+        @subscribers.delete(subscriber)
+      end
+    end # @subscribers_lock.synchronize
+  end # def Pubsub
+
+  def subscribe(&block)
+    queue = Queue.new
+    @subscribers_lock.synchronize do
+      @subscribers << proc do |event|
+        queue << event
+      end
+    end
+
+    while true
+      block.call(queue.pop)
+    end
+  end # def subscribe
+end # class LogStash::Outputs::WebSocket::Pubsub

data/logstash-output-websocket.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-output-websocket-topics'
+  s.version         = '2.1.2'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This output runs a websocket server and publishes any messages to those conencted clients that have subscribed to the topic being published."
+  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         = ["Andrew Osheroff"]
+  s.email           = 'andrewosh@gmail.com'
+  s.homepage        = ""
+  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.beta2", "< 3.0.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'sinatra', '~> 1.4.6'
+  s.add_runtime_dependency 'ftw', ['~> 0.0.40']
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/outputs/websocket_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/websocket"
+
+describe "output/websocket" do
+
+  subject(:output) { LogStash::Outputs::WebSocket.new }
+
+  it "should register" do
+    expect {output.register}.to_not raise_error
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-websocket-topics
+version: !ruby/object:Gem::Version
+  version: 2.1.2
+platform: ruby
+authors:
+- Andrew Osheroff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: ftw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.40
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.40
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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/plugin install gemname. This gem is not
+  a stand-alone program
+email: andrewosh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/outputs/websocket.rb
+- lib/logstash/outputs/websocket/app.rb
+- lib/logstash/outputs/websocket/pubsub.rb
+- logstash-output-websocket.gemspec
+- spec/outputs/websocket_spec.rb
+homepage: ''
+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.6
+signing_key: 
+specification_version: 4
+summary: This output runs a websocket server and publishes any messages to those conencted
+  clients that have subscribed to the topic being published.
+test_files:
+- spec/outputs/websocket_spec.rb