1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
<html>
<head>
<title>logging API reference (clojure-contrib)</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Clojure-contrib API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<div class="BranchTOC">
<a class="wiki_link" href="#">Branches</a>
<ul id="left-sidebar-branch-list">
<li><a href="index.html" class="wiki_link">master</a></li><li><a href="branch-1.1.x/index.html" class="wiki_link">1.1.x</a></li>
</ul>
</div>
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-api.html" class="wiki_link">seq</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-api.html" class="wiki_link">shell</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/*allow-direct-logging*">*allow-direct-logging*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/*impl-name*">*impl-name*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/*logging-agent*">*logging-agent*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/debug">debug</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/enabled?">enabled?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/error">error</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/fatal">fatal</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/impl-enabled?">impl-enabled?</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/impl-get-log">impl-get-log</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/impl-write!">impl-write!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/info">info</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/log">log</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/log-capture!">log-capture!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/log-stream">log-stream</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/log-uncapture!">log-uncapture!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/spy">spy</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/trace">trace</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/warn">warn</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clojure.contrib.logging/with-logs">with-logs</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">logging</span>
<span id="branch-name">(master branch)</span></h1>
by <span id="author">Alex Taggart, Timothy Pratley</span><br />
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.logging</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Logging macros which delegate to a specific logging implementation. At
runtime a specific implementation is selected from, in order, 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. For performance reasons, direct
logging is enabled by default, but setting the *allow-direct-logging* boolean
atom to false will disable it. If logging is invoked within a transaction it
will always use 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 debug 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
something like "fn__72$impl_write_BANG__39__auto____81" 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 rebind *out* and *err* to the log system
invoke with-logs. In both cases a log-ns (e.g., "com.example.captured")
needs to be specified to namespace the output.</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/*allow-direct-logging*">*allow-direct-logging*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">A boolean indicating whether direct logging (as opposed to via an agent) is
allowed when not operating from within a transaction. Defaults to true.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/*impl-name*">*impl-name*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">The name of the logging implementation used.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/*logging-agent*">*logging-agent*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">The default agent used for performing logging durng a transaction or when
direct logging is disabled.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/debug">debug</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (debug message)
(debug message throwable)
</pre>
<pre id="var-docstr">Logs a message at the debug level.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/enabled?">enabled?</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (enabled? level)
(enabled? level log-ns)
</pre>
<pre id="var-docstr">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.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/error">error</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (error message)
(error message throwable)
</pre>
<pre id="var-docstr">Logs a message at the error level.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/fatal">fatal</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (fatal message)
(fatal message throwable)
</pre>
<pre id="var-docstr">Logs a message at the fatal level.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/impl-enabled?">impl-enabled?</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Implementation-specific check if a particular level is enabled. End-users
should not need to call this.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/impl-get-log">impl-get-log</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Returns an implementation-specific log by string namespace. End-users should
not need to call this.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/impl-write!">impl-write!</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Implementation-specific write of a log message. End-users should not need to
call this.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/info">info</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (info message)
(info message throwable)
</pre>
<pre id="var-docstr">Logs a message at the info level.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/log">log</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (log level message)
(log level message throwable)
(log level message throwable log-ns)
</pre>
<pre id="var-docstr">Logs a message, either directly or via an agent. Also see the level-specific
convenience macros.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/log-capture!">log-capture!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (log-capture! log-ns)
</pre>
<pre id="var-docstr">Captures System.out and System.err, redirecting all writes of those streams
to :info and :error logging, respectively. The specified log-ns value will
be used to namespace all redirected logging. NOTE: this will not redirect
output of *out* or *err*; for that, use with-logs.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/log-stream">log-stream</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (log-stream level log-ns)
</pre>
<pre id="var-docstr">Creates a PrintStream that will output to the log. End-users should not need
to invoke this.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/log-uncapture!">log-uncapture!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (log-uncapture!)
</pre>
<pre id="var-docstr">Restores System.out and System.err to their original values.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/spy">spy</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (spy expr)
</pre>
<pre id="var-docstr">Evaluates expr and outputs the form and its result to the debug log; returns
the result of expr.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/trace">trace</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (trace message)
(trace message throwable)
</pre>
<pre id="var-docstr">Logs a message at the trace level.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/warn">warn</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (warn message)
(warn message throwable)
</pre>
<pre id="var-docstr">Logs a message at the warn level.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.contrib.logging/with-logs">with-logs</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (with-logs log-ns & body)
</pre>
<pre id="var-docstr">Evaluates exprs in a context in which *out* and *err* are bound to :info and
:error logging, respectively. The specified log-ns value will be used to
namespace all redirected logging.</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>
|
