source: project/wiki/eggref/5/spiffy-sexpr-log @ 36454

Last change on this file since 36454 was 36454, checked in by Mario Domenech Goulart, 20 months ago

eggref/[45]/spiffy-sexpr-log: release note for version 0.3.1

File size: 2.9 KB
Line 
1[[tags: egg spiffy-sexpr-log]]
2
3== spiffy-sexpr-log
4
5[[toc:]]
6
7=== Introduction
8
9Symbolic expression log format for Spiffy's access log
10
11
12=== Author
13
14[[/users/mario-domenech-goulart|Mario Domenech Goulart]]
15
16
17=== Repository
18
19[[https://github.com/mario-goulart/spiffy-sexpr-log|https://github.com/mario-goulart/spiffy-sexpr-log]]
20
21
22=== API
23
24To use this extension:
25
26<enscript highlight=scheme>
27(use spiffy-sexpr-log)
28</enscript>
29
30{{spiffy-sexpr-log}} configures spiffy's {{handle-access-logging}}
31parameter to set the log format to s-expressions, so you can just
32{{read}} the log file or port to parse the log data.
33
34Notice that the default spiffy configuration doesn't log anything.
35You have to enable logging by using the {{access-log}} parameter.
36
37<parameter>(split-log? [boolean])</parameter>
38
39Split logs and save them according to the following directory layout:
40
41   <year>/<month>/<day>.log
42
43Default value: {{#f}}.
44
45
46=== Command line tools
47
48This egg provides two command line tools
49
50* {{spiffy-log2sexpr}}: convert the default spiffy log format to the s-expression format
51* {{spiffy-split-sexpr-log}}: split a log in s-expression format according to what {{split-log?}} would do
52
53
54=== License
55
56  Copyright (c) 2011-2018, Mario Domenech Goulart
57  All rights reserved.
58 
59  Redistribution and use in source and binary forms, with or without
60  modification, are permitted provided that the following conditions
61  are met:
62  1. Redistributions of source code must retain the above copyright
63     notice, this list of conditions and the following disclaimer.
64  2. Redistributions in binary form must reproduce the above copyright
65     notice, this list of conditions and the following disclaimer in the
66     documentation and/or other materials provided with the distribution.
67  3. The name of the authors may not be used to endorse or promote products
68     derived from this software without specific prior written permission.
69 
70  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
71  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
72  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
73  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
74  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
75  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
76  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
77  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
78  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
79  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
80  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
81
82
83
84=== Version history
85
86==== Version 0.3.1
87* Fix tests
88
89==== Version 0.3
90
91* CHICKEN 5 support
92* Add {{split-log?}} parameter
93* Add {{spiffy-split-sexpr-log}} command line tool
94
95==== Version 0.2
96
97* Meta file fix (added {{category}} section)
98
99
100==== Version 0.1
101
102* Initial release
Note: See TracBrowser for help on using the repository browser.