logstash-output-itda 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: daec719b2d44e8ebdb4a364bbde8f1ac387dbcae33b65672720fbb9fb8e9f16a
+  data.tar.gz: 8ae77fb0eddc39e19673250cf00eed96013f5a7882ea09c5301dfc1bba9665b5
+SHA512:
+  metadata.gz: ab6f0b8b64f697713542c589c2c801128bf3b046887cfcd307494c0a9b34a784c45722cdfbf522116531f75b51fbc6c488dc5d5fd7d593cf6a61b7473bd3dc6d
+  data.tar.gz: d06b45b560425602f0bc9c36c978c7fc7bb7a8eb109954462a128d99b6681189b4005dd1beedde066f08fa4b8506a93c6d6d144293365a113a7833c9271f47fd

data/CHANGELOG.md

@@ -0,0 +1 @@
+

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 logstash itda output plugin along its way.
+
+Contributors:
+* Sameer Pokarna (sameerpokarna)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash Itda Output Plugin, 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-itda
+ITDA output plugin. This plugin will help to re-direct logstash data into BMC TrueSight IT Data Analytics!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/README.md

@@ -0,0 +1,133 @@
+# logstash-output-itda
+A logstash output plugin to send data into ITDA.
+
+## 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
+# 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 '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
+# 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
+
+
+## Pre-requisites
+
+To be able to use this plugin, you need the following
+* Installation of BMC TrueSight IT Data Analytics
+* Create a Data collector of type (Receive over HTTP/HTTPS)
+
+## Usage
+Once you have installed the plugin, you can use it in the logstash configuration, by specifying the "itda" output.
+E.g.
+```sh
+    itda {
+        host => "localhost"
+        port => "4646"
+        protocol => "http"
+      }
+```
+
+```sh
+      itda {
+        host => "localhost"
+        port => "4545"
+        protocol => "http"
+        messageonly => "true"
+      }
+```
+
+### Fields
+
+| Property    | Value (Default) | Description |
+--------------|-----------------|-------------|
+| host        |                 | Host of the ITDA HTTP/HTTPS collector            |
+| port        |                 | Port of the ITDA HTTP/HTTPS collector            |
+| protocol    |                 | Protocol of the ITDA HTTP/HTTPS collector            |
+| messageonly | false           | Only send the message, and not the other fields            |
+
+
+
+## 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/itda.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/json"
+
+# Using hashes:
+# # [source,ruby]
+# # This plugin can be used to send all logstash data into BMC TrueSight IT Data Analytics.
+# # To sue this plugin, an HTTP/HTTPS collector should be created in the ITDA instance, and
+# # this configuration should point to the same.
+# # The various properties supported are -
+# # ----------------------------------
+# # match => {
+# #  "host" => "<hostname>/<ipaddress>"
+# #  "port" => "nnnn"
+# #  "api_key" => "<key>"
+# #  "protocol" => "http/https"
+# #  "messageonly" => "true/false"
+# # }
+# # ----------------------------------
+class LogStash::Outputs::Itda < LogStash::Outputs::Base
+  config_name "itda"
+
+  config :host, :validate => :string, :required => true
+  config :port, :validate => :string, :required => true
+  config :api_key, :validate => :string, :required => false
+  config :protocol, :validate => :string, :required => false
+  config :messageonly, :validate => :string, :required => false
+
+  public
+  def register
+    require "net/http"
+    require "uri"
+    @url = "#{@protocol}://#{@host}:#{@port}/"
+    @uri = URI.parse(@url)
+    @client = Net::HTTP.new(@uri.host, @uri.port)
+
+  end # def register
+
+  public
+  def receive(event)
+
+    event.remove('@timestamp')
+    event.remove('@version')
+
+    request = Net::HTTP::Post.new(@uri.path)
+    request.basic_auth(@api_key, '')
+
+    @logger.debug("ITDA event", :itda_event => event)
+
+    begin
+      if @messageonly
+        message = event.remove('message')
+        @logger.debug("ITDA message", :itda_message => message)
+
+        request.body = message
+        request.add_field("Content-Type", 'text/plain')
+      else
+        request.body = LogStash::Json.dump(event)
+        request.add_field("Content-Type", 'application/json')
+      end
+      response = @client.request(request)
+      @logger.warn("ITDA convo", :request => request.inspect, :response => response.inspect)
+      raise unless response.code == '200'
+    rescue Exception => e
+      @logger.warn(
+        "Unhandled exception",
+        :request => request.inspect,
+        :response => response.inspect,
+        :exception => e.inspect
+      )
+    end
+
+    return "Event received"
+  end # def event
+end # class LogStash::Outputs::Itda

data/logstash-output-itda.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-itda'
+  s.version         = "0.1.0"
+  s.licenses = ["Apache License (2.0)"]
+  s.summary = "This example output does nothing."
+  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 = ["sameerpokarna"]
+  s.email = "sameerpokarna@gmail.com"
+  s.homepage = "https://github.com/sameerpokarna/logstash-output-itda"
+  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.3.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/itda_spec.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-itda
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sameerpokarna
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.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'
+  name: logstash-devutils
+  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: sameerpokarna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- README.md
+- lib/logstash/outputs/itda.rb
+- logstash-output-itda.gemspec
+- spec/outputs/itda_spec.rb
+homepage: https://github.com/sameerpokarna/logstash-output-itda
+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.6.11
+signing_key:
+specification_version: 4
+summary: This example output does nothing.
+test_files:
+- spec/outputs/itda_spec.rb