Contents

require 'splunk-sdk-ruby'


# Recommended not to use the colorized formatter.

class SemanticLogger::Appender::Splunk < SemanticLogger::Appender::Base
  attr_reader :config, :index, :service, :service_index

  # Allow the level for this appender to be overwritten
  #   Default: :error
  def initialize(options, level=:error, &block)
    # Parse input options for setting up splunk connection
    parse_options(options)

    # Connect to splunk. Connect is a synonym for creating a Service by hand and calling login.
    @service = Splunk::connect(@config)

    # The index we are logging to
    @service_index = @service.indexes[@index]

    # Pass on the level and custom formatter if supplied
    super(level, &block)
  end


  # Log the message to Splunk
  def log(log)
    # Ensure minimum log level is met, and check filter
    return false if (level_index > (log.level_index || 0)) || !include_message?(log)
    # Submit the log message
    @service_index.submit(formatter.call(log))
    true
  end

  private

    def parse_options(options)
      @config = {
       scheme:   options[:scheme] || :https,
       host:     options[:host]   || 'localhost',
       port:     options[:port]   || 8089,
       username: options[:username],
       password: options[:password]
      }

      @index = options[:index]

      if @config[:username].nil?
        raise ArgumentError, 'Must supply a username.'
      elsif @config[:password].nil?
        raise ArgumentError, 'Must supply a password.'
      elsif @index.nil?
        raise ArgumentError, 'Must supply an index.'
      end
    end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
semantic_logger-2.10.0	lib/semantic_logger/appender/splunk.rb