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
|
<!-- Module User's Guide -->
<chapter>
<chapterinfo>
<revhistory>
<revision>
<revnumber>$Revision: 1.1 $</revnumber>
<date>$Date: 2005/10/25 11:19:33 $</date>
</revision>
</revhistory>
</chapterinfo>
<title>User's Guide</title>
<section>
<title>Overview</title>
<para>
Flatstore is one of so-called &ser; database modules. It does not
export any functions executable from the configuration scripts, but
it exports a subset of functions from the database API and thus
other module can use it instead of, for example, mysql module.
</para>
<para>
The module does not export all functions of the database API, it
supports only one function, insert. The module is limited but very
fast. It is especially suitable for storing accounting information
on sites with extremely high traffic. If MySQL is too slow or if
you get a huge amount of accounting data then you can consider
using this module. Note that the acc module is the only module that
was tested with flastore.
</para>
<para>
The format of the files produced by this module is plain text. Each
line consists of several fields, fields are separated by |
character. New information is always appended at the end of the
file, searching, deleting and updating of existing data is not
supported by the module.
</para>
<para>
The acc module can be configured to use flatstore module as
database backend using the db_url_parameter:
</para>
<programlisting>
modparam("acc", "db_url", "flatstore:/var/log/acc")
</programlisting>
<para>
This configuration options tells acc module that it should use the
flatstore module and the flatstore module should create all files
in /var/log/acc directory. The directory must exist and &ser;
processes must have permissions to create files in that directory.
</para>
<para>
Name of files in that directory will follow the following pattern:
</para>
<programlisting>
<table_name>_<process_name>.log
</programlisting>
<para>
For example, entries writen by &ser; process 8 into acc table would
be written in file acc_8.log. For each table there will be several
files, one file for every &ser; process that wrote some data into
that table. The main reason why there are several files for each
table is that it is much faster to have one file per process,
because it does not require any locking and thus &ser; processes will
not block each other. To get the complete data for a table you can
simply concatenate the contents of files with the same table name
but different process id.
</para>
<section id="rotating">
<title>Rotating Log Files</title>
<para>
There is a new &ser; FIFO interface command called flat_rotate.
When &ser; receives the command then it will close and reopen all
files used by flatstore module. The rotation itself has to be
done by another application (such as logrotate). Follow these
steps to rotate files generated by flatstore module:
</para>
<itemizedlist>
<listitem>
<para>
Rename the files that you want to rotate:
<screen>
cd /var/log/acc
mv acc_1.log acc_1.log.20050605
mv acc_2.log acc_2.log.20050605
mv acc_4.log acc_3.log.20050605
...
</screen>
Note that at this point &ser; will still be writing all
data into the renamed files.
</para>
</listitem>
<listitem>
<para>
Send &ser; the fifo command to close and reopen the
renamed files:
<screen>
openserctl fifo flat_rotate
</screen>
This will force &ser; to close the renamed files and open
new ones with original names, such as
<filename>acc_1.log</filename>. New files will be open
at the point when &ser; has some data to write. It is
normal that the files will be not created immediately
if there is no traffic on the proxy server.
</para>
</listitem>
<listitem>
<para>
Move the renamed files somewhere else and process them.
</para>
</listitem>
</itemizedlist>
</section>
</section>
<section>
<title>Dependencies</title>
<section>
<title>&ser; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>No dependencies on other &ser; modules</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before running
&ser; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>None</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Exported Parameters</title>
<section>
<title><varname>flush</varname> (integer)</title>
<para>
Enable or disable flushing after each write.
</para>
<para>
<emphasis>
Default value is 1.
</emphasis>
</para>
<example>
<title>Set <quote>flush</quote> parameter</title>
<programlisting format="linespecific">
...
modparam("flatstore", "flush", 0)
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Exported Functions</title>
<para>
There are no function exported to routing script.
</para>
</section>
</chapter>
<!-- Keep this element at the end of the file
Local Variables:
sgml-parent-document: ("exec.sgml" "Book" "chapter")
End:
-->
|
