[sr-dev] git:master: db_flatstore: Rename main docbook file and fix documentation.

Module: sip-router Branch: master Commit: e1878db69410a7d1a8896878f01bea7c2cf2f48d URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=e1878db… Author: Jan Janak &lt;jan(a)ryngle.com&gt; Committer: Jan Janak &lt;jan(a)ryngle.com&gt; Date: Wed Oct 21 00:12:49 2009 +0200 db_flatstore: Rename main docbook file and fix documentation. Rename the main docbook file to db_flatstore.xml to match the name of the module and the filename in the Makefile. Also change the docbook document to include required docbook entities and change the name of the module across the document. Reported by Olle E. Johansson --- modules/db_flatstore/README | 97 ++++++++++---------- .../doc/{flatstore.xml => db_flatstore.xml} | 26 +++-- 2 files changed, 63 insertions(+), 60 deletions(-) diff --git a/modules/db_flatstore/README b/modules/db_flatstore/README index 715c2c3..6cdab5b 100644 --- a/modules/db_flatstore/README +++ b/modules/db_flatstore/README @@ -1,4 +1,4 @@ -1. Flatstore Module +1. Db_flatstore Module Jan Janak @@ -10,77 +10,74 @@ Jan Janak Revision $Revision$ $Date$ __________________________________________________________________ - 1.1. Overview - - 1.1.1. Rotating Log Files - - 1.2. Parameters - - 1.2.1. flush (integer) - 1.1. Overview - 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. + Db_flatstore is one of so-called SIP Router 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 + modules can use it as a database driver, instead of, for example, the + Mysql module. - 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. + The module does not implement all functions of the database API, it + supports only one function, insert. This means that 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. Please note that the acc module is the only module + that was tested with the flastore module. 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. + line consists of several fields, fields are separated by the "|" + character (vertical bar). New information is always appended at the end + of the file. Searching, deleting and updating of existing data is not + supported by the module. - The acc module can be configured to use flatstore module as database + The acc module can be configured to use db_flatstore module as database backend using the db_url_parameter: modparam("acc", "db_url", "flatstore:/var/log/acc") - 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. + This configuration option tells the acc module that it should use the + db_flatstore module and the db_flatstore module should create all files + in the /var/log/acc directory. The directory must exist and SIP Router + processes must have permissions to create files in that directory. Name of files in that directory will follow the following pattern: <table_name>_<process_name>.log - 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. + For example, entries writen by the SIP Router process 8 into the acc + table would be written in file acc_8.log. For each table there will be + several files, one file for every SIP Router 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 SIP Router 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. 1.1.1. Rotating Log Files - 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: + The module implements a SIP Router management interface command called + flatstore.rotate. When SIP Router receives the command it will close + and reopen all files used by the db_flatstore module. The rotation + itself has to be done by another application (such as logrotate). + Follow these steps to rotate files generated by the db_flatstore + module: * Rename the files that you want to rotate: 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 ... - Note that at this point SER will still be writing all data into the - renamed files. - * Send SER the fifo command to close and reopen the renamed files: -serctl fifo flat_rotate - This will force SER to close the renamed files and open new ones - with original names, such as acc_1.log. 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. + Note that at this point SIP Router will still be writing all data + into the renamed files. + * Send SIP Router the management command to close and reopen the + renamed files: +sercmd flatstore.rotate + This will force SIP Router to close the renamed files and open new + ones with original names, such as acc_1.log. New files will be open + at the point when SIP Router has some data to write. It is normal + that the files will be not created immediately if there is no + traffic on the SIP server. * Move the renamed files somewhere else and process them. 1.2. Parameters diff --git a/modules/db_flatstore/doc/flatstore.xml b/modules/db_flatstore/doc/db_flatstore.xml similarity index 86% rename from modules/db_flatstore/doc/flatstore.xml rename to modules/db_flatstore/doc/db_flatstore.xml index c2e679d..77dfeba 100644 --- a/modules/db_flatstore/doc/flatstore.xml +++ b/modules/db_flatstore/doc/db_flatstore.xml @@ -1,6 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> <section id="flatstore" xmlns:xi="http://www.w3.org/2001/XInclude"> <sectioninfo> @@ -25,15 +31,15 @@ </revhistory> </sectioninfo> - <title>Flatstore Module</title> + <title>Db_flatstore Module</title> <section id="flatstore.overview"> <title>Overview</title> <para> - Flatstore is one of so-called &siprouter; 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 modules can use it as a database driver, instead of, for + Db_flatstore is one of so-called &siprouter; 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 modules can use it as a database driver, instead of, for example, the Mysql module. </para> <para> @@ -53,7 +59,7 @@ supported by the module</emphasis>. </para> <para> - The acc module can be configured to use flatstore module as + The acc module can be configured to use db_flatstore module as database backend using the db_url_parameter: </para> <programlisting> @@ -61,7 +67,7 @@ modparam("acc", "db_url", "flatstore:/var/log/acc") </programlisting> <para> This configuration option tells the acc module that it should use the - flatstore module and the flatstore module should create all files + db_flatstore module and the db_flatstore module should create all files in the /var/log/acc directory. The directory must exist and &siprouter; processes must have permissions to create files in that directory. </para> @@ -87,10 +93,10 @@ modparam("acc", "db_url", "flatstore:/var/log/acc") <para> The module implements a &siprouter; management interface command called flatstore.rotate. When &siprouter; receives the command it will - close and reopen all files used by the flatstore module. + close and reopen all files used by the db_flatstore module. The rotation itself has to be done by another application (such as logrotate). Follow these steps to rotate files generated by - the flatstore module: + the db_flatstore module: </para> <itemizedlist> <listitem>