You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2020/02/21 23:49:01 UTC
[trafficserver] branch 9.0.x updated (25289e9 -> 31bb1e7)
This is an automated email from the ASF dual-hosted git repository.
zwoop pushed a change to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git.
from 25289e9 Avoid a weird name collision between HRW and tscore (#6446)
new a886e93 Adding max line length configuration documentation.
new 31bb1e7 Move log line length configuration to records.config docs.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
doc/admin-guide/files/records.config.en.rst | 37 +++++++++++++++++++++++++++++
doc/admin-guide/logging/formatting.en.rst | 11 +++++++++
2 files changed, 48 insertions(+)
[trafficserver] 01/02: Adding max line length configuration
documentation.
Posted by zw...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zwoop pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit a886e93e9e765190521f4e9ebdedd173dffd6ea3
Author: bneradt <bn...@verizonmedia.com>
AuthorDate: Mon Jan 6 22:54:52 2020 +0000
Adding max line length configuration documentation.
(cherry picked from commit 52a779c5051d6b7d5de549d6b1b24216df84a8d7)
---
doc/admin-guide/logging/formatting.en.rst | 32 +++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/doc/admin-guide/logging/formatting.en.rst b/doc/admin-guide/logging/formatting.en.rst
index 182199c..9f095ab 100644
--- a/doc/admin-guide/logging/formatting.en.rst
+++ b/doc/admin-guide/logging/formatting.en.rst
@@ -797,6 +797,38 @@ cquup Client Request Canonical (prior to remapping) path component from the
cquuh Client Request Unmapped URL host from the client request.
===== ============== ==========================================================
+Line Length
+===========
+
+The maximum line size for a log entry can be configured via the following parameters:
+
+- :ts:cv:`proxy.config.log.max_line_size`: This controls the maximum line
+ length for ASCII formatted log entries. This applies to ``ASCII_PIPE`` and
+ ``ASCII`` file logs, *unless* :ts:cv:`proxy.config.log.ascii_buffer_size` is
+ also specified and the value of :ts:cv:`ascii_buffer_size` is larger than
+ :ts:cv:`max_line_size`: in that case, :ts:cv:`max_line_size` only applies to
+ ``ASCII_PIPE`` logs while :ts:cv:`ascii_buffer_size` will apply to ``ASCII``
+ (non-pipe) log files.
+
+- :ts:cv:`proxy.config.log.ascii_buffer_size`: This controls the maximum line
+ length for ASCII formatted log entries that are non-pipe log files. If this
+ value is smaller than :ts:cv:`proxy.config.log.max_line_size`, then the
+ latter will be used for both ``ASCII`` and ``ASCII_PIPE`` log files. If both
+ :ts:cv:`max_line_size` and :ts:cv:`ascii_buffer_size` are set, then
+ :ts:cv:`max_line_size` will be used for ``ASCII_PIPE`` logs while
+ :ts:cv:`ascii_buffer_size` will be used for ``ASCII`` (non-pipe) log files.
+ This all might seem complicated, but just keep in mind that the intention of
+ :ts:cv:`ascii_buffer_size` is to simply provide a way for the user to
+ configure different ``ASCII`` and ``ASCII_PIPE`` maximum line lengths.
+
+- :ts:cv:`proxy.config.log.log_buffer_size`: This is an orthogonal mechanism
+ for limiting line length size by constraining the log entry buffer to a
+ particular amount of memory. Unlike the above two configurations,
+ :ts:cv:`log_buffer_size` applies to both binary and ASCII log file entries.
+ For ASCII log files, if a maximum log size is set via the above mechanisms
+ and by :ts:cv:`log_buffer_size`, then the smaller of the two configurations
+ will be applied to the line length.
+
Log Field Slicing
=================
[trafficserver] 02/02: Move log line length configuration to
records.config docs.
Posted by zw...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
zwoop pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit 31bb1e7bb6cbc5cf1eda0ce296973a7d7521237e
Author: bneradt <bn...@verizonmedia.com>
AuthorDate: Mon Feb 17 16:36:19 2020 +0000
Move log line length configuration to records.config docs.
(cherry picked from commit a10526d9a0f634066e65e24cb285b1ff10724e71)
---
doc/admin-guide/files/records.config.en.rst | 37 +++++++++++++++++++++++++++++
doc/admin-guide/logging/formatting.en.rst | 35 ++++++---------------------
2 files changed, 44 insertions(+), 28 deletions(-)
diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index 9bef21f..ed736d7 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -2916,6 +2916,43 @@ Logging Configuration
:file:`logging.yaml` configuration file. If this is a relative
path, |TS| loads it relative to the ``SYSCONFDIR`` directory.
+.. ts:cv:: CONFIG proxy.config.log.max_line_size INT 9216
+ :units: bytes
+
+ This controls the maximum line length for ``ASCII`` formatted log entries.
+ This applies to ``ASCII_PIPE`` and ``ASCII`` file logs, *unless*
+ :ts:cv:`proxy.config.log.ascii_buffer_size` is also specified and the value
+ of ``ascii_buffer_size`` is larger than ``max_line_size``: in that case,
+ ``max_line_size`` only applies to ``ASCII_PIPE`` logs while
+ ``ascii_buffer_size`` will apply to ``ASCII`` (non-pipe) log files.
+
+.. ts:cv:: CONFIG proxy.config.log.ascii_buffer_size INT 36864
+ :units: bytes
+
+ This controls the maximum line length for ``ASCII`` formatted log entries
+ that are non-pipe log files. If this value is smaller than
+ :ts:cv:`proxy.config.log.max_line_size`, then the latter will be used for
+ both ``ASCII`` and ``ASCII_PIPE`` log files. If both ``max_line_size`` and
+ ``ascii_buffer_size`` are set, then ``max_line_size`` will be used for
+ ``ASCII_PIPE`` logs while ``ascii_buffer_size`` will be used for ``ASCII``
+ (non-pipe) log files. This all might seem complicated, but just keep in
+ mind that the intention of ``ascii_buffer_size`` is to simply provide a way
+ for the user to configure different ``ASCII`` and ``ASCII_PIPE`` maximum
+ line lengths.
+
+.. ts:cv:: CONFIG proxy.config.log.log_buffer_size INT 9216
+ :reloadable:
+ :units: bytes
+
+ This is an orthogonal mechanism from :ts:cv:`proxy.config.log.max_line_size`
+ and :ts:cv:`proxy.config.log.ascii_buffer_size` for limiting line length
+ size by constraining the log entry buffer to a particular amount of memory.
+ Unlike the above two configurations, ``log_buffer_size`` applies to both
+ binary and ``ASCII`` log file entries. For ``ASCII`` log files, if a maximum
+ log size is set via both the above mechanisms and by ``log_buffer_size``,
+ then the smaller of the two configurations will be applied to the line
+ length.
+
Diagnostic Logging Configuration
================================
diff --git a/doc/admin-guide/logging/formatting.en.rst b/doc/admin-guide/logging/formatting.en.rst
index 9f095ab..8fa5edd 100644
--- a/doc/admin-guide/logging/formatting.en.rst
+++ b/doc/admin-guide/logging/formatting.en.rst
@@ -800,34 +800,13 @@ cquuh Client Request Unmapped URL host from the client request.
Line Length
===========
-The maximum line size for a log entry can be configured via the following parameters:
-
-- :ts:cv:`proxy.config.log.max_line_size`: This controls the maximum line
- length for ASCII formatted log entries. This applies to ``ASCII_PIPE`` and
- ``ASCII`` file logs, *unless* :ts:cv:`proxy.config.log.ascii_buffer_size` is
- also specified and the value of :ts:cv:`ascii_buffer_size` is larger than
- :ts:cv:`max_line_size`: in that case, :ts:cv:`max_line_size` only applies to
- ``ASCII_PIPE`` logs while :ts:cv:`ascii_buffer_size` will apply to ``ASCII``
- (non-pipe) log files.
-
-- :ts:cv:`proxy.config.log.ascii_buffer_size`: This controls the maximum line
- length for ASCII formatted log entries that are non-pipe log files. If this
- value is smaller than :ts:cv:`proxy.config.log.max_line_size`, then the
- latter will be used for both ``ASCII`` and ``ASCII_PIPE`` log files. If both
- :ts:cv:`max_line_size` and :ts:cv:`ascii_buffer_size` are set, then
- :ts:cv:`max_line_size` will be used for ``ASCII_PIPE`` logs while
- :ts:cv:`ascii_buffer_size` will be used for ``ASCII`` (non-pipe) log files.
- This all might seem complicated, but just keep in mind that the intention of
- :ts:cv:`ascii_buffer_size` is to simply provide a way for the user to
- configure different ``ASCII`` and ``ASCII_PIPE`` maximum line lengths.
-
-- :ts:cv:`proxy.config.log.log_buffer_size`: This is an orthogonal mechanism
- for limiting line length size by constraining the log entry buffer to a
- particular amount of memory. Unlike the above two configurations,
- :ts:cv:`log_buffer_size` applies to both binary and ASCII log file entries.
- For ASCII log files, if a maximum log size is set via the above mechanisms
- and by :ts:cv:`log_buffer_size`, then the smaller of the two configurations
- will be applied to the line length.
+The maximum line size for a log entry can be configured via the following
+parameters, the details of which are documented in the linked
+:file:`records.config` descriptions:
+
+- :ts:cv:`proxy.config.log.max_line_size`
+- :ts:cv:`proxy.config.log.ascii_buffer_size`
+- :ts:cv:`proxy.config.log.log_buffer_size`
Log Field Slicing
=================