elasticelmah 0.0.1

data/lib/elasticelmah.rb

@@ -0,0 +1,131 @@
+require 'elasticsearch'
+require 'log4r'
+require 'time'
+module ElasticElmah
+
+    class Outputter < Log4r::Outputter
+        attr_reader :log
+        def initialize(_name, hash={})
+            super(_name, hash)
+            @index = "logs"
+
+            @index = hash[:index] if hash.has_key?(:index) 
+            @closed = false
+            @initialized = false
+            @client = Elasticsearch::Client.new #log: true
+        end
+
+        def time_now
+            Time.now.utc
+        end
+        def time_stamp
+            time_now.strftime('%Y-%m-%dT%H:%M:%S.%7N%:z') #"0001-01-01T00:00:00.0 00 000 0+01:00"
+        end
+
+        def closed?
+            @closed
+        end
+
+        def close
+            @closed = true
+            @level = OFF
+            OutputterFactory.create_methods(self)
+            Logger.log_internal {"Outputter '#{@name}' closed and set to OFF"}
+        end
+
+        def serialize(l)
+                    #    attr_reader :level, :tracer, :data, :name, :fullname
+      # [level]    The integer level of the log event. Use LNAMES[level]
+      #            to get the actual level name.
+      # [tracer]   The execution stack returned by <tt>caller</tt> at the
+      #            log event. It is nil if the invoked Logger's trace is false.
+      # [data]     The object that was passed into the logging method.
+      # [name]     The name of the logger that was invoked.
+      # [fullname] The fully qualified name of the logger that was invoked.
+            return {
+                loggerName:l.name,
+                level: Log4r::LNAMES[l.level],
+                message: l.data != nil && l.data.respond_to?(:message) ? l.data.message : l.data,
+                threadName:"",
+                timeStamp:time_stamp,
+                locationInfo:{
+                    className:"?",
+                    fileName:"?",
+                    lineNumber:"?",
+                    methodName:"?"
+                },
+                userName:"",
+                properties:{},
+                exceptionString: l.tracer!=nil ? l.tracer.join("\n") : "",
+                domain:"",
+                identity:""
+            }
+        end
+
+        #######
+        private
+        #######
+        def create_index
+            @client.indices.create(index: @index, body: {
+                        settings: {
+                          index: { number_of_shards: 1, number_of_replicas: 0 }
+                        },
+                        mappings:{
+                            "LoggingEvent" => logging_event_mappings
+                        }
+                    })
+            #@client.indices.put_mapping(index: @index, type: 'LoggingEvent', body: logging_event_mappings)
+        end
+        def logging_event_mappings
+            {
+      _source: {
+        enabled: true,
+        compress: false
+      },
+      _ttl: {
+        enabled: true,
+        default: "24d"
+      },
+      _timestamp: {
+        enabled: true,
+        path: "timeStamp",
+        store: true
+      },
+      properties: {
+        timeStamp: {
+          type: "date"
+        },
+        message:{type: "string"},
+        exceptionString:{type: "string"},
+        domain:{type: "string"},
+        identity:{type: "string"},
+        userName: {type: "string"},
+        locationInfo:{
+            type: "object",
+            properties: {
+                className:{type: "string"},
+                fileName:{type: "string"},
+                lineNumber:{type: "string"},
+                methodName:{type: "string"}
+            }
+        },
+        threadName:{type: "string"},
+        loggerName:{type: "string"},
+        level:{type:"string"},
+        properties:{ type: "object", store: "yes" }
+      }
+    }
+        end
+
+        # perform the write
+        def canonical_log(logevent)
+            if !@initialized
+                @initialized= true
+                if !@client.indices.exists(index: @index)
+                    create_index
+                end
+            end
+            @client.index  index: @index, type: 'LoggingEvent', body: serialize(logevent)
+        end
+    end
+end

data/tests/elasticelmah_tests.rb

@@ -0,0 +1,129 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'elasticelmah'
+require 'test/unit'
+require 'securerandom'
+class OutputterWithFakedElastic < ElasticElmah::Outputter
+    attr_reader :written
+    def initialize(_name, hash={})
+        super(_name, hash)
+        @written = []
+    end
+
+    private
+    def canonical_log(logevent)
+        @written.push(logevent)
+    end
+end
+
+class OutputterWithFakedElasticAndTimestamp < OutputterWithFakedElastic
+    def initialize(_name, hash={})
+        super(_name, hash)
+        @written = []
+    end
+    def time_now
+        Time.new(2008,6,21, 12,30,0, "+01:00")
+    end
+end
+
+class TestElasticElmahOutputterForReal < Test::Unit::TestCase
+    def setup
+        Log4r::Logger.root.level = Log4r::INFO
+        @logger = Log4r::Logger.new 'testout_for_real'
+        @index = SecureRandom.uuid
+        @outp = ElasticElmah::Outputter.new 'outp_for_real',{index: @index}
+        @logger.add('outp_for_real')
+        @client = Elasticsearch::Client.new# log: true
+    end
+    def teardown
+        @client.indices.delete(index: @index)
+    end
+
+    def test_generated_from_logging_event_data
+        @logger.error('some_error')
+        @client.indices.flush(index: @index )
+        result = @client.search index: @index
+        assert_equal 1, result["hits"]["hits"].length
+        hits = result["hits"]["hits"]
+        assert_equal 'some_error', hits[0]["_source"]["message"]
+    end
+end
+
+
+class TestElasticElmahOutputter < Test::Unit::TestCase
+    def setup
+        Log4r::Logger.root.level = Log4r::INFO
+        @logger = Log4r::Logger.new 'testoutp'
+
+        @outp = OutputterWithFakedElasticAndTimestamp.new 'outp1'
+        @logger.add('outp1')
+    end
+
+    def test_generated_from_logging_event_data
+        @logger.error('some_error')
+        assert_equal([{:loggerName=>"testoutp",
+:level=>"ERROR",
+:message=>"some_error",
+:threadName=>"",
+:timeStamp=>"2008-06-21T12:30:00.0000000+01:00",
+:locationInfo=>
+ {:className=>"?", :fileName=>"?", :lineNumber=>"?", :methodName=>"?"},
+:userName=>"",
+:properties=>{},
+:exceptionString=>"",
+:domain=>"",
+:identity=>""}],
+            @outp.written.map do |written| @outp.serialize(written) end)
+    end
+end
+
+class FakeLogger
+    attr_reader :name, :fullname
+    def initialize(name,fullname)
+        @name = name
+        @fullname = fullname
+    end
+end
+
+class TestElasticElmahSerializer < Test::Unit::TestCase
+    def setup
+        @outp = OutputterWithFakedElasticAndTimestamp.new 'outp2'
+    end
+
+
+    def test_will_serialize_exception_string
+        logger = FakeLogger.new('logger_1', 'fullname_of_logger_1')
+        tracer = caller
+        data = Exception.new("Message")
+        l = Log4r::LogEvent.new(Log4r::INFO, logger, tracer, data)
+        s =  @outp.serialize(l)
+        assert_equal("Message",s[:message])
+        assert_equal(caller.join("\n"),s[:exceptionString])
+    end
+    
+    def test_will_serialize_exception_without_exception_string
+        expected = {
+            loggerName:"logger_1",
+            level:"INFO",
+            message:"Message",
+            threadName:"",
+            timeStamp:"2008-06-21T12:30:00.0000000+01:00",
+            locationInfo:{
+                className:"?",
+                fileName:"?",
+                lineNumber:"?",
+                methodName:"?"
+            },
+            userName:"",
+            properties:{},
+            exceptionString:"",
+            domain:"",
+            identity:""
+        }
+        logger = FakeLogger.new('logger_1', 'fullname_of_logger_1')
+        tracer = nil
+        data = Exception.new("Message")
+        l = Log4r::LogEvent.new(Log4r::INFO, logger, tracer, data)
+        assert_equal(expected, @outp.serialize(l))
+    end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: elasticelmah
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Oskar Gewalli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'An appender for log4r that appends to elastic search
+
+'
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/elasticelmah.rb
+- tests/elasticelmah_tests.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ElasticSearch log4r appender
+test_files:
+- tests/elasticelmah_tests.rb