[SR-Dev] git:janakj/flatstore: - fix some FAQ entries, change missing entity, regenerate READMEs

Module: sip-router Branch: janakj/flatstore Commit: f1b2f98b1ba90aec0fd4902a6e461dc908072505 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=f1b2f98… Author: Henning Westerholt &lt;henning.westerholt(a)1und1.de&gt; Committer: Henning Westerholt &lt;henning.westerholt(a)1und1.de&gt; Date: Wed Jul 30 09:20:54 2008 +0000 - fix some FAQ entries, change missing entity, regenerate READMEs git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4524 689a6050-402a-0410-94f2-e92a70836424 --- modules/db_flatstore/km_README | 50 ++++++++++++++++++++-------------------- 1 files changed, 25 insertions(+), 25 deletions(-) diff --git a/modules/db_flatstore/km_README b/modules/db_flatstore/km_README index b74a23b..80197d0 100644 --- a/modules/db_flatstore/km_README +++ b/modules/db_flatstore/km_README @@ -10,8 +10,8 @@ Jan Janak Copyright � 2004, 2005 FhG FOKUS Revision History - Revision $Revision$ $Date: 2008-03-19 21:31:30 +0200 - (Wed, 19 Mar 2008) $ + Revision $Revision$ $Date: 2008-03-19 20:31:30 +0100 + (Mi, 19 Mär 2008) $ __________________________________________________________ Table of Contents @@ -24,7 +24,7 @@ Jan Janak 1.2. Dependencies - 1.2.1. OpenSER Modules + 1.2.1. Kamailio Modules 1.2.2. External Libraries or Applications 1.3. Exported Parameters @@ -46,8 +46,8 @@ Chapter 1. Admin Guide 1.1. Overview - Flatstore is one of so-called OpenSER database modules. It does - not export any functions executable from the configuration + Flatstore is one of so-called Kamailio 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. @@ -73,29 +73,29 @@ 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 - OpenSER processes must have permissions to create files in that - directory. + Kamailio 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 OpenSER 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 OpenSER process that wrote - some data into that table. The main reason why there are + For example, entries writen by Kamailio 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 Kamailio 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 OpenSER processes will not block each other. To get + and thus Kamailio 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 OpenSER MI (management interface) command called - flat_rotate. When OpenSER receives the command then it will - close and reopen all files used by flatstore module. The + There is a new Kamailio MI (management interface) command + called flat_rotate. When Kamailio 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: @@ -106,30 +106,30 @@ mv acc_2.log acc_2.log.20050605 mv acc_4.log acc_3.log.20050605 ... - Note that at this point OpenSER will still be writing all + Note that at this point Kamailio will still be writing all data into the renamed files. - * Send OpenSER the MI command to close and reopen the renamed - files. For example, using FIFO: + * Send Kamailio the MI command to close and reopen the + renamed files. For example, using FIFO: openserctl fifo flat_rotate - This will force OpenSER 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 OpenSER has some data to - write. It is normal that the files will be not created + This will force Kamailio 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 Kamailio 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. * Move the renamed files somewhere else and process them. 1.2. Dependencies -1.2.1. OpenSER Modules +1.2.1. Kamailio Modules The following modules must be loaded before this module: - * No dependencies on other OpenSER modules. + * No dependencies on other Kamailio modules. 1.2.2. External Libraries or Applications The following libraries or applications must be installed - before running OpenSER with this module loaded: + before running Kamailio with this module loaded: * None. 1.3. Exported Parameters