trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [trafficserver] branch master updated: doc: Update log space documentation.
Date Wed, 10 Aug 2016 16:57:17 GMT
This is an automated email from the ASF dual-hosted git repository.

jpeach pushed a commit to branch master
in repository https://git-dual.apache.org/repos/asf/trafficserver.git

The following commit(s) were added to refs/heads/master by this push:
       new  18325ad   doc: Update log space documentation.
18325ad is described below

commit 18325ad0cb730ce9e971c116aee222ed56e3c558
Author: James Peach <jpeach@apache.org>
AuthorDate: Wed Aug 10 09:55:45 2016 -0700

    doc: Update log space documentation.
    
    It is not especially clear that the logging headroom is taken out
    of the configured allocation, so provide some more information about
    how we manage log space and deal with headroom.
---
 doc/admin-guide/files/records.config.en.rst             | 14 ++++++++++----
 doc/admin-guide/monitoring/logging/managing-logs.en.rst | 12 ++++++++++++
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index 9d13390..04c8de2 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -2564,13 +2564,19 @@ Logging Configuration
    :reloadable:
 
    The amount of space allocated to the logging directory (in MB).
+   The headroom amount specified by
+   :ts:cv:`proxy.config.log.max_space_mb_headroom` is taken from
+   this space allocation.
 
 .. note::
 
-   All files in the logging directory contribute to the space used, even if they are not
log files. In collation client
-   mode, if there is no local disk logging, or :ts:cv:`proxy.config.log.max_space_mb_for_orphan_logs`
is set to a higher
-   value than :ts:cv:`proxy.config.log.max_space_mb_for_logs`, TS will take
-   :ts:cv:`proxy.config.log.max_space_mb_for_orphan_logs` for maximum allowed log space.
+   All files in the logging directory contribute to the space used,
+   even if they are not log files. In collation client mode, if
+   there is no local disk logging, or
+   :ts:cv:`proxy.config.log.max_space_mb_for_orphan_logs` is set
+   to a higher value than :ts:cv:`proxy.config.log.max_space_mb_for_logs`,
+   |TS| will take :ts:cv:`proxy.config.log.max_space_mb_for_orphan_logs`
+   for maximum allowed log space.
 
 .. ts:cv:: CONFIG proxy.config.log.max_space_mb_for_orphan_logs INT 25
    :metric: megabytes
diff --git a/doc/admin-guide/monitoring/logging/managing-logs.en.rst b/doc/admin-guide/monitoring/logging/managing-logs.en.rst
index ba7d355..978f17d 100644
--- a/doc/admin-guide/monitoring/logging/managing-logs.en.rst
+++ b/doc/admin-guide/monitoring/logging/managing-logs.en.rst
@@ -66,6 +66,18 @@ partition, where you can run a variety of log analysis scripts. Following
 analysis, either compress the logs and move to an archive location, or simply
 delete them.
 
+|TS| periodically checks the amount of log space used against both
+the log space allocation configured by
+:ts:cv:`proxy.config.log.max_space_mb_for_logs` and the actual
+amount of space available on the disk partition. The used log space
+is calculated by summing the size of all files present in the logging
+directory and is published in the
+:ts:stat:`proxy.process.log.log_files_space_used` metric. The
+:ts:cv:`proxy.config.log.max_space_mb_headroom` configuration
+variable specifies an amount of headroom that is subtracted from
+the log space allocation. This can be tuned to reduce the risk of
+completely filling the disk partition.
+
 Setting Log File Management Options
 -----------------------------------
 

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <commits@trafficserver.apache.org>'].

Mime
View raw message