Skip to content
100644 60 lines (39 sloc) 3.04 KB
4ee2065 @abedra Initial conversion
abedra authored
1 # Logging
3 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:
5 :trace, :debug, :info, :warn, :error, :fatal
7 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.
9 ## Usage
11 For those new to using a java logging library, the following is a very basic configuration for log4j. Place it in a file called \"\" and place that file (and the log4j JAR) on the classpath.
13 log4j.rootLogger=WARN, A1
14 log4j.logger.user=DEBUG
15 log4j.appender.A1=org.apache.log4j.ConsoleAppender
16 log4j.appender.A1.layout=org.apache.log4j.PatternLayout
17 log4j.appender.A1.layout.ConversionPattern=%d %-5p %c: %m%n
19 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.
21 ### "Installation"
23 Logging is available in Maven central. Add it to your Maven project's `pom.xml`:
25 <dependency>
26 <groupId>org.clojure</groupId>
27 <artifactId>tools.logging</artifactId>
28 <version>0.1.0-SNAPSHOT</version>
29 </dependency>
31 or your leiningen project.clj:
33 [org.clojure/tools.logging "0.1.0-SNAPSHOT"]
35 Please note the changelog below.
37 ### Building Logging
39 0. Clone the repo
40 1. Make sure you have maven installed
41 2. Run the maven build; run either:
42 1. `mvn package`: This will produce a logging jar file in the `target`
43 directory, and run all tests with the most recently-released build
44 of Clojure (currently 1.2.0). Or,
45 2. `mvn verify`: This does the same, but also runs the tests with
46 other Clojure "profiles" (currently v1.1.0 and v1.1.0 + clojure-contrib).
48 ## Thanks
50 * Chris Dean
51 * Phil Hagelberg
52 * Richard Newman
53 * Timothy Pratley
55 ## License
57 Copyright © 2009 Alex Taggart
59 Licensed under the EPL. (See the file epl.html.)
Something went wrong with that request. Please try again.