fluent-plugin-logmatic 0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4a8ae2452e547650e5139666b2e11e16a849552
+  data.tar.gz: 952cf838c0ebd948448569299680347196791456
+SHA512:
+  metadata.gz: 7cc21ad106c3f519700cbc4e0b4b2434abe7ed124b2f3ea0bca8c63623499afab82f4288bdbf7cea43235fed946cadaf8f8d34c3ada4b7c5706618f3ee99b521
+  data.tar.gz: 228734eba5ef3240140ac6903d4c18a3764fbefbd3a96f394e2185a399267e64c80e088225fe7b554f6e47d16162b32c722844c737268ebab28aadd862bcb258

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-logmatic.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Logmatic.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+fluent-plugin-logmatic
+===============
+
+Fluentd output plugin for Logmatic.io.
+
+It mainly contains a proper JSON formatter and a socket handler that
+streams logs directly to Logmatic.io - so no need to use a log shipper
+if you don't wan't to.
+
+Pre-requirements
+================
+
+To add the plugin to your fluentd agent, use the following command:
+
+    gem install fluent-plugin-logmatic
+
+Usage
+=====
+
+"match" Tell fluentd how to send to Logmatic.io
+--------------------------
+
+To match events tagged logmatic, simply add the following code to your configuration file.
+
+```xml
+# Match events tagged with "logmatic.**" and
+# send them to Logmatic.io
+<match logmatic.**>
+
+  @type logmatic
+  @id awesome_agent
+  
+  api_key <your_api_key>
+
+</match>
+
+```
+
+Once this setup is done, any child events tagged with `logmatic` will be ship to your plateform.
+
+Let's make a simple test.
+
+```bash
+echo '{"message":"hello world from fluentd"}' | fluent-cat logmatic.demo
+```
+
+This will produce the following event:
+
+```javascript
+{ 
+	"custom": {
+    	"message": "hello world from fluentd" 
+     }
+}
+```
+
+fluent-plugin-logmatic properties
+======
+Let's go deeper on the plugin configuration. 
+
+As fluent-plugin-logmatic is an output_buffer, you can set all output_buffer properties like it's describe in the [fluentd documentation](http://docs.fluentd.org/articles/output-plugin-overview#buffered-output-parameters "documentation").
+
+api_key
+--------
+This parameter is required in order to authenticate your fluent agent. The agent won't started until set your key.    
+
+use_json 
+--------
+If it's set to true, the event will be send to json format. If it's set to false, only the key `message` of the record will be sent to Logmatic.io. Set to true by default.
+
+use_ssl
+--------
+If it's set to true, the agent initialize a secure connection to Logmatic. Set to true by default. 
+
+
+max_retries
+--------
+The number of retries before raised an error. By default, this parameter is set to 3.
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fluent-plugin-logmatic.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-logmatic"
+  spec.version       = "0.7"
+  spec.authors       = ["Logmatic support team"]
+  spec.email         = ["support@logmatic.io"]
+  spec.summary       = "Logmatic output plugin for Fluent event collector"
+  spec.homepage      = "https://github.com/logmatic/fluent-plugin-logmatic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/fluent/plugin/out_logmatic.rb

@@ -0,0 +1,90 @@
+require 'socket'
+require 'openssl'
+
+class Fluent::LogmaticOutput < Fluent::BufferedOutput
+  class ConnectionFailure < StandardError; end
+
+  # Register the plugin
+  Fluent::Plugin.register_output('logmatic', self)
+
+  # Output settings
+  config_param :use_json,       :bool,    :default => true
+
+  # Connection settings
+  config_param :host,           :string,  :default => 'api.logmatic.io'
+  config_param :use_ssl,        :bool,    :default => true
+  config_param :port,           :integer, :default => 10514
+  config_param :ssl_port,       :integer, :default => 10515
+  config_param :max_retries,    :integer, :default => 3
+  
+  # API Settings
+  config_param :api_key,  :string
+  
+  def configure(conf)
+    super
+    @last_edit = Time.at(0)
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def client
+
+   @_socket ||= if @use_ssl
+      context    = OpenSSL::SSL::SSLContext.new
+      socket     = TCPSocket.new @host, @ssl_port
+      ssl_client = OpenSSL::SSL::SSLSocket.new socket, context
+      ssl_client.connect
+    else
+      TCPSocket.new @host, @port
+    end
+    
+  end
+
+  # This method is called when an event reaches Fluentd.
+  def format(tag, time, record)
+    return [tag, record].to_msgpack
+  end
+
+  # NOTE! This method is called by internal thread, not Fluentd's main thread.
+  # 'chunk' is a buffer chunk that includes multiple formatted events.
+  def write(chunk)
+    
+    chunk.msgpack_each do |tag, record|
+      next unless record.is_a? Hash
+      next unless @use_json or record.has_key? "message"
+      message = @use_json ? record.to_json : record["message"].rstrip()
+      send_to_logmatic(message)
+    end
+
+  end
+
+  def send_to_logmatic(data)
+
+    retries = 0
+
+    begin
+
+      client.write("#{api_key} #{data}\n")
+
+    # Handle some failures
+    rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::EPIPE => e
+
+      if retries < @max_retries
+        retries += 1
+        @_socket = nil
+        a_couple_of_seconds = 5**retries 
+        log.warn "Could not push logs to Logmatic, attempt=#{retries} max_attempts=#{max_retries} wait=#{a_couple_of_seconds}s error=#{e.message}"
+        sleep a_couple_of_seconds
+        retry
+      end
+      raise ConnectionFailure, "Could not push logs to Logmatic after #{retries} retries, #{e.message}"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-logmatic
+version: !ruby/object:Gem::Version
+  version: '0.7'
+platform: ruby
+authors:
+- Logmatic support team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 
+email:
+- support@logmatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-logmatic.gemspec
+- lib/fluent/plugin/out_logmatic.rb
+homepage: https://github.com/logmatic/fluent-plugin-logmatic
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Logmatic output plugin for Fluent event collector
+test_files: []