splunk_logger 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70847608b3d78ba75b5b81d848605163f33e5d18
+  data.tar.gz: 16fdfa884272a5e99f20e233a7b9bb016943e104
+SHA512:
+  metadata.gz: 95df78d83e0d9d126598e0963beca5abab4605f602f1b1b580eac95115a2b8a22ee767882c6c1600b59e542232bc50aaa90a2b06e08dc3c44edd008a72b7c6c2
+  data.tar.gz: 8b96d9739bda7f5f83aac63336a1c88b2174b1a06959ce031cdb802bfb931fdd48aecbde2563723750855a59bbe31174be447a67a2da605ee26103a070beca52

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Robert Ikeoka <rikeoka@gmail.com>
+
+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/lib/splunk_logger/client/log.rb

@@ -0,0 +1,59 @@
+module SplunkLogger
+  class Client
+
+    # Methods to log events to Splunk
+    module Log
+
+      # Log event with default level
+      #
+      # Example:
+      #   SplunkLogger.log("hello world")
+      def log(message)
+        queue_or_send_message(@default_level, message)
+      end
+
+      # Log event as debug
+      #
+      # Example:
+      #   SplunkLogger.debug("hello world")
+      def debug(message)
+        queue_or_send_message('debug', message)
+      end
+
+      # Log event as info
+      #
+      # Example:
+      #   SplunkLogger.info("hello world")
+      def info(message)
+        queue_or_send_message('info', message)
+      end
+
+      # Log event as warning
+      #
+      # Example:
+      #   SplunkLogger.warn("hello world")
+      def warn(message)
+        queue_or_send_message('warn', message)
+      end
+
+      # Log event as error
+      #
+      # Example:
+      #   SplunkLogger.error("hello world")
+      def error(message)
+        queue_or_send_message('error', message)
+      end
+
+      private
+      def queue_or_send_message(level, message)
+        if delayed?
+          @message_queue << {severity: level, message: message}
+          @message_queue.shift if @message_queue.length > @max_queue_size + @max_batch_size
+          return true
+        else
+          send_log_now({severity: level, message: message})
+        end
+      end
+    end
+  end
+end

data/lib/splunk_logger/client.rb

@@ -0,0 +1,94 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+require 'splunk_logger/client/log'
+
+module SplunkLogger
+  class Client
+    include SplunkLogger::Client::Log
+    COLLECTOR_PATH = '/services/collector/event'
+
+    def initialize(options = {})
+      token = options[:token]
+      url = options[:url]
+      verify_ssl = options[:verify_ssl].nil? ? true : options[:verify_ssl]
+      @default_level = options[:default_level].to_s || 'info'
+      @send_interval = options[:send_interval].to_i
+      @max_batch_size = (options[:max_batch_size] || 100).to_i
+      @max_queue_size = (options[:max_queue_size] || 10000).to_i
+      @message_queue = []
+      @current_message_size = 0
+      headers = {'Authorization': "Splunk #{token}", 'Content-Type': 'application/json'}
+      @conn = Faraday.new(url: url, headers: headers) do |faraday|
+        faraday.request :json
+        faraday.response :json, content_type: 'application/json'
+        faraday.response :logger
+        faraday.adapter  Faraday.default_adapter
+      end
+      @conn.ssl.verify = verify_ssl
+      start
+    end
+
+    attr_accessor :message_queue
+
+    def start
+      return unless (@timer.nil? && delayed?)
+      @timer = Thread.new do
+        while true do
+          sleep @send_interval
+          send_log
+        end
+      end
+    end
+
+    def stop
+      return if @timer.nil?
+      @timer.kill
+      @timer = nil
+    end
+
+    def delayed?
+      return @send_interval > 0
+    end
+
+    protected
+
+    def send_log
+      return if @message_queue.empty? || @current_message_size > 0
+
+      while(!@message_queue.empty?) do
+        @current_message_size = [@message_queue.length, @max_batch_size].min
+        messages = { "event": @message_queue.slice(0, @current_message_size) }
+        body = messages[:event].map { |m| "#{{event: m}.to_json}" }.join("\n")
+
+
+        begin
+          response = @conn.post SplunkLogger::Client::COLLECTOR_PATH, body
+          if response.body['text'] == 'Success' && response.body['code'] == 0
+            @message_queue.shift(@current_message_size)
+          else
+            @current_message_size = 0
+            return
+          end
+        rescue Faraday::Error => e
+          @current_message_size = 0
+          return
+        end
+      end
+
+      @current_message_size = 0
+    end
+
+    def send_log_now(message)
+      body = "#{{event: message}.to_json}"
+
+      begin
+        response = @conn.post SplunkLogger::Client::COLLECTOR_PATH, body
+        return ( response.body['text'] == 'Success' && response.body['code'] == 0 )
+      rescue Faraday::Error => e
+        return false
+      end
+    end
+  end
+end

data/lib/splunk_logger/version.rb

@@ -0,0 +1,3 @@
+module SplunkLogger
+  VERSION = "0.0.0"
+end

data/lib/splunk_logger.rb

@@ -0,0 +1,10 @@
+require 'splunk_logger/client'
+
+module SplunkLogger
+  class << self
+    # @return [SplunkLogger::Client] forwarder wrapper
+    def client(options = {})
+      SplunkLogger::Client.new(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: splunk_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Robert Ikeoka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !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::Version
+        version: '0'
+description: 
+email: rikeoka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/splunk_logger.rb
+- lib/splunk_logger/client.rb
+- lib/splunk_logger/client/log.rb
+- lib/splunk_logger/version.rb
+homepage: https://github.com/rikeoka/splunk_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Simple logger to send logs to your Splunk instance
+test_files: []