You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@trafficserver.apache.org by Igor Galić <i....@brainsware.org> on 2013/11/06 23:15:45 UTC
Re: git commit: DOC: Added hit evacuation vars, some other
records.config cleanup
----- Original Message -----
> Updated Branches:
> refs/heads/master 1cebaefb0 -> 44c7f5d1e
>
>
> DOC: Added hit evacuation vars, some other records.config cleanup
>
>
> Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
> Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/44c7f5d1
> Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/44c7f5d1
> Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/44c7f5d1
>
> Branch: refs/heads/master
> Commit: 44c7f5d1e00ec10b822903fd2c7343dad12539f3
> Parents: 1cebaef
> Author: Alan M. Carroll <am...@network-geographics.com>
> Authored: Wed Nov 6 11:07:26 2013 -0600
> Committer: Alan M. Carroll <am...@network-geographics.com>
> Committed: Wed Nov 6 11:07:26 2013 -0600
>
> ----------------------------------------------------------------------
> doc/glossary.en.rst | 18 ++++----
> .../configuration/records.config.en.rst | 43 ++++++++++++--------
> 2 files changed, 34 insertions(+), 27 deletions(-)
> ----------------------------------------------------------------------
>
>
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/44c7f5d1/doc/glossary.en.rst
> ----------------------------------------------------------------------
> diff --git a/doc/glossary.en.rst b/doc/glossary.en.rst
> index a3180f6..e103fee 100644
> --- a/doc/glossary.en.rst
> +++ b/doc/glossary.en.rst
> @@ -38,18 +38,13 @@ Glossary
> Server receives a request, and ends when Traffic Server sends the
> response.
>
> cache volume
> - Persistent storage for the cache, defined and manipulable by the user.
> - Cache volumes are defined in :file:`volume.config`. A cache volume is
> - spread across :term:`cache span`\ s to increase performance through
> - parallel I/O. Storage units can be split across cache volumes. Each
> - such part of a storage unit in a cache volume is a :term:`cache
> stripe`.
> + A user defined unit of persistent storage for the cache. Cache volumes
> are defined in :file:`volume.config`. A
> + cache volume is by default spread across :term:`cache span`\ s to
> increase robustness. Each section of a cache
> + volume on a specific cache span is a :term:`cache stripe`.
>
> cache stripe
> - A homogenous persistent store for the cache. A volume always resides
> - entirely on a single physical device and is treated as an
> - undifferentiated span of bytes.
> -
> - See also :term:`cache span`, :term:`cache volume`
> + A homogenous persistent store for the cache in a single :term:`cache
> span`. A stripe always resides
> + entirely on a single physical device and is treated as an
> undifferentiated span of bytes.
>
> cache span
> The physical storage described by a single line in
> :file:`storage.config`.
> @@ -61,3 +56,6 @@ Glossary
> Verifying that a currently cached object is still valid. This is
> usually done using an `If-Modified-Since
> <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25>`_
> request which allows the origin server to
> validate the content without resending the content.
> +
> + write cursor
> + The location in a :term:`cache stripe` where new data is written.
>
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/44c7f5d1/doc/reference/configuration/records.config.en.rst
> ----------------------------------------------------------------------
> diff --git a/doc/reference/configuration/records.config.en.rst
> b/doc/reference/configuration/records.config.en.rst
> index 3917048..ce614f9 100644
> --- a/doc/reference/configuration/records.config.en.rst
> +++ b/doc/reference/configuration/records.config.en.rst
> @@ -55,7 +55,7 @@ A variable marked as ``Reloadable`` can be updated via the
> command::
> ``INT`` type configurations are expressed as any normal integer,
> e.g. *32768*. They can also be expressed using more human readable values
> using standard prefixes, e.g. *32K*. The following prefixes are supported
> -for all ``INT` type configurations
> +for all ``INT`` type configurations
>
> - ``K`` Kilobytes (1024 bytes)
> - ``M`` Megabytes (1024^2 or 1,048,576 bytes)
> @@ -181,7 +181,7 @@ otherwise, Traffic Server uses the Traffic Server user
> account name as the defau
> .. ts:cv:: CONFIG proxy.config.syslog_facility STRING LOG_DAEMON
>
> The facility used to record system log files. Refer to
> - :ref:`Understanding Traffic Server Log Files
> <working-log-files.en.html#understanding-traffic-server-log-files>`_.
> + :ref:`Understanding Traffic Server Log Files
> <working-log-files.en.html#understanding-traffic-server-log-files>`.
These "links" are still broken. If you were looking to actually fix it,
the target should be:
diff --git doc/admin/working-log-files.en.rst doc/admin/working-log-files.en.rst
index ae03c98..479d2cc 100644
--- doc/admin/working-log-files.en.rst
+++ doc/admin/working-log-files.en.rst
@@ -31,6 +31,8 @@ This chapter discusses the following topics:
working-log-files/log-formats.en
+.. _understanding-traffic-server-log-files:
+
Understanding Traffic Server Log Files
======================================
diff --git doc/reference/configuration/records.config.en.rst doc/reference/configuration/records.config.en.rst
index ce614f9..9f69b1f 100644
--- doc/reference/configuration/records.config.en.rst
+++ doc/reference/configuration/records.config.en.rst
@@ -181,7 +181,7 @@ otherwise, Traffic Server uses the Traffic Server user account name as the defau
.. ts:cv:: CONFIG proxy.config.syslog_facility STRING LOG_DAEMON
The facility used to record system log files. Refer to
- :ref:`Understanding Traffic Server Log Files <working-log-files.en.html#understanding-traffic-server-log-files>`.
+ :ref:`Understanding Traffic Server Log Files <understanding-traffic-server-log-files>`_.
.. ts:cv:: CONFIG proxy.config.cop.core_signal INT 0
>
> .. ts:cv:: CONFIG proxy.config.cop.core_signal INT 0
>
> @@ -817,7 +817,7 @@ Congestion Control
>
> Enables (``1``) or disables (``0``) the Congestion Control option, which
> configures Traffic Server to stop forwarding
> HTTP requests to origin servers when they become congested. Traffic
> Server sends the client a message to retry the
> - congested origin server later. Refer to :ref:`Using Congestion Control
> <http-proxy-caching#UsingCongestionControl>`_.
> + congested origin server later. Refer to :ref:`Using Congestion Control
> <http-proxy-caching#UsingCongestionControl>`.
>
> .. ts:cv:: CONFIG proxy.config.http.flow_control.enabled INT 0
>
> @@ -947,7 +947,7 @@ Cache Control
> :reloadable:
>
> Enables (``1``) or disables (``0``) ability to a read cached object while
> the another connection is completing the write to cache for
> - the same object. Several other configuration values need to be set for
> this to become active. See :ref:`Reducing Origin Server Requests
> <http-proxy-caching.en.html#reducing-origin-server-requests-avoiding-the-thundering-herd>`
> + the same object. Several other configuration values need to be set for
> this to become active. See :ref:`Reducing Origin Server Requests
> <http-proxy-caching.en.html#reducing-origin-server-requests-avoiding-the-thundering-herd>`
>
> .. ts:cv:: CONFIG proxy.config.cache.force_sector_size INT 512
> :reloadable:
> @@ -1052,12 +1052,6 @@ Cache Control
>
> When enabled (``1``), Traffic Server looks up range requests in the
> cache.
>
> -.. ts:cv:: CONFIG proxy.config.http.cache.enable_read_while_writer INT 0
> -
> - Enables (``1``) or disables (``0``) the ability to read a cached object
> while another connection is completing a write to cache
> - for the same object.
> -
> -
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_accept_mismatch INT 0
> :reloadable:
>
> @@ -1071,8 +1065,8 @@ Cache Control
> problems with caching *and* you origin server doesn't set the ``Vary``
> header. Alternatively, if the origin is incorrectly setting
> ``Vary: Accept`` or doesn't respond with ``406 (Not Acceptable)``,
> - you can also enable this configuration with a ``1`.
> -
> + you can also enable this configuration with a ``1``.
> +
>
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_accept_language_mismatch
> INT 0
> :reloadable:
> @@ -1088,7 +1082,7 @@ Cache Control
> problems with caching *and* you origin server doesn't set the ``Vary``
> header. Alternatively, if the origin is incorrectly setting
> ``Vary: Accept-Language`` or doesn't respond with ``406 (Not
> Acceptable)``,
> - you can also enable this configuration with a ``1`.
> + you can also enable this configuration with a ``1``.
>
>
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_accept_encoding_mismatch
> INT 0
> @@ -1105,7 +1099,7 @@ Cache Control
> problems with caching *and* you origin server doesn't set the ``Vary``
> header. Alternatively, if the origin is incorrectly setting
> ``Vary: Accept-Encoding`` or doesn't respond with ``406 (Not
> Acceptable)``
> - you can also enable this configuration with a ``1`.
> + you can also enable this configuration with a ``1``.
>
>
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_accept_charset_mismatch INT
> 0
> @@ -1122,7 +1116,7 @@ Cache Control
> problems with caching *and* you origin server doesn't set the ``Vary``
> header. Alternatively, if the origin is incorrectly setting
> ``Vary: Accept-Charset`` or doesn't respond with ``406 (Not
> Acceptable)``,
> - you can also enable this configuration with a ``1`.
> + you can also enable this configuration with a ``1``.
>
>
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
> @@ -1141,6 +1135,23 @@ Cache Control
>
> When enabled (``1``), Traffic Server will keep certain HTTP objects in
> the cache for a certain time as specified in cache.config.
>
> +.. ts:cv:: CONFIG proxy.config.cache.hit_evacuate_percent INT 10
> +
> + The size of the region (as a percentage of the total content storage in a
> :term:`cache stripe`) in front of the
> + :term:`write cursor` that constitutes a recent access hit for evacutating
> the accessed object.
> +
> + When an object is accessed it can be marked for evacuation, that is to be
> copied over the write cursor and
> + thereby preserved from being overwritten. This is done if it is no more
> than a specific number of bytes in front of
> + the write cursor. The number of bytes is a percentage of the total number
> of bytes of content storage in the cache
> + stripe where the object is stored and that percentage is set by this
> variable.
> +
> +.. ts:cv:: CONFIG proxy.config.cache.hit_evacuate_size_limit INT 0
> + :metric: bytes
> +
> + Limit the size of objects that are hit evacuated.
> +
> + Objects larger than the limit are not hit evacuated. A value of 0
> disables the limit.
> +
> RAM Cache
> =========
>
> @@ -2109,5 +2120,3 @@ These are referenced but not documented. Please
> contribute a definition.
> .. ts:cv:: CONFIG proxy.config.cache.limits.http.max_alts INT 5
>
> .. ts:cv:: CONFIG proxy.config.http.enabled INT 1
> -
> -
>
>
--
Igor Galić
Tel: +43 (0) 664 886 22 883
Mail: i.galic@brainsware.org
URL: http://brainsware.org/
GPG: 8716 7A9F 989B ABD5 100F 4008 F266 55D6 2998 1641