]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
Update linelog examples and documentation
authorAlan T. DeKok <aland@freeradius.org>
Fri, 3 Apr 2026 20:46:18 +0000 (16:46 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Fri, 3 Apr 2026 20:46:18 +0000 (16:46 -0400)
doc/antora/modules/reference/pages/raddb/mods-available/linelog.adoc
raddb/mods-available/linelog

index 1ef80064a108131266adba6c4cf653e23efee920..d9f33689e7e542495397b4587cef1341ce5349b6 100644 (file)
@@ -133,7 +133,7 @@ group, otherwise it will not be possible to set the group.
 
 
 
-escape_filenames::
+escape_filenames:: Whether filenames are escaped.
 
 Most file systems can handle nearly the full range
 of UTF-8 characters.  Ones that can only deal with
@@ -141,13 +141,34 @@ a limited range should set this to `yes`.
 
 
 
-fsync::
+fsync:: Forcible sync the data to disk.
 
 Synchronise data written with the file system after every
 write, returning fail when the operation fails.
 
 
 
+buffer_count:: How many lines to buffer before
+writing to disk.
+
+If buffer_count is set, then the module will buffer
+logs in memory before writing them to disk.
+
+Setting this to zero will turn off buffering.
+
+
+
+buffer_delay:: Time delay before writing logs to disk.
+
+If logs are buffered, then they buffered data is
+written to disk when either the buffer_count is
+reached, or when buffer_delay is reached.  The
+combination of the two settings allows much higher
+performance, while still ensuring that logs are
+regularly written to disk.
+
+
+
 The connection pool for TCP and Unix socket connections.
 
 
@@ -394,6 +415,8 @@ linelog {
 #              group = ${security.group}
                escape_filenames = no
                fsync = no
+               buffer_count = 0;
+               buffer_delay = 1s
        }
        pool {
                start = 0
index 763fed2f84e7f218cd4c657cf486a1857ab42282..4c0cd7db242617b483d531d8c2547542e0ec0b33 100644 (file)
@@ -152,7 +152,7 @@ linelog {
 #              group = ${security.group}
 
                #
-               #  escape_filenames::
+               #  escape_filenames:: Whether filenames are escaped.
                #
                #  Most file systems can handle nearly the full range
                #  of UTF-8 characters.  Ones that can only deal with
@@ -161,12 +161,35 @@ linelog {
                escape_filenames = no
 
                #
-               #  fsync::
+               #  fsync:: Forcible sync the data to disk.
                #
                #  Synchronise data written with the file system after every
                #  write, returning fail when the operation fails.
                #
                fsync = no
+
+               #
+               #  buffer_count:: How many lines to buffer before
+               #  writing to disk.
+               #
+               #  If buffer_count is set, then the module will buffer
+               #  logs in memory before writing them to disk.
+               #
+               #  Setting this to zero will turn off buffering.
+               #
+               buffer_count = 0;
+
+               #
+               #  buffer_delay:: Time delay before writing logs to disk.
+               #
+               #  If logs are buffered, then they buffered data is
+               #  written to disk when either the buffer_count is
+               #  reached, or when buffer_delay is reached.  The
+               #  combination of the two settings allows much higher
+               #  performance, while still ensuring that logs are
+               #  regularly written to disk.
+               #
+               buffer_delay = 1s
        }
 
        #