Skip to content

Commit

Permalink
modules: readme files regenerated - db_flatstore ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed Oct 9, 2017
1 parent c203af8 commit 08f8179
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions src/modules/db_flatstore/README
Expand Up @@ -5,7 +5,14 @@ Jan Janak
FhG FOKUS
<jan@iptel.org>

Julien Chavanton

Flowroute
<jchavanton@gmail.com>

Copyright © 2004, 2005 FhG FOKUS

Copyright © 2017 Flowroute
__________________________________________________________________

Table of Contents
Expand All @@ -19,6 +26,7 @@ Jan Janak
2. Parameters

2.1. flush (integer)
2.2. encode_delimiter (integer)

Chapter 1. Admin Guide

Expand All @@ -31,6 +39,7 @@ Chapter 1. Admin Guide
2. Parameters

2.1. flush (integer)
2.2. encode_delimiter (integer)

1. Overview

Expand Down Expand Up @@ -81,10 +90,11 @@ modparam("acc", "db_url", "flatstore:/var/log/acc")
1.1. Rotating Log Files

The module implements a Kamailio management interface command called
flatstore.rotate. When Kamailio 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:
flatstore.k_rotate. When Kamailio 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
Expand All @@ -95,7 +105,7 @@ mv acc_4.log acc_3.log.20050605
into the renamed files.
* Send Kamailio the management command to close and reopen the
renamed files:
kamcmd flatstore.rotate
kamcmd flatstore.k_rotate
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
Expand All @@ -106,9 +116,18 @@ kamcmd flatstore.rotate
2. Parameters

2.1. flush (integer)
2.2. encode_delimiter (integer)

2.1. flush (integer)

Enable or disable flushing after each write.

Default value is 1.

2.2. encode_delimiter (integer)

Enable or disable encoding tof the escaped character using ""%" HEX
HEX" mechanism for escaping from RFC 2396

Default value is 1. Default delimiter '|' is replaced with %7C if found
in any string

0 comments on commit 08f8179

Please sign in to comment.