semantic_logger 0.0.2

data/FUTURE.rb

@@ -0,0 +1,211 @@
+
+# Return the logger for a specific class, supports class specific log levels
+# Clarity::Logger.logger(MyClass)
+# # OR
+# Clarity::Logger.logger('MyClass')
+#
+# # Switch to slf4j as the underlying implementation
+# Clarity::Logger.impl = slf4j
+#
+# logging.yml
+#
+# # Replace the Rails Logger
+# Rails.logger = Clarity::Logger.logger(Rails)
+#
+#
+#
+# # Thread specific context information to be logged with every log entry
+# #
+# # Add metadata information within a block to all log calls on This Thread
+# logger.with_metadata(:tracking_number=>12345) do
+#   # Any log entries within this block will have this metadata added to it
+#   logger.debug('Hello World', :result => 'blah')
+# end
+#
+# # If a block cannot be used to set the scope of context
+# # Set global metadata for every log entry on this machine
+# logger['host_name'] = 'blah'
+# logger.metadata = { 'host_name' => 'blah' }
+#
+# # Add metadata information to all log entries with this logger name
+# logger = SymanticLogger.logger('com.app.myclass')
+# logger.metadata = { 'target_host' => 'vendorX' }
+#
+# # Clear out the current thread logging context
+# logger.clear_metadata
+# # OR
+# logger.metadata = nil
+#
+# # Note: It is important to remove context information when no longer applicable:
+# begin
+#   logger['tracking_number'] = 12345
+# ensure
+#   logger.clear_context
+# end
+#
+# # Benchmark and log in ms the time taken to process supplied.
+# # Additional context can be added
+# # On completion of the block, a log entry will be written adding
+# # 'duration' as a context variable set to the ms taken to process the block
+# # Parameters
+# #   Takes either a text message, or a context hash for that block
+# # Benchmarking is only performed and logged if the supplied log level is active
+# #  - The code block is always executed
+# logger.benchmark(:info, message, 'tracking_number'=>12345) do
+#   # Any log entries within this block will have this context added to it
+#   logger.debug('Hello World', :result => 'blah')
+# end
+#
+# Example:
+#
+# logger.debug('hello world', exc) {  }
+#
+# # Add to initializer:
+# new_logger = Logger.new(File.join(RAILS_ROOT, "log", "new_logger_#{RAILS_ENV}.log"), 'daily')
+# new_logger.formatter = Logger::Formatter.new
+#
+# # In environment.rb:
+# Rails::Initializer.run do |config|
+#
+#   config.active_record.logger = new_logger
+#   config.action_controller.logger = new_logger
+#
+#   ....
+# end
+#
+# Log and benchmark the workings of a single block and silence whatever logging that may have happened inside it
+# (unless <tt>use_silence</tt> is set to false).
+#
+# The benchmark is only recorded if the current level of the logger matches the <tt>log_level</tt>, which makes it
+# easy to include benchmarking statements in production software that will remain inexpensive because the benchmark
+# will only be conducted if the log level is low enough.
+#
+#  def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
+#    if logger && logger.level == log_level
+#      result = nil
+#      ms = Benchmark.ms { result = use_silence ? silence { yield } : yield }
+#      logger.add(log_level, "#{title} (#{('%.1f' % ms)}ms)")
+#      result
+#    else
+#      yield
+#    end
+#  end
+#
+
+
+
+
+
+# Research results of looking into other loggers:
+#
+# Central Logger: - Request level logging only, not per log call - Not Threadsafe!
+#    {
+#      'action'           : action_name,
+#      'application_name' : application_name (rails root),
+#      'controller'       : controller_name,
+#      'ip'               : ip_address,
+#      'messages'         : {
+#                             'info'  : [ ],
+#                             'debug' : [ ],
+#                             'error' : [ ],
+#                             'warn'  : [ ],
+#                             'fatal' : [ ]
+#                           },
+#      'params'           : { },
+#      'path'             : path,
+#      'request_time'     : date_of_request,
+#      'runtime'          : elapsed_execution_time_in_milliseconds,
+#      'url'              : full_url
+#    }
+# Rails.logger.add_metadata
+#
+# log4mongo:
+#{{
+#  "_id" : ObjectId("4c60e21be54744706960af09"),
+#  "timestamp" : "Mon Aug 09 2010 22:22:35 GMT-0700 (PDT)",
+#  "level" : "ERROR",
+#  "thread" : "main",
+#  "message" : "Don't panic",
+#  "fileName" : "LogTest.java",
+#  "method" : "main",
+#  "lineNumber" : "8",
+#  "class" : {
+#    "fullyQualifiedClassName" : "LogTest",
+#    "package" : [
+#      ""
+#    ],
+#    "className" : "LogTest"
+#  }
+#  "loggerName" : {
+#    "fullyQualifiedClassName" : "LogTest",
+#    "package" : [
+#      ""
+#    ],
+#    "className" : "LogTest"
+#  }
+#}
+#
+# slf4j:
+#{
+#    "_id" : ObjectId("4d9cbcbf7abb3abdaf9679cd"),
+#    "timeStamp" : ISODate("2011-04-06T19:19:27.006Z"),
+#    "level" : "ERROR",
+#    "thread" : "main",
+#    "logger" : "ch.qos.logback.classic.db.mongo.MongoDBAppenderTest",
+#    "message" : "D"
+#}
+#
+#
+# slf4j Access Logs:
+#{
+#    "_id" : ObjectId("4d98cc4f7abb95e59279e183"),
+#    "timeStamp" : ISODate("2011-04-03T19:36:47.339Z"),
+#    "server" : "localhost",
+#    "remote" : {
+#        "host" : "0:0:0:0:0:0:0:1",
+#        "user" : "tomcat",
+#        "addr" : "0:0:0:0:0:0:0:1"
+#    },
+#    "request" : {
+#        "uri" : "/manager/images/tomcat.gif",
+#        "protocol" : "HTTP/1.1",
+#        "method" : "GET",
+#        "sessionId" : "1C6357816D9EEFD31F6D9D154D87308A",
+#        "userAgent" : "Mozilla/5.0 (X11; U; Linux i686; pl-PL; rv:1.9.2.16) Gecko/20110323 Ubuntu/10.10 (maverick) Firefox/3.6.16",
+#        "referer" : "http://localhost:8080/manager/html"
+#    },
+#    "response" : {
+#        "contentLength" : NumberLong(1934),
+#        "statusCode" : 200
+#    }
+#}
+#
+# Logging:
+#
+#   'logger'     Used to output the name of the logger that generated the
+#                log event.
+#   'timestamp'  Used to output the timestamp of the log event.
+#   'level'      Used to output the level of the log event.
+#   'message'    Used to output the application supplied message
+#                associated with the log event.
+#   'file'       Used to output the file name where the logging request
+#                was issued.
+#   'line'       Used to output the line number where the logging request
+#                was issued.
+#   'method'     Used to output the method name where the logging request
+#                was issued.
+#   'pid'        Used to output the process ID of the currently running
+#                program.
+#   'millis'     Used to output the number of milliseconds elapsed from
+#                the construction of the Layout until creation of the log
+#                event.
+#   'thread_id'  Used to output the object ID of the thread that generated
+#                the log event.
+#   'thread'     Used to output the name of the thread that generated the
+#                log event. Name can be specified using Thread.current[:name]
+#                notation. Output empty string if name not specified. This
+#                option helps to create more human readable output for
+#                multithread application logs.
+
+
+

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 Clarity Services, Inc.
+
+   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/README.md

@@ -0,0 +1,131 @@
+semantic-logger-ruby
+====================
+
+* http://github.com/ClarityServices/semantic-logger-ruby
+
+Feedback is welcome and appreciated :)
+
+### Introduction
+
+SemanticLogger is a Logger that supports logging of meta-data, not only text messages
+
+Machines can understand the logged data without having to use
+complex Regular Expressions or other text parsing techniques
+
+SemanticLogger, sits on top of existing logger implementations and can also
+be used as a drop in replacement for existing Ruby loggers.
+This allows the existing logging to be replaced immediately with the
+SemanticLogger Appenders, and over time the calls can be replaced with ones
+that contain the necessary meta-data.
+
+Example of current calls:
+
+    logger.info("Queried users table in #{duration} ms, with a result code of #{result}")
+
+For a machine to find all queries for table 'users' that took longer than
+100 ms, would require using a regular expression just to extract the table name
+and duration, then apply the necessary logic. It also assumes that the text
+is not changed and that matches will not be found when another log entry has
+similar text output.
+
+This can be changed over time to:
+
+    Rails.logger.info("Queried table",
+           :duration => duration,
+           :result   => result,
+           :table    => "users",
+           :action   => "query")
+
+Using this semantic example, a machine can easily find all queries for table
+'users' that took longer than 100 ms.
+
+    db.logs.find({"data.table":"users", "data.action":"query"})
+
+Since SemanticLogger can call existing Loggers, it does not force end-users
+to have to adopt a Semantic aware adapter. Although, such adapters create
+tremendous value in the problem monitoring and determination processes.
+
+For ease of use each Appender can be used directly if required. It is preferred
+however to use the SemanticLogger interface and supply the configuration to it.
+In this way the adapter can be changed without modifying the application
+source code.
+
+# Future
+- Web Interface to view and search log information
+- Override the log level at the appender level
+
+# Configuration
+
+The Semantic Logger follows the principle where multiple appenders can be active
+at the same time. This allows one to log to MongoDB and the Rails
+ActiveResource::BufferedLogger at the same time.
+
+### Dependencies
+
+- Ruby MRI 1.8.7 (or above) Or, JRuby 1.6.3 (or above)
+- Optional: Rails 3.0.10 (or above)
+- Optional: To log to MongoDB, Mongo Ruby Driver 1.5.2 or above
+
+### Install
+
+  gem install semantic-logger
+
+Development
+-----------
+
+Want to contribute to Semantic Logger?
+
+First clone the repo and run the tests:
+
+    git clone git://github.com/ClarityServices/semantic-logger.git
+    cd semantic-logger
+    jruby -S rake test
+
+Feel free to ping the mailing list with any issues and we'll try to resolve it.
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. [Fork](http://help.github.com/forking/) semantic-logger
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue](http://github.com/ClarityServices/semantic-logger/issues) with a link to your branch
+5. That's it!
+
+We are looking for volunteers to create implementations in other languages such as:
+* Java, C# and Go
+
+Meta
+----
+
+* Code: `git clone git://github.com/ClarityServices/semantic-logger.git`
+* Home: <https://github.com/ClarityServices/semantic-logger>
+* Docs: TODO <http://ClarityServices.github.com/semantic-logger/>
+* Bugs: <http://github.com/reidmorrison/semantic-logger/issues>
+* Gems: <http://rubygems.org/gems/semantic-logger>
+
+This project uses [Semantic Versioning](http://semver.org/).
+
+Authors
+-------
+
+Reid Morrison :: reidmo@gmail.com :: @reidmorrison
+
+License
+-------
+
+Copyright 2011 Clarity Services, Inc.
+
+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.