logstash-output-logmatic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b87d20d8589bd5bd02e2ffd533e21555db26bbe
+  data.tar.gz: e18fbc95f1e283052bca1a7f73141eb41f589489
+SHA512:
+  metadata.gz: 4213878f8e592aca8884e23d6f9358251cb6f96d9bf50cc6b59fd76264f645d4f98be46a1be38e39c0ca7328af7a850d60088e477705d8a7fe9c0d4c3fb77b03
+  data.tar.gz: ddeca254ef9835b9280138d43aaa30a5b24fa2eaf8071fd567e4e431bf28c0190408d9261f0c78bf6128e8d896605bc01107712620191a0fd097781979a78c31

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,77 @@
+# Logstash Logmatic.io's Output Plugin
+
+TThis project is an output plugin to send logs to Logmatic.io from Logstash >v1.5.0.
+
+## How to install it?
+
+The gem should be published in the main repository.
+To install it in your Logstash install:
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+
+ ```
+ gem "logstash-output-logmatic"
+ ```
+
+- Then install plugin:
+
+```
+bin/plugin install --no-verify
+```
+
+## How to use it?
+
+Then you just need to configure the output as follow:
+
+```
+output {
+    logmatic {
+        key => "<your_api_key>"
+        # In order to limit the amount of resources the output uses buffering
+        # You can configure its behavior with:
+        # The number of elements queued before flushing
+        # queue_size => 10
+        # The timeframe in seconds for buffering before flushing
+        # timeframe => 10
+    }
+}
+
+```
+Don’t forget to change `<your_api_key>` to your provided api key.
+Once you are happy with your configuration you have to restart Logstash to take it account.
+
+## Need Help?
+
+If you need any support please contact us Logmatic.io's support team.
+
+## Developing
+
+#### 1. Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-output-logmatic", :path => "/your/local/logstash-output-logmatic"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'output {logmatic {...}}'
+```
+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. Run in an installed Logstash
+
+You can use the same **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-logmatic.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-output-logmatic.gem
+```
+- Start Logstash and proceed to test the plugin

data/lib/logstash/outputs/logmatic.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "stud/buffer"
+
+# Ship log from logstash straight to Logmatic
+# 
+# To use this you will need a valid Logmatic API Key
+class LogStash::Outputs::LogmaticBatch < LogStash::Outputs::Base
+  include Stud::Buffer
+
+  config_name "logmatic"
+  milestone 2
+
+  # The Logmatic api key
+  # You can find it in the 'Account' section in the Logmatic interface.
+  config :key, :validate => :string, :required => true
+
+  # How many events to queue before flushing to Logmatic
+  # prior to schedule set in @timeframe
+  config :queue_size, :validate => :number, :default => 10
+
+  # How often (in seconds) to flush queued events to Logmatic
+  config :timeframe, :validate => :number, :default => 10
+
+  public
+  def register
+    require "net/https"
+    require "uri"
+    @url = "https://api.logmatic.io/v1/input/#{@key}"
+    @uri = URI.parse(@url)
+    @client = Net::HTTP.new(@uri.host, @uri.port)
+    @client.use_ssl = true
+    @client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    @logger.debug("Logmatic URL", :url => @url)
+
+    buffer_initialize(
+      :max_items => @queue_size,
+      :max_interval => @timeframe,
+      :logger => @logger
+    )
+  end
+
+  public
+  def receive(event)
+    return unless output?(event)
+    buffer_receive(event)
+  end
+
+  public
+  def flush(events, final=false)
+    # Send the event over http.
+    request = Net::HTTP::Post.new(@uri.path)
+    request.body = events.to_json
+    request.add_field("Content-Type", 'application/json')
+    response = @client.request(request)
+    if response.is_a?(Net::HTTPSuccess)
+      @logger.debug("Event sent to Logmatic OK!")
+    else
+      @logger.warn("HTTP error", :error => response.error!)
+    end
+  end # def receive
+end # class LogStash::Outputs::LogmaticBatch

data/logstash-output-logmatic.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-output-logmatic'
+  s.version         = "0.1.0"
+  s.licenses = ["GNU 2.0"]
+  s.summary = "Logmatic Output"
+  s.description = "Logmatic output for Logstash"
+  s.authors = ["Giovanni CLEMENT","Renaud Boutet"]
+  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", "~> 1.5.3"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/logmatic.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-logmatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Giovanni CLEMENT
+- Renaud Boutet
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !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: Logmatic output for Logstash
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/outputs/logmatic.rb
+- logstash-output-logmatic.gemspec
+- spec/outputs/logmatic.rb
+homepage: ''
+licenses:
+- GNU 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.5
+signing_key:
+specification_version: 4
+summary: Logmatic Output
+test_files:
+- spec/outputs/logmatic.rb