pax_global_header 0000666 0000000 0000000 00000000064 11641153335 0014514 g ustar 00root root 0000000 0000000 52 comment=f41cc4f7fe061242fc6b74ccec7b375b8ebb49ef
clojure-tools.logging-d1531f0/ 0000775 0000000 0000000 00000000000 11641153335 0016267 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/.gitignore 0000664 0000000 0000000 00000000007 11641153335 0020254 0 ustar 00root root 0000000 0000000 target
clojure-tools.logging-d1531f0/README.md 0000664 0000000 0000000 00000006317 11641153335 0017555 0 ustar 00root root 0000000 0000000 # Logging
Logging macros which delegate to a specific logging implementation. At runtime a specific implementation is selected from, in order, slf4j, Apache commons-logging, log4j, and finally java.util.logging.
Logging levels are specified by clojure keywords corresponding to the values used in log4j and commons-logging:
:trace, :debug, :info, :warn, :error, :fatal
Logging occurs with the `log` macro, or the level-specific convenience macros, which write either directly or via an agent. The log macros will not evaluate their message arguments unless the specific logging level is in effect. Alternately, you can use the `spy` macro when you have code that needs to be evaluated, and also want to output the code and its result to the log.
Unless otherwise specified, the current namespace (as identified by `*ns*`) will be used as the log-ns (similar to how the java class name is usually used). Note: your logging configuration should display the name that was passed to the logging implementation, and not perform stack-inspection, otherwise you'll see some ugly and unhelpful text in your logs.
Use the `enabled?` macro to write conditional code against the logging level (beyond simply whether or not to call log, which is handled automatically).
You can redirect all java writes of `System.out` and `System.err` to the log system by calling `log-capture!`. To bind `*out*` and `*err*` to the log system invoke `with-logs`. In both cases a log-ns (e.g., "com.example.captured") must be specified in order to namespace the output.
## Usage
The following short example should give you what you need to get started:
(ns example.core
(:use [clojure.tools.logging :only (info error)]))
(defn divide [one two]
(try
(info "Calculated" (/ one two))
(catch Exception ex
(error ex "There was an error in calculation"))))
For those new to using a java logging library, the following is a very basic configuration for log4j. Place it in a file called `log4j.properties` and place that file (and the log4j JAR) on the classpath.
log4j.rootLogger=WARN, A1
log4j.logger.user=DEBUG
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d %-5p %c: %m%n
The above will print messages to the console for `:debug` or higher if one is in the `user` namespace, and `:warn` or higher in all other namespaces.
### Installation
Logging is available in Maven central. Add it to your Maven project's `pom.xml`:
org.clojure
tools.logging
0.2.0
or your leiningen project.clj:
[org.clojure/tools.logging "0.2.0"]
Please note the changelog below.
### Building Logging
0. Clone the repo
1. Make sure you have maven installed
2. Run the maven build; run either:
1. `mvn install`: This will produce a logging jar file in the `target`
directory, and run all tests with the most recently-released build
of Clojure.
## Thanks
* Chris Dean
* Phil Hagelberg
* Richard Newman
* Timothy Pratley
## License
Copyright © 2009 Alex Taggart
Licensed under the EPL. (See the file epl.html.)
clojure-tools.logging-d1531f0/epl.html 0000664 0000000 0000000 00000030536 11641153335 0017744 0 ustar 00root root 0000000 0000000
Eclipse Public License - Version 1.0
Eclipse Public License - v 1.0
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR
DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS
AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial
code and documentation distributed under this Agreement, and
b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program
originate from and are distributed by that particular Contributor. A
Contribution 'originates' from a Contributor if it was added to the
Program by such Contributor itself or anyone acting on such
Contributor's behalf. Contributions do not include additions to the
Program which: (i) are separate modules of software distributed in
conjunction with the Program under their own license agreement, and (ii)
are not derivative works of the Program.
"Contributor" means any person or entity that distributes
the Program.
"Licensed Patents" mean patent claims licensable by a
Contributor which are necessarily infringed by the use or sale of its
Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance
with this Agreement.
"Recipient" means anyone who receives the Program under
this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each
Contributor hereby grants Recipient a non-exclusive, worldwide,
royalty-free copyright license to reproduce, prepare derivative works
of, publicly display, publicly perform, distribute and sublicense the
Contribution of such Contributor, if any, and such derivative works, in
source code and object code form.
b) Subject to the terms of this Agreement, each
Contributor hereby grants Recipient a non-exclusive, worldwide,
royalty-free patent license under Licensed Patents to make, use, sell,
offer to sell, import and otherwise transfer the Contribution of such
Contributor, if any, in source code and object code form. This patent
license shall apply to the combination of the Contribution and the
Program if, at the time the Contribution is added by the Contributor,
such addition of the Contribution causes such combination to be covered
by the Licensed Patents. The patent license shall not apply to any other
combinations which include the Contribution. No hardware per se is
licensed hereunder.
c) Recipient understands that although each Contributor
grants the licenses to its Contributions set forth herein, no assurances
are provided by any Contributor that the Program does not infringe the
patent or other intellectual property rights of any other entity. Each
Contributor disclaims any liability to Recipient for claims brought by
any other entity based on infringement of intellectual property rights
or otherwise. As a condition to exercising the rights and licenses
granted hereunder, each Recipient hereby assumes sole responsibility to
secure any other intellectual property rights needed, if any. For
example, if a third party patent license is required to allow Recipient
to distribute the Program, it is Recipient's responsibility to acquire
that license before distributing the Program.
d) Each Contributor represents that to its knowledge it
has sufficient copyright rights in its Contribution, if any, to grant
the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code
form under its own license agreement, provided that:
a) it complies with the terms and conditions of this
Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors
all warranties and conditions, express and implied, including warranties
or conditions of title and non-infringement, and implied warranties or
conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors
all liability for damages, including direct, indirect, special,
incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this
Agreement are offered by that Contributor alone and not by any other
party; and
iv) states that source code for the Program is available
from such Contributor, and informs licensees how to obtain it in a
reasonable manner on or through a medium customarily used for software
exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each
copy of the Program.
Contributors may not remove or alter any copyright notices contained
within the Program.
Each Contributor must identify itself as the originator of its
Contribution, if any, in a manner that reasonably allows subsequent
Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain
responsibilities with respect to end users, business partners and the
like. While this license is intended to facilitate the commercial use of
the Program, the Contributor who includes the Program in a commercial
product offering should do so in a manner which does not create
potential liability for other Contributors. Therefore, if a Contributor
includes the Program in a commercial product offering, such Contributor
("Commercial Contributor") hereby agrees to defend and
indemnify every other Contributor ("Indemnified Contributor")
against any losses, damages and costs (collectively "Losses")
arising from claims, lawsuits and other legal actions brought by a third
party against the Indemnified Contributor to the extent caused by the
acts or omissions of such Commercial Contributor in connection with its
distribution of the Program in a commercial product offering. The
obligations in this section do not apply to any claims or Losses
relating to any actual or alleged intellectual property infringement. In
order to qualify, an Indemnified Contributor must: a) promptly notify
the Commercial Contributor in writing of such claim, and b) allow the
Commercial Contributor to control, and cooperate with the Commercial
Contributor in, the defense and any related settlement negotiations. The
Indemnified Contributor may participate in any such claim at its own
expense.
For example, a Contributor might include the Program in a commercial
product offering, Product X. That Contributor is then a Commercial
Contributor. If that Commercial Contributor then makes performance
claims, or offers warranties related to Product X, those performance
claims and warranties are such Commercial Contributor's responsibility
alone. Under this section, the Commercial Contributor would have to
defend claims against the other Contributors related to those
performance claims and warranties, and if a court requires any other
Contributor to pay any damages as a result, the Commercial Contributor
must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS
PROVIDED 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. Each Recipient is solely
responsible for determining the appropriateness of using and
distributing the Program and assumes all risks associated with its
exercise of rights under this Agreement , including but not limited to
the risks and costs of program errors, compliance with applicable laws,
damage to or loss of data, programs or equipment, and unavailability or
interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT
NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING
WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR
DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under
applicable law, it shall not affect the validity or enforceability of
the remainder of the terms of this Agreement, and without further action
by the parties hereto, such provision shall be reformed to the minimum
extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against any entity
(including a cross-claim or counterclaim in a lawsuit) alleging that the
Program itself (excluding combinations of the Program with other
software or hardware) infringes such Recipient's patent(s), then such
Recipient's rights granted under Section 2(b) shall terminate as of the
date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it
fails to comply with any of the material terms or conditions of this
Agreement and does not cure such failure in a reasonable period of time
after becoming aware of such noncompliance. If all Recipient's rights
under this Agreement terminate, Recipient agrees to cease use and
distribution of the Program as soon as reasonably practicable. However,
Recipient's obligations under this Agreement and any licenses granted by
Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this
Agreement, but in order to avoid inconsistency the Agreement is
copyrighted and may only be modified in the following manner. The
Agreement Steward reserves the right to publish new versions (including
revisions) of this Agreement from time to time. No one other than the
Agreement Steward has the right to modify this Agreement. The Eclipse
Foundation is the initial Agreement Steward. The Eclipse Foundation may
assign the responsibility to serve as the Agreement Steward to a
suitable separate entity. Each new version of the Agreement will be
given a distinguishing version number. The Program (including
Contributions) may always be distributed subject to the version of the
Agreement under which it was received. In addition, after a new version
of the Agreement is published, Contributor may elect to distribute the
Program (including its Contributions) under the new version. Except as
expressly stated in Sections 2(a) and 2(b) above, Recipient receives no
rights or licenses to the intellectual property of any Contributor under
this Agreement, whether expressly, by implication, estoppel or
otherwise. All rights in the Program not expressly granted under this
Agreement are reserved.
This Agreement is governed by the laws of the State of New York and
the intellectual property laws of the United States of America. No party
to this Agreement will bring a legal action under this Agreement more
than one year after the cause of action arose. Each party waives its
rights to a jury trial in any resulting litigation.
clojure-tools.logging-d1531f0/pom.xml 0000664 0000000 0000000 00000003006 11641153335 0017603 0 ustar 00root root 0000000 0000000
4.0.0
tools.logging
0.2.3
${artifactId}
org.clojure
pom.contrib
0.0.23
Alex Taggart
scm:git:git@github.com:clojure/tools.logging.git
scm:git:git@github.com:clojure/tools.logging.git
git@github.com:clojure/tools.logging.git
org.slf4j
slf4j-api
1.6.2
test
org.slf4j
slf4j-log4j12
1.6.2
test
log4j
log4j
1.2.16
test
commons-logging
commons-logging
1.1.1
test
clojure-tools.logging-d1531f0/src/ 0000775 0000000 0000000 00000000000 11641153335 0017056 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/main/ 0000775 0000000 0000000 00000000000 11641153335 0020002 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/main/clojure/ 0000775 0000000 0000000 00000000000 11641153335 0021445 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/main/clojure/clojure/ 0000775 0000000 0000000 00000000000 11641153335 0023110 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/main/clojure/clojure/tools/ 0000775 0000000 0000000 00000000000 11641153335 0024250 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/main/clojure/clojure/tools/logging.clj 0000664 0000000 0000000 00000024450 11641153335 0026375 0 ustar 00root root 0000000 0000000 ;;; logging.clj -- delegated logging for Clojure
;; by Alex Taggart
;; July 27, 2009
;; Copyright (c) Alex Taggart, July 2009. All rights reserved. The use
;; and distribution terms for this software are covered by the Eclipse
;; Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
;; which can be found in the file epl-v10.html at the root of this
;; distribution. By using this software in any fashion, you are
;; agreeing to be bound by the terms of this license. You must not
;; remove this notice, or any other, from this software.
(ns ^{:author "Alex Taggart"
:doc "Logging macros which delegate to a specific logging implementation. At
runtime a specific implementation is selected from, in order, slf4j,
Apache commons-logging, slf4j, log4j, and finally java.util.logging."}
clojure.tools.logging
[:use
[clojure.string :only [trim-newline]]
[clojure.pprint :only [code-dispatch pprint with-pprint-dispatch]]]
[:require [clojure.tools.logging.impl :as impl]])
(def ^{:doc
"The default agent used for performing logging when direct logging is
disabled. See log* for details." :dynamic true}
*logging-agent* (agent nil :error-mode :continue))
(def ^{:doc
"The set of levels that will require using an agent when logging from within a
running transaction. Defaults to #{:info :warn}. See log* for details." :dynamic true}
*tx-agent-levels* #{:info :warn})
(def ^{:doc
"Overrides the default rules for choosing between logging directly or via an
agent. Defaults to nil. See log* for details." :dynamic true}
*force* nil)
(defn log*
"Attempts to log a message, either directly or via an agent; does not check if
the level is enabled.
For performance reasons, an agent will only be used when invoked within a
running transaction, and only for logging levels specified by
*tx-agent-levels*. This allows those entries to only be written once the
transaction commits, and are discarded if it is retried or aborted. As
corollary, other levels (e.g., :debug, :error) will be written even from
failed transactions though at the cost of repeat messages during retries.
One can override the above by setting *force* to :direct or :agent; all
subsequent writes will be direct or via an agent, respectively."
[logger level throwable message]
(if (cond
(nil? *force*) (and (clojure.lang.LockingTransaction/isRunning)
(*tx-agent-levels* level))
(= *force* :agent) true
(= *force* :direct) false)
(send-off *logging-agent*
(fn [_#] (impl/write! logger level throwable message)))
(impl/write! logger level throwable message)))
(declare ^{:dynamic true} *logger-factory*) ; default LoggerFactory instance for calling impl/get-logger
(defmacro log
"Evaluates and logs a message only if the specified level is enabled. See log*
for more details."
([level message]
`(log ~level nil ~message))
([level throwable message]
`(log ~*ns* ~level ~throwable ~message))
([logger-ns level throwable message]
`(log *logger-factory* ~logger-ns ~level ~throwable ~message))
([logger-factory logger-ns level throwable message]
`(let [logger# (impl/get-logger ~logger-factory ~logger-ns)]
(if (impl/enabled? logger# ~level)
(log* logger# ~level ~throwable ~message)))))
(defmacro logp
"Logs a message using print style args. Can optionally take a throwable as its
second arg. See level-specific macros, e.g., debug."
{:arglists '([level message & more] [level throwable message & more])}
[level x & more]
(if (or (instance? String x) (nil? more)) ; optimize for common case
`(log ~level (print-str ~x ~@more))
`(let [logger# (impl/get-logger *logger-factory* ~*ns*)]
(if (impl/enabled? logger# ~level)
(if (instance? Throwable ~x) ; type check only when enabled
(log* logger# ~level ~x (print-str ~@more))
(log* logger# ~level nil (print-str ~x ~@more)))))))
(defmacro logf
"Logs a message using a format string and args. Can optionally take a
throwable as its second arg. See level-specific macros, e.g., debugf."
{:arglists '([level fmt & fmt-args] [level throwable fmt & fmt-args])}
[level x & more]
(if (or (instance? String x) (nil? more)) ; optimize for common case
`(log ~level (format ~x ~@more))
`(let [logger# (impl/get-logger *logger-factory* ~*ns*)]
(if (impl/enabled? logger# ~level)
(if (instance? Throwable ~x) ; type check only when enabled
(log* logger# ~level ~x (format ~@more))
(log* logger# ~level nil (format ~x ~@more)))))))
(defmacro enabled?
"Returns true if the specific logging level is enabled. Use of this macro
should only be necessary if one needs to execute alternate code paths beyond
whether the log should be written to."
([level]
`(enabled? ~level ~*ns*))
([level logger-ns]
`(impl/enabled? (impl/get-logger *logger-factory* ~logger-ns) ~level)))
(defmacro spy
"Evaluates expr and may write the form and its result to the log. Returns the
result of expr. Defaults to :debug log level."
([expr]
`(spy :debug ~expr))
([level expr]
`(let [a# ~expr]
(log ~level
(let [s# (with-out-str
(with-pprint-dispatch code-dispatch ; need a better way
(pprint '~expr)
(print "=> ")
(pprint a#)))]
(trim-newline s#)))
a#)))
(defn log-stream
"Creates a PrintStream that will output to the log at the specified level."
[level logger-ns]
(let [logger (impl/get-logger *logger-factory* logger-ns)]
(java.io.PrintStream.
(proxy [java.io.ByteArrayOutputStream] []
(flush []
; deal with reflection in proxy-super
(let [^java.io.ByteArrayOutputStream this this]
(proxy-super flush)
(let [message (.trim (.toString this))]
(proxy-super reset)
(if (> (.length message) 0)
(log* logger level nil message))))))
true)))
(let [orig (atom nil) ; holds original System.out and System.err
monitor (Object.)] ; sync monitor for calling setOut/setErr
(defn log-capture!
"Captures System.out and System.err, piping all writes of those streams to
the log. If unspecified, levels default to :info and :error, respectively.
The specified logger-ns value will be used to namespace all log entries.
Note: use with-logs to redirect output of *out* or *err*.
Warning: if the logging implementation is configured to output to System.out
(as is the default with java.util.logging) then using this function will
result in StackOverflowException when writing to the log."
; Implementation Notes:
; - only set orig when nil to preserve original out/err
; - no enabled? check before making streams since that may change later
([logger-ns]
(log-capture! logger-ns :info :error))
([logger-ns out-level err-level]
(locking monitor
(compare-and-set! orig nil [System/out System/err])
(System/setOut (log-stream out-level logger-ns))
(System/setErr (log-stream err-level logger-ns)))))
(defn log-uncapture!
"Restores System.out and System.err to their original values."
[]
(locking monitor
(when-let [[out err :as v] @orig]
(swap! orig (constantly nil))
(System/setOut out)
(System/setErr err)))))
(defmacro with-logs
"Evaluates exprs in a context in which *out* and *err* write to the log. The
specified logger-ns value will be used to namespace all log entries.
By default *out* and *err* write to :info and :error, respectively."
{:arglists '([logger-ns & body]
[[logger-ns out-level err-level] & body])}
[arg & body]
; Implementation Notes:
; - no enabled? check before making writers since that may change later
(let [[logger-ns out-level err-level] (if (vector? arg)
arg
[arg :info :error])]
(if (and logger-ns (seq body))
`(binding [*out* (java.io.OutputStreamWriter.
(log-stream ~out-level ~logger-ns))
*err* (java.io.OutputStreamWriter.
(log-stream ~err-level ~logger-ns))]
~@body))))
;; level-specific macros
(defmacro trace
"Trace level logging using print-style args."
{:arglists '([message & more] [throwable message & more])}
[& args]
`(logp :trace ~@args))
(defmacro debug
"Debug level logging using print-style args."
{:arglists '([message & more] [throwable message & more])}
[& args]
`(logp :debug ~@args))
(defmacro info
"Info level logging using print-style args."
{:arglists '([message & more] [throwable message & more])}
[& args]
`(logp :info ~@args))
(defmacro warn
"Warn level logging using print-style args."
{:arglists '([message & more] [throwable message & more])}
[& args]
`(logp :warn ~@args))
(defmacro error
"Error level logging using print-style args."
{:arglists '([message & more] [throwable message & more])}
[& args]
`(logp :error ~@args))
(defmacro fatal
"Fatal level logging using print-style args."
{:arglists '([message & more] [throwable message & more])}
[& args]
`(logp :fatal ~@args))
(defmacro tracef
"Trace level logging using format."
{:arglists '([fmt & fmt-args] [throwable fmt & fmt-args])}
[& args]
`(logf :trace ~@args))
(defmacro debugf
"Debug level logging using format."
{:arglists '([fmt & fmt-args] [throwable fmt & fmt-args])}
[& args]
`(logf :debug ~@args))
(defmacro infof
"Info level logging using format."
{:arglists '([fmt & fmt-args] [throwable fmt & fmt-args])}
[& args]
`(logf :info ~@args))
(defmacro warnf
"Warn level logging using format."
{:arglists '([fmt & fmt-args] [throwable fmt & fmt-args])}
[& args]
`(logf :warn ~@args))
(defmacro errorf
"Error level logging using format."
{:arglists '([fmt & fmt-args] [throwable fmt & fmt-args])}
[& args]
`(logf :error ~@args))
(defmacro fatalf
"Fatal level logging using format."
{:arglists '([fmt & fmt-args] [throwable fmt & fmt-args])}
[& args]
`(logf :fatal ~@args))
(def ^{:doc
"An instance satisfying the impl/LoggerFactory protocol. Used internally to
obtain an impl/Logger. Defaults to the value returned from impl/find-factory."
:dynamic true}
*logger-factory*
(impl/find-factory))
clojure-tools.logging-d1531f0/src/main/clojure/clojure/tools/logging/ 0000775 0000000 0000000 00000000000 11641153335 0025676 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/main/clojure/clojure/tools/logging/impl.clj 0000664 0000000 0000000 00000017106 11641153335 0027336 0 ustar 00root root 0000000 0000000 ;; Copyright (c) Alex Taggart. All rights reserved. The use
;; and distribution terms for this software are covered by the Eclipse
;; Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
;; which can be found in the file epl-v10.html at the root of this
;; distribution. By using this software in any fashion, you are
;; agreeing to be bound by the terms of this license. You must not
;; remove this notice, or any other, from this software.
(ns ^{:author "Alex Taggart"
:doc "Protocols used to allow access to logging implementations.
This namespace only need be used by those providing logging
implementations to be consumed by the core api."}
clojure.tools.logging.impl
(:refer-clojure :exclude [name]))
(defprotocol Logger
"The protocol through which the core api will interact with an underlying logging
implementation. Implementations should at least support the six standard
logging levels if they wish to work from the level-specific macros."
(enabled? [logger level]
"Check if a particular level is enabled for the given Logger.")
(write! [logger level throwable message]
"Writes a log message to the given Logger."))
(defprotocol LoggerFactory
"The protocol through which the core api will obtain an instance satisfying Logger
as well as providing information about the particular implementation being used.
Implementations should be bound to *logger-factory* in order to be picked up by
this library."
(name [factory]
"Returns some text identifying the underlying implementation.")
(get-logger [factory logger-ns]
"Returns an implementation-specific Logger by namespace."))
(defn slf4j-factory
"Returns a SLF4J-based implementation of the LoggerFactory protocol, or nil if
not available."
[]
(try
(Class/forName "org.slf4j.Logger")
(eval
`(do
(extend org.slf4j.Logger
Logger
{:enabled?
(fn [logger# level#]
(condp = level#
:trace (.isTraceEnabled logger#)
:debug (.isDebugEnabled logger#)
:info (.isInfoEnabled logger#)
:warn (.isWarnEnabled logger#)
:error (.isErrorEnabled logger#)
:fatal (.isErrorEnabled logger#)
(throw (IllegalArgumentException. (str level#)))))
:write!
(fn [^org.slf4j.Logger logger# level# ^Throwable e# msg#]
(let [^String msg# (str msg#)]
(condp = level#
:trace (.trace logger# msg# e#)
:debug (.debug logger# msg# e#)
:info (.info logger# msg# e#)
:warn (.warn logger# msg# e#)
:error (.error logger# msg# e#)
:fatal (.error logger# msg# e#)
(throw (IllegalArgumentException. (str level#))))))})
(reify LoggerFactory
(name [_#]
"org.slf4j")
(get-logger [_# logger-ns#]
(org.slf4j.LoggerFactory/getLogger ^String (str logger-ns#))))))
(catch Exception e nil)))
(defn cl-factory
"Returns a Commons Logging-based implementation of the LoggerFactory protocol, or
nil if not available."
[]
(try
(Class/forName "org.apache.commons.logging.Log")
(eval
`(do
(extend org.apache.commons.logging.Log
Logger
{:enabled?
(fn [logger# level#]
(condp = level#
:trace (.isTraceEnabled logger#)
:debug (.isDebugEnabled logger#)
:info (.isInfoEnabled logger#)
:warn (.isWarnEnabled logger#)
:error (.isErrorEnabled logger#)
:fatal (.isFatalEnabled logger#)
(throw (IllegalArgumentException. (str level#)))))
:write!
(fn [logger# level# e# msg#]
(condp = level#
:trace (.trace logger# msg# e#)
:debug (.debug logger# msg# e#)
:info (.info logger# msg# e#)
:warn (.warn logger# msg# e#)
:error (.error logger# msg# e#)
:fatal (.fatal logger# msg# e#)
(throw (IllegalArgumentException. (str level#)))))})
(reify LoggerFactory
(name [_#]
"org.apache.commons.logging")
(get-logger [_# logger-ns#]
(org.apache.commons.logging.LogFactory/getLog (str logger-ns#))))))
(catch Exception e nil)))
(defn log4j-factory
"Returns a Log4j-based implementation of the LoggerFactory protocol, or nil if
not available."
[]
(try
(Class/forName "org.apache.log4j.Logger")
(eval
`(let [levels# {:trace org.apache.log4j.Level/TRACE
:debug org.apache.log4j.Level/DEBUG
:info org.apache.log4j.Level/INFO
:warn org.apache.log4j.Level/WARN
:error org.apache.log4j.Level/ERROR
:fatal org.apache.log4j.Level/FATAL}]
(extend org.apache.log4j.Logger
Logger
{:enabled?
(fn [logger# level#]
(.isEnabledFor logger#
(or
(levels# level#)
(throw (IllegalArgumentException. (str level#))))))
:write!
(fn [logger# level# e# msg#]
(let [level# (or
(levels# level#)
(throw (IllegalArgumentException. (str level#))))]
(if-not e#
(.log logger# level# msg#)
(.log logger# level# msg# e#))))})
(reify LoggerFactory
(name [_#]
"org.apache.log4j")
(get-logger [_# logger-ns#]
(org.apache.log4j.Logger/getLogger ^String (str logger-ns#))))))
(catch Exception e nil)))
(defn jul-factory
"Returns a java.util.logging-based implementation of the LoggerFactory protocol,
or nil if not available."
[]
(try
(Class/forName "java.util.logging.Logger")
(eval
`(let [levels# {:trace java.util.logging.Level/FINEST
:debug java.util.logging.Level/FINE
:info java.util.logging.Level/INFO
:warn java.util.logging.Level/WARNING
:error java.util.logging.Level/SEVERE
:fatal java.util.logging.Level/SEVERE}]
(extend java.util.logging.Logger
Logger
{:enabled?
(fn [logger# level#]
(.isLoggable logger#
(or
(levels# level#)
(throw (IllegalArgumentException. (str level#))))))
:write!
(fn [logger# level# ^Throwable e# msg#]
(let [^java.util.logging.Level level#
(or
(levels# level#)
(throw (IllegalArgumentException. (str level#))))
^String msg# (str msg#)]
(if e#
(.log logger# level# msg# e#)
(.log logger# level# msg#))))})
(reify LoggerFactory
(name [_#]
"java.util.logging")
(get-logger [_# logger-ns#]
(java.util.logging.Logger/getLogger (str logger-ns#))))))
(catch Exception e nil)))
(defn find-factory
"Returns the first non-nil value from slf4j-factory, cl-factory,
log4j-factory, and jul-factory."
[]
(or (slf4j-factory)
(cl-factory)
(log4j-factory)
(jul-factory)
(throw ; this should never happen in 1.5+
(RuntimeException.
"Valid logging implementation could not be found.")))) clojure-tools.logging-d1531f0/src/test/ 0000775 0000000 0000000 00000000000 11641153335 0020035 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/test/clojure/ 0000775 0000000 0000000 00000000000 11641153335 0021500 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/test/clojure/clojure/ 0000775 0000000 0000000 00000000000 11641153335 0023143 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/test/clojure/clojure/tools/ 0000775 0000000 0000000 00000000000 11641153335 0024303 5 ustar 00root root 0000000 0000000 clojure-tools.logging-d1531f0/src/test/clojure/clojure/tools/test_logging.clj 0000664 0000000 0000000 00000021137 11641153335 0027466 0 ustar 00root root 0000000 0000000 (ns clojure.tools.test-logging
[:use clojure.test
clojure.tools.logging]
[:require [clojure.tools.logging.impl :as impl]])
(deftest test-impls
(are [lf] (binding [*logger-factory* lf]
(enabled? :fatal))
(impl/slf4j-factory)
(impl/cl-factory)
(impl/log4j-factory)
(impl/jul-factory)))
(def ^{:dynamic true} *entries* (atom []))
(defn test-factory [enabled-set]
(reify impl/LoggerFactory
(name [_] "test factory")
(get-logger [_ log-ns]
(reify impl/Logger
(enabled? [_ level] (contains? enabled-set level))
(write! [_ lvl ex msg]
(swap! *entries* conj [(str log-ns) lvl ex msg]))))))
(use-fixtures :once
(fn [f]
(binding [*logger-factory*
(test-factory #{:trace :debug :info :warn :error :fatal})]
(f))))
(use-fixtures :each
(fn [f]
(f)
(swap! *entries* (constantly []))))
(deftest log-msg
(log :debug "foo")
(is (= ["clojure.tools.test-logging"
:debug
nil
"foo"]
(peek @*entries*))))
(deftest log-ex
(let [e (Exception.)]
(log :debug e "foo")
(is (= ["clojure.tools.test-logging"
:debug
e
"foo"]
(peek @*entries*)))))
(deftest log-custom-ns
(let [e (Exception.)]
(log "other.ns" :debug e "foo")
(is (= ["other.ns"
:debug
e
"foo"]
(peek @*entries*)))))
(comment ; Tests failing on build machine for some unknown reason.
; See http://groups.google.com/group/clojure-dev/browse_thread/thread/fde32342f3c006bd
(deftest log-tx-agent
(let [flag (atom false)
so send-off]
(binding [send-off (fn [a f & args]
(compare-and-set! flag false true)
(apply so a f args))]
(dosync
(log :info "foo")))
(await *logging-agent*)
(is (= ["clojure.tools.test-logging"
:info
nil
"foo"]
(peek @*entries*)))
(is (true? @flag))))
(deftest log-tx-noagent
(let [flag (atom false)
so send-off]
(binding [send-off (fn [a f & args]
(compare-and-set! flag false true)
(apply so a f args))]
(dosync
(log :error "foo")))
(await *logging-agent*)
(is (= ["clojure.tools.test-logging"
:error
nil
"foo"]
(peek @*entries*)))
(is (false? @flag))))
(deftest log-alter-tx-agent-levels
(let [flag (atom false)
so send-off]
(binding [send-off (fn [a f & args]
(compare-and-set! flag false true)
(apply so a f args))
*tx-agent-levels* #{:error}]
(dosync
(log :error "foo")))
(await *logging-agent*)
(is (= ["clojure.tools.test-logging"
:error
nil
"foo"]
(peek @*entries*)))
(is (true? @flag))))
(deftest log-force-agent
(let [flag (atom false)
so send-off]
(binding [send-off (fn [a f & args]
(compare-and-set! flag false true)
(apply so a f args))
*force* :agent]
(log :debug "foo"))
(await *logging-agent*)
(is (= ["clojure.tools.test-logging"
:debug
nil
"foo"]
(peek @*entries*)))
(is (true? @flag))))
(deftest log-force-direct
(let [flag (atom false)
so send-off]
(binding [send-off (fn [a f & args]
(compare-and-set! flag false true)
(apply so a f args))
*force* :direct]
(dosync
(log :info "foo")))
(await *logging-agent*)
(is (= ["clojure.tools.test-logging"
:info
nil
"foo"]
(peek @*entries*)))
(is (false? @flag))))
)
(deftest logp-msg-no-optimize
(let [a "foo"
b "bar"]
(logp :debug a b))
(is (= ["clojure.tools.test-logging"
:debug
nil
"foo bar"]
(peek @*entries*))))
(deftest logp-msg1
(logp :debug "hello")
(is (= ["clojure.tools.test-logging"
:debug
nil
"hello"]
(peek @*entries*))))
(deftest logp-msg2
(logp :debug "hello" "world")
(is (= ["clojure.tools.test-logging"
:debug
nil
"hello world"]
(peek @*entries*))))
(deftest logp-ex0
(let [e (Exception.)]
(logp :debug e)
(is (= ["clojure.tools.test-logging"
:debug
nil
(print-str e)]
(peek @*entries*)))))
(deftest logp-ex1
(let [e (Exception.)]
(logp :debug e "hello")
(is (= ["clojure.tools.test-logging"
:debug
e
"hello"]
(peek @*entries*)))))
(deftest logp-ex2
(let [e (Exception.)]
(logp :debug e "hello" "world")
(is (= ["clojure.tools.test-logging"
:debug
e
"hello world"]
(peek @*entries*)))))
(deftest logf-msg-no-optimize
(let [a "foo %s"
b "bar"]
(logf :debug a b))
(is (= ["clojure.tools.test-logging"
:debug
nil
"foo bar"]
(peek @*entries*))))
(deftest logf-msg1
(logf :debug "hello")
(is (= ["clojure.tools.test-logging"
:debug
nil
"hello"]
(peek @*entries*))))
(deftest logf-msg3
(logf :debug "%s %s" "hello" "world")
(is (= ["clojure.tools.test-logging"
:debug
nil
"hello world"]
(peek @*entries*))))
(deftest logf-ex0
(is (thrown? Exception (logf :debug (Exception.)))))
(deftest logf-ex3
(let [e (Exception.)]
(logf :debug e "%s %s" "hello" "world")
(is (= ["clojure.tools.test-logging"
:debug
e
"hello world"]
(peek @*entries*)))))
(deftest enabled-true
(is (= true (enabled? :fatal))))
(deftest enabled-false
(binding [*logger-factory* (test-factory #{})]
(is (= false (enabled? :fatal)))))
(deftest spy-default
(spy (+ 4 5))
(is (= ["clojure.tools.test-logging"
:debug
nil
(format "(+ 4 5)%n=> 9")]
(peek @*entries*))))
(deftest spy-level
(spy :fatal (+ 4 5))
(is (= ["clojure.tools.test-logging"
:fatal
nil
(format "(+ 4 5)%n=> 9")]
(peek @*entries*))))
(comment
(deftest capturing
(log-capture! "foobar")
(.println System/out "hello world")
(is (= ["foobar"
:info
nil
"hello world"]
(peek @*entries*)))
(.println System/err "oh noes")
(is (= ["foobar"
:error
nil
"oh noes"]
(peek @*entries*)))
(log-uncapture!))
(deftest capturing-level
(log-capture! "foobar" :error :fatal)
(.println System/out "hello world")
(is (= ["foobar"
:error
nil
"hello world"]
(peek @*entries*)))
(.println System/err "oh noes")
(is (= ["foobar"
:fatal
nil
"oh noes"]
(peek @*entries*)))
(log-uncapture!))
(deftest with-logs-default
(with-logs "foobar" (println "hello world"))
(is (= ["foobar"
:info
nil
"hello world"]
(peek @*entries*))))
(deftest with-logs-level
(with-logs ["foobar" :fatal :fatal] (println "hello world"))
(is (= ["foobar"
:fatal
nil
"hello world"]
(peek @*entries*))))
)
(deftest println-style
(are [f kw]
(= ["clojure.tools.test-logging"
kw
nil
"hello world"]
(do
(f "hello" "world")
(peek @*entries*)))
trace :trace
debug :debug
info :info
warn :warn
error :error
fatal :fatal))
(deftest println-style-ex
(let [e (Exception.)]
(are [f kw]
(= ["clojure.tools.test-logging"
kw
e
"hello world"]
(do
(f e "hello" "world")
(peek @*entries*)))
trace :trace
debug :debug
info :info
warn :warn
error :error
fatal :fatal)))
(deftest format-style
(are [f kw]
(= ["clojure.tools.test-logging"
kw
nil
"hello world"]
(do
(f "%s %s" "hello" "world")
(peek @*entries*)))
tracef :trace
debugf :debug
infof :info
warnf :warn
errorf :error
fatalf :fatal))
(deftest format-style-ex
(let [e (Exception.)]
(are [f kw]
(= ["clojure.tools.test-logging"
kw
e
"hello world"]
(do
(f e "%s %s" "hello" "world")
(peek @*entries*)))
tracef :trace
debugf :debug
infof :info
warnf :warn
errorf :error
fatalf :fatal)))
clojure-tools.logging-d1531f0/src/test/clojure/log4j.properties 0000664 0000000 0000000 00000000301 11641153335 0024627 0 ustar 00root root 0000000 0000000 log4j.rootLogger=TRACE, A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d %-5p %c: %m%n