Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Initial conversion

  • Loading branch information...
commit 4ee20655311f532dc9aa8259139bf52318b8b2b9 0 parents
@abedra abedra authored
1  .gitignore
@@ -0,0 +1 @@
+target
59 README.md
@@ -0,0 +1,59 @@
+# Logging
+
+Logging macros which delegate to a specific logging implementation. At runtime a specific implementation is selected from, in order, Apache commons-logging, slf4j, 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' 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 log 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
+
+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`:
+
+ <dependency>
+ <groupId>org.clojure</groupId>
+ <artifactId>tools.logging</artifactId>
+ <version>0.1.0-SNAPSHOT</version>
+ </dependency>
+
+or your leiningen project.clj:
+
+ [org.clojure/tools.logging "0.1.0-SNAPSHOT"]
+
+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 package`: This will produce a logging jar file in the `target`
+directory, and run all tests with the most recently-released build
+of Clojure (currently 1.2.0). Or,
+ 2. `mvn verify`: This does the same, but also runs the tests with
+other Clojure "profiles" (currently v1.1.0 and v1.1.0 + clojure-contrib).
+
+## Thanks
+
+* Chris Dean
+* Phil Hagelberg
+* Richard Newman
+* Timothy Pratley
+
+## License
+
+Copyright © 2009 Alex Taggart
+
+Licensed under the EPL. (See the file epl.html.)
261 epl.html
@@ -0,0 +1,261 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+<title>Eclipse Public License - Version 1.0</title>
+<style type="text/css">
+ body {
+ size: 8.5in 11.0in;
+ margin: 0.25in 0.5in 0.25in 0.5in;
+ tab-interval: 0.5in;
+ }
+ p {
+ margin-left: auto;
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+ }
+ p.list {
+ margin-left: 0.5in;
+ margin-top: 0.05em;
+ margin-bottom: 0.05em;
+ }
+ </style>
+
+</head>
+
+<body lang="EN-US">
+
+<h2>Eclipse Public License - v 1.0</h2>
+
+<p>THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+PUBLIC LICENSE (&quot;AGREEMENT&quot;). ANY USE, REPRODUCTION OR
+DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS
+AGREEMENT.</p>
+
+<p><b>1. DEFINITIONS</b></p>
+
+<p>&quot;Contribution&quot; means:</p>
+
+<p class="list">a) in the case of the initial Contributor, the initial
+code and documentation distributed under this Agreement, and</p>
+<p class="list">b) in the case of each subsequent Contributor:</p>
+<p class="list">i) changes to the Program, and</p>
+<p class="list">ii) additions to the Program;</p>
+<p class="list">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.</p>
+
+<p>&quot;Contributor&quot; means any person or entity that distributes
+the Program.</p>
+
+<p>&quot;Licensed Patents&quot; 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.</p>
+
+<p>&quot;Program&quot; means the Contributions distributed in accordance
+with this Agreement.</p>
+
+<p>&quot;Recipient&quot; means anyone who receives the Program under
+this Agreement, including all Contributors.</p>
+
+<p><b>2. GRANT OF RIGHTS</b></p>
+
+<p class="list">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.</p>
+
+<p class="list">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.</p>
+
+<p class="list">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.</p>
+
+<p class="list">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.</p>
+
+<p><b>3. REQUIREMENTS</b></p>
+
+<p>A Contributor may choose to distribute the Program in object code
+form under its own license agreement, provided that:</p>
+
+<p class="list">a) it complies with the terms and conditions of this
+Agreement; and</p>
+
+<p class="list">b) its license agreement:</p>
+
+<p class="list">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;</p>
+
+<p class="list">ii) effectively excludes on behalf of all Contributors
+all liability for damages, including direct, indirect, special,
+incidental and consequential damages, such as lost profits;</p>
+
+<p class="list">iii) states that any provisions which differ from this
+Agreement are offered by that Contributor alone and not by any other
+party; and</p>
+
+<p class="list">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.</p>
+
+<p>When the Program is made available in source code form:</p>
+
+<p class="list">a) it must be made available under this Agreement; and</p>
+
+<p class="list">b) a copy of this Agreement must be included with each
+copy of the Program.</p>
+
+<p>Contributors may not remove or alter any copyright notices contained
+within the Program.</p>
+
+<p>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.</p>
+
+<p><b>4. COMMERCIAL DISTRIBUTION</b></p>
+
+<p>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
+(&quot;Commercial Contributor&quot;) hereby agrees to defend and
+indemnify every other Contributor (&quot;Indemnified Contributor&quot;)
+against any losses, damages and costs (collectively &quot;Losses&quot;)
+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.</p>
+
+<p>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.</p>
+
+<p><b>5. NO WARRANTY</b></p>
+
+<p>EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS
+PROVIDED ON AN &quot;AS IS&quot; 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.</p>
+
+<p><b>6. DISCLAIMER OF LIABILITY</b></p>
+
+<p>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.</p>
+
+<p><b>7. GENERAL</b></p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+<p>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.</p>
+
+</body>
+
+</html>
61 pom.xml
@@ -0,0 +1,61 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>tools.logging</artifactId>
+ <version>0.1.0-SNAPSHOT</version>
+ <name>logging</name>
+
+ <parent>
+ <groupId>org.clojure</groupId>
+ <artifactId>pom.contrib</artifactId>
+ <version>0.0.20</version>
+ </parent>
+
+ <developers>
+ <developer>
+ <name>Alex Taggart</name>
+ </developer>
+ </developers>
+
+ <scm>
+ <connection>scm:git:git@github.com:clojure/tools.logging.git</connection>
+ <developerConnection>scm:git:git@github.com:clojure/tools.logging.git</developerConnection>
+ <url>git@github.com:clojure/tools.logging.git</url>
+ </scm>
+
+ <repositories>
+ <!-- if our parent pom were a release (and in central), then this would be unnecessary -->
+ <repository>
+ <id>sonatype-oss-snapshots</id>
+ <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+ </repository>
+ </repositories>
+
+ <properties>
+ <clojure.version>1.2.0</clojure.version>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-invoker-plugin</artifactId>
+ <version>1.5</version>
+ <configuration>
+ <pomIncludes>
+ <pomInclude>*/pom.xml</pomInclude>
+ </pomIncludes>
+ <streamLogs>true</streamLogs>
+ <goals><goal>clojure:test</goal></goals>
+ <mavenOpts>-Duser.dir=${basedir}</mavenOpts>
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>install</goal>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project>
452 src/main/clojure/clojure/tools/logging.clj
@@ -0,0 +1,452 @@
+;;; 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, Apache
+ commons-logging, slf4j, log4j, and finally java.util.logging."}
+ clojure.tools.logging
+ [:use [clojure.pprint :only [code-dispatch pprint with-pprint-dispatch]]])
+
+(defprotocol Log
+ "The protocol through which macros will interact with an underlying logging
+ implementation. Implementations should at least support the six specified
+ logging levels if they wish to benefit from the level-specific macros."
+ (impl-enabled? [log level]
+ "Implementation-specific check if a particular level is enabled. End-users
+ should not need to call this.")
+ (impl-write! [log level throwable message]
+ "Implementation-specific write of a log message. End-users should not need
+ to call this."))
+
+(defprotocol LogFactory
+ "The protocol through which macros will obtain an instance satisfying Log as
+ well as providing information about the particular implementation being used.
+ Implementations should be bound to *log-factory* in order to be picked up by
+ this library."
+ (impl-name [factory]
+ "Returns some text identifying the underlying implementation.")
+ (impl-get-log [factory log-ns]
+ "Returns an implementation-specific Log by namespace. End-users should not
+ need to call this."))
+
+(def ^{:doc
+ "The default agent used for performing logging when direct logging is
+ disabled. See log* for details."}
+ *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."}
+ *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."}
+ *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."
+ [log 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! log level throwable message)))
+ (impl-write! log level throwable message)))
+
+(declare *log-factory*) ; default LogFactory instance for calling impl-get-log
+
+(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))
+ ([log-ns level throwable message]
+ `(log *log-factory* ~log-ns ~level ~throwable ~message))
+ ([log-factory log-ns level throwable message]
+ `(let [log# (impl-get-log ~log-factory ~log-ns)]
+ (if (impl-enabled? log# ~level)
+ (log* log# ~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 [log# (impl-get-log *log-factory* ~*ns*)]
+ (if (impl-enabled? log# ~level)
+ (if (instance? Throwable ~x) ; type check only when enabled
+ (log* log# ~level ~x (print-str ~@more))
+ (log* log# ~level (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 [log# (impl-get-log *log-factory* ~*ns*)]
+ (if (impl-enabled? log# ~level)
+ (if (instance? Throwable ~x) ; type check only when enabled
+ (log* log# ~level ~x (format ~(first more) ~@(next more)))
+ (log* log# ~level (format ~x ~@more)))))))
+
+(defmacro enabled?
+ "Returns true if the specific logging level is enabled. Use of this function
+ 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 log-ns]
+ `(impl-enabled? (impl-get-log *log-factory* ~log-ns) ~level)))
+
+(defmacro spy
+ "Evaluates expr and writes 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#)))]
+ (.substring s# 0 (dec (count s#))))) ; trim off the trailing newline
+ a#)))
+
+(defn log-stream
+ "Creates a PrintStream that will output to the log at the specified level."
+ [level log-ns]
+ (let [log (impl-get-log *log-factory* log-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* log 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 log-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
+ ([log-ns]
+ (log-capture! log-ns :info :error))
+ ([log-ns out-level err-level]
+ (locking monitor
+ (compare-and-set! orig nil [System/out System/err])
+ (System/setOut (log-stream out-level log-ns))
+ (System/setErr (log-stream err-level log-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 log-ns value will be used to namespace all log entries.
+
+ By default *out* and *err* write to :info and :error, respectively."
+ {:arglists '([log-ns & body]
+ [[log-ns out-level err-level] & body])}
+ [arg & body]
+ ; Implementation Notes:
+ ; - no enabled? check before making writers since that may change later
+ (let [[log-ns out-level err-level] (if (vector? arg)
+ arg
+ [arg :info :error])]
+ (if (and log-ns (seq body))
+ `(binding [*out* (java.io.OutputStreamWriter.
+ (log-stream ~out-level ~log-ns))
+ *err* (java.io.OutputStreamWriter.
+ (log-stream ~err-level ~log-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))
+
+
+;; Implementations of Log and LogFactory protocols:
+
+(defn commons-logging
+ "Returns a commons-logging-based implementation of the LogFactory protocol, or
+ nil if not available. End-users should not need to call this."
+ []
+ (try
+ (Class/forName "org.apache.commons.logging.Log")
+ (eval
+ '(do
+ (extend-type org.apache.commons.logging.Log
+ Log
+ (impl-enabled? [log# level#]
+ (condp = level#
+ :trace (.isTraceEnabled log#)
+ :debug (.isDebugEnabled log#)
+ :info (.isInfoEnabled log#)
+ :warn (.isWarnEnabled log#)
+ :error (.isErrorEnabled log#)
+ :fatal (.isFatalEnabled log#)
+ (throw (IllegalArgumentException. (str level#)))))
+ (impl-write! [log# level# e# msg#]
+ (condp = level#
+ :trace (.trace log# msg# e#)
+ :debug (.debug log# msg# e#)
+ :info (.info log# msg# e#)
+ :warn (.warn log# msg# e#)
+ :error (.error log# msg# e#)
+ :fatal (.fatal log# msg# e#)
+ (throw (IllegalArgumentException. (str level#))))))
+ (reify LogFactory
+ (impl-name [_#]
+ "org.apache.commons.logging")
+ (impl-get-log [_# log-ns#]
+ (org.apache.commons.logging.LogFactory/getLog (str log-ns#))))))
+ (catch Exception e nil)))
+
+(defn slf4j-logging
+ "Returns a SLF4J-based implementation of the LogFactory protocol, or nil if
+ not available. End-users should not need to call this."
+ []
+ (try
+ (Class/forName "org.slf4j.Logger")
+ (eval
+ '(do
+ (extend-type org.slf4j.Logger
+ Log
+ (impl-enabled? [log# level#]
+ (condp = level#
+ :trace (.isTraceEnabled log#)
+ :debug (.isDebugEnabled log#)
+ :info (.isInfoEnabled log#)
+ :warn (.isWarnEnabled log#)
+ :error (.isErrorEnabled log#)
+ :fatal (.isErrorEnabled log#)
+ (throw (IllegalArgumentException. (str level#)))))
+ (impl-write! [^org.slf4j.Logger log# level# ^Throwable e# msg#]
+ (let [^String msg# (str msg#)]
+ (condp = level#
+ :trace (.trace log# msg# e#)
+ :debug (.debug log# msg# e#)
+ :info (.info log# msg# e#)
+ :warn (.warn log# msg# e#)
+ :error (.error log# msg# e#)
+ :fatal (.error log# msg# e#)
+ (throw (IllegalArgumentException. (str level#)))))))
+ (reify LogFactory
+ (impl-name [_#]
+ "org.slf4j")
+ (impl-get-log [_# log-ns#]
+ (org.slf4j.LoggerFactory/getLogger ^String (str log-ns#))))))
+ (catch Exception e nil)))
+
+(defn log4j-logging
+ "Returns a log4j-based implementation of the LogFactory protocol, or nil if
+ not available. End-users should not need to call this."
+ []
+ (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-type org.apache.log4j.Logger
+ Log
+ (impl-enabled? [log# level#]
+ (.isEnabledFor log#
+ (or
+ (levels# level#)
+ (throw (IllegalArgumentException. (str level#))))))
+ (impl-write! [log# level# e# msg#]
+ (let [level# (or
+ (levels# level#)
+ (throw (IllegalArgumentException. (str level#))))]
+ (if-not e#
+ (.log log# level# msg#)
+ (.log log# level# msg# e#)))))
+ (reify LogFactory
+ (impl-name [_#]
+ "org.apache.log4j")
+ (impl-get-log [_# log-ns#]
+ (org.apache.log4j.Logger/getLogger ^String (str log-ns#))))))
+ (catch Exception e nil)))
+
+(defn java-util-logging
+ "Returns a java.util.logging-based implementation of the LogFactory protocol,
+ or nil if not available. End-users should not need to call this."
+ []
+ (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-type java.util.logging.Logger
+ Log
+ (impl-enabled? [log# level#]
+ (.isLoggable log#
+ (or
+ (levels# level#)
+ (throw (IllegalArgumentException. (str level#))))))
+ (impl-write! [log# level# ^Throwable e# msg#]
+ (let [^java.util.logging.Level level#
+ (or
+ (levels# level#)
+ (throw (IllegalArgumentException. (str level#))))
+ ^String msg# (str msg#)]
+ (if e#
+ (.log log# level# msg# e#)
+ (.log log# level# msg#)))))
+ (reify LogFactory
+ (impl-name [_#]
+ "java.util.logging")
+ (impl-get-log [_# log-ns#]
+ (java.util.logging.Logger/getLogger (str log-ns#))))))
+ (catch Exception e nil)))
+
+(defn find-factory
+ "Returns the first LogFactory found that is available from commons-logging,
+ slf4j-logging, log4j-logging, or java-util-logging. End-users should not need
+ to call this."
+ []
+ (or (commons-logging)
+ (slf4j-logging)
+ (log4j-logging)
+ (java-util-logging)
+ (throw ; this should never happen in 1.5+
+ (RuntimeException.
+ "Valid logging implementation could not be found."))))
+
+(def ^{:doc
+ "An instance satisfying the LogFactory protocol. Used internally when needing
+ to obtain an instance satisfying the Log protocol. Defaults to the value
+ returned from find-factory. Can be rebound to provide alternate logging
+ implementations"}
+ *log-factory*
+ (find-factory))
348 src/test/clojure/clojure/tools/test_logging.clj
@@ -0,0 +1,348 @@
+(ns clojure.tools.test-logging
+ [:use clojure.test]
+ [:require [clojure.tools.logging :as log]])
+
+(def *entries* (atom []))
+
+(defn test-factory [enabled-set]
+ (reify log/LogFactory
+ (impl-name [_] "test factory")
+ (impl-get-log [_ log-ns]
+ (reify log/Log
+ (impl-enabled? [_ level] (contains? enabled-set level))
+ (impl-write! [_ lvl ex msg]
+ (swap! *entries* conj [(str log-ns) lvl ex msg]))))))
+
+(use-fixtures :once
+ (fn [f]
+ (binding [log/*log-factory*
+ (test-factory #{:trace :debug :info :warn :error :fatal})]
+ (f))))
+
+(use-fixtures :each
+ (fn [f]
+ (f)
+ (swap! *entries* (constantly []))))
+
+
+(deftest log-msg
+ (log/log :debug "foo")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ nil
+ "foo"]
+ (peek @*entries*))))
+
+(deftest log-ex
+ (let [e (Exception.)]
+ (log/log :debug e "foo")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ e
+ "foo"]
+ (peek @*entries*)))))
+
+(deftest log-custom-ns
+ (let [e (Exception.)]
+ (log/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/log :info "foo")))
+ (await log/*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/log :error "foo")))
+ (await log/*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))
+ log/*tx-agent-levels* #{:error}]
+ (dosync
+ (log/log :error "foo")))
+ (await log/*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))
+ log/*force* :agent]
+ (log/log :debug "foo"))
+ (await log/*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))
+ log/*force* :direct]
+ (dosync
+ (log/log :info "foo")))
+ (await log/*logging-agent*)
+ (is (= ["clojure.tools.test-logging"
+ :info
+ nil
+ "foo"]
+ (peek @*entries*)))
+ (is (false? @flag))))
+)
+
+
+(deftest logp-msg1
+ (log/logp :debug "hello")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ nil
+ "hello"]
+ (peek @*entries*))))
+
+(deftest logp-msg2
+ (log/logp :debug "hello" "world")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ nil
+ "hello world"]
+ (peek @*entries*))))
+
+(deftest logp-ex0
+ (let [e (Exception.)]
+ (log/logp :debug e)
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ nil
+ (print-str e)]
+ (peek @*entries*)))))
+
+(deftest logp-ex1
+ (let [e (Exception.)]
+ (log/logp :debug e "hello")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ e
+ "hello"]
+ (peek @*entries*)))))
+
+(deftest logp-ex2
+ (let [e (Exception.)]
+ (log/logp :debug e "hello" "world")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ e
+ "hello world"]
+ (peek @*entries*)))))
+
+(deftest logf-msg1
+ (log/logf :debug "hello")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ nil
+ "hello"]
+ (peek @*entries*))))
+
+(deftest logf-msg3
+ (log/logf :debug "%s %s" "hello" "world")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ nil
+ "hello world"]
+ (peek @*entries*))))
+
+(deftest logf-ex0
+ (is (thrown? Exception (log/logf :debug (Exception.)))))
+
+(deftest logf-ex3
+ (let [e (Exception.)]
+ (log/logf :debug e "%s %s" "hello" "world")
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ e
+ "hello world"]
+ (peek @*entries*)))))
+
+(deftest enabled-true
+ (is (= true (log/enabled? :fatal))))
+
+(deftest enabled-false
+ (binding [log/*log-factory* (test-factory #{})]
+ (is (= false (log/enabled? :fatal)))))
+
+(deftest spy-default
+ (log/spy (+ 4 5))
+ (is (= ["clojure.tools.test-logging"
+ :debug
+ nil
+ (format "(+ 4 5)%n=> 9")]
+ (peek @*entries*))))
+
+(deftest spy-level
+ (log/spy :fatal (+ 4 5))
+ (is (= ["clojure.tools.test-logging"
+ :fatal
+ nil
+ (format "(+ 4 5)%n=> 9")]
+ (peek @*entries*))))
+
+(comment
+(deftest capturing
+ (log/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/log-uncapture!))
+
+(deftest capturing-level
+ (log/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/log-uncapture!))
+
+(deftest with-logs-default
+ (log/with-logs "foobar" (println "hello world"))
+ (is (= ["foobar"
+ :info
+ nil
+ "hello world"]
+ (peek @*entries*))))
+
+(deftest with-logs-level
+ (log/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*)))
+ log/trace :trace
+ log/debug :debug
+ log/info :info
+ log/warn :warn
+ log/error :error
+ log/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*)))
+ log/trace :trace
+ log/debug :debug
+ log/info :info
+ log/warn :warn
+ log/error :error
+ log/fatal :fatal)))
+
+(deftest format-style
+ (are [f kw]
+ (= ["clojure.tools.test-logging"
+ kw
+ nil
+ "hello world"]
+ (do
+ (f "%s %s" "hello" "world")
+ (peek @*entries*)))
+ log/tracef :trace
+ log/debugf :debug
+ log/infof :info
+ log/warnf :warn
+ log/errorf :error
+ log/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*)))
+ log/tracef :trace
+ log/debugf :debug
+ log/infof :info
+ log/warnf :warn
+ log/errorf :error
+ log/fatalf :fatal)))
Please sign in to comment.
Something went wrong with that request. Please try again.