You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ig...@apache.org on 2013/02/06 08:18:01 UTC
svn commit: r1442855 -
/trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
Author: igalic
Date: Wed Feb 6 07:18:00 2013
New Revision: 1442855
URL: http://svn.apache.org/viewvc?rev=1442855&view=rev
Log:
Present records.config entries that are reloadable (traffic_line -x) as such in our documentation.
Big thanks to Jan-Frode Myklebust <janfrode at tanso dot net> for this patch
Modified:
trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
Modified: trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext?rev=1442855&r1=1442854&r2=1442855&view=diff
==============================================================================
--- trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext (original)
+++ trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext Wed Feb 6 07:18:00 2013
@@ -82,6 +82,7 @@ the `records.config` file.
*`proxy.config.proxy_name`* {#proxy.config.proxy_name}
: `STRING`
: Default: *`build_machine`*
+: Reloadable.
: The name of the Traffic Server node.
*`proxy.config.bin_path`* {#proxy.config.bin_path}
@@ -133,6 +134,7 @@ the `records.config` file.
*`proxy.config.alarm_email`* {#proxy.config.alarm_email}
: `STRING`
: Default: (none)
+: Reloadable.
: The email address to which Traffic Server sends alarm messages. During a custom Traffic Server installation, you can specify the email address; otherwise, Traffic Server uses the Traffic Server user account name as the default value for this variable.
*`proxy.config.syslog_facility`* {#proxy.config.syslog_facility}
@@ -369,6 +371,7 @@ the `records.config` file.
*`proxy.config.http.insert_request_via_str`* {#proxy.config.http.insert_request_via_str}
: `INT`
: Default: `1`
+: Reloadable.
: You can specify one of the following:
* `0` = no extra information is added to the string.
@@ -381,6 +384,7 @@ the `records.config` file.
*`proxy.config.http.insert_response_via_str`* {#proxy.config.http.insert_response_via_str}
: `INT`
: Default: `1`
+: Reloadable.
: You can specify one of the following:
* `0` no extra information is added to the string.
@@ -390,6 +394,7 @@ the `records.config` file.
*`proxy.config.http.response_server_enabled`* {#proxy.config.http.response_server_enabled}
: `INT`
: Default: `1`
+: Reloadable.
: You can specify one of the following:
* `0` no Server: header is added to the response.
@@ -399,6 +404,7 @@ the `records.config` file.
*`proxy.config.http.insert_age_in_response`* {#proxy.config.http.insert_age_in_response}
: `INT`
: Default: `1`
+: Reloadable.
: This option specifies whether Traffic Server should insert an `Age` header in the response. The Age field value is the cache's estimate of the amount of time since the response was generated or revalidated by the origin server.
* `0` no `Age` header is added
@@ -407,16 +413,19 @@ the `records.config` file.
*`proxy.config.http.response_server_str`* {#proxy.config.http.response_server_str}
: `STRING`
: Default: `ATS/`
+: Reloadable.
: The Server: string that ATS will insert in a response header (if requested, see above). Note that the current version number is always appended to this string.
*`proxy.config.http.enable_url_expandomatic`* {#proxy.config.http.enable_url_expandomatic}
: `INT`
: Default: `1`
+: Reloadable.
: Enables (`1`) or disables (`0`) `.com` domain expansion. This configures the Traffic Server to resolve unqualified hostnames by prepending with `www.` and appending with `.com` before redirecting to the expanded address. For example: if a client makes a request to `host`, then Traffic Server redirects the request to `www.host.com`.
*`proxy.config.http.chunking_enabled`* {#proxy.config.http.chunking_enabled}
: `INT`
: Default: `1`
+: Reloadable.
: Specifies whether Traffic Sever can generate a chunked response:
* `0` Never
@@ -435,11 +444,13 @@ the `records.config` file.
*`proxy.config.http.record_heartbeat`* {#proxy.config.http.record_heartbeat}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) `traffic_cop` heartbeat logging.
*`proxy.config.http.use_client_target_addr`* {#proxy.config.http.use_client_target_addr}
: `INT`
: Default: `0`
+: Reloadable.
: Avoid DNS lookup for forward transparent requests:
* `0` Never.
@@ -471,39 +482,46 @@ the `records.config` file.
*`proxy.config.http.parent_proxy_routing_enable`* {#proxy.config.http.parent_proxy_routing_enable}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) the parent caching option. Refer to [Hierarchical Caching](../hierachical-caching).
*`proxy.config.http.parent_proxy.retry_time`* {#proxy.config.http.parent_proxy.retry_time}
: `INT`
: Default: `300`
+: Reloadable.
: The amount of time allowed between connection retries to a parent cache that is unavailable.
*`proxy.config.http.parent_proxy.fail_threshold`* {#proxy.config.http.parent_proxy.fail_threshold}
: `INT`
: Default: `10`
+: Reloadable.
: The number of times the connection to the parent cache can fail before Traffic Server considers the parent unavailable.
*`proxy.config.http.parent_proxy.total_connect_attempts`* {#proxy.config.http.parent_proxy.total_connect_attempts}
: `INT`
: Default: `4`
+: Reloadable.
: The total number of connection attempts allowed to a parent cache before Traffic Server bypasses the parent or fails the request (depending on the *`go_direct`* option in the `bypass.config` file).
*`proxy.config.http.parent_proxy.per_parent_connect_attempts`* {#proxy.config.http.parent_proxy.per_parent_connect_attempts}
: `INT`
: Default: `2`
+: Reloadable.
: The total number of connection attempts allowed per parent, if multiple parents are used.
*`proxy.config.http.parent_proxy.connect_attempts_timeout`* {#proxy.config.http.parent_proxy.connect_attempts_timeout}
: `INT`
: Default: `30`
+: Reloadable.
: The timeout value (in seconds) for parent cache connection attempts.
*`proxy.config.http.forward.proxy_auth_to_parent`* {#proxy.config.http.forward.proxy_auth_to_parent}
: `INT`
: Default: `0`
+: Reloadable.
: Configures Traffic Server to send proxy authentication headers on to the parent cache.
@@ -513,49 +531,58 @@ the `records.config` file.
*`proxy.config.http.keep_alive_no_activity_timeout_in`* {#proxy.config.http.keep_alive_no_activity_timeout_in}
: `INT`
: Default: `10`
+: Reloadable.
: Specifies how long Traffic Server keeps connections to clients open for a subsequent request after a transaction ends.
*`proxy.config.http.keep_alive_no_activity_timeout_out`* {#proxy.config.http.keep_alive_no_activity_timeout_out}
: `INT`
: Default: `10`
+: Reloadable.
: Specifies how long Traffic Server keeps connections to origin servers open for a subsequent transfer of data after a transaction ends.
*`proxy.config.http.transaction_no_activity_timeout_in`* {#proxy.config.http.transaction_no_activity_timeout_in}
: `INT`
: Default: `120`
+: Reloadable.
: Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
*`proxy.config.http.transaction_no_activity_timeout_out`* {#proxy.config.http.transaction_no_activity_timeout_out}
: `INT`
: Default: `120`
+: Reloadable.
: Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
*`proxy.config.http.transaction_active_timeout_in`* {#proxy.config.http.transaction_active_timeout_in}
: `INT`
: Default: `0`
+: Reloadable.
: The maximum amount of time Traffic Server can remain connected to a client. If the transfer to the client is not complete before this timeout expires, then Traffic Server closes the connection.
The default value of `0` specifies that there is no timeout.
*`proxy.config.http.transaction_active_timeout_out`* {#proxy.config.http.transaction_active_timeout_out}
: `INT`
: Default: `0`
+: Reloadable.
: The maximum amount of time Traffic Server waits for fulfillment of a connection request to an origin server. If Traffic Server does not complete the transfer to the origin server before this timeout expires, then Traffic Server terminates the connection request.
The default value of `0` specifies that there is no timeout.
*`proxy.config.http.accept_no_activity_timeout`* {#proxy.config.http.accept_no_activity_timeout}
: `INT`
: Default: `120`
+: Reloadable.
: The timeout interval in seconds before Traffic Server closes a connection that has no activity.
*`proxy.config.http.background_fill_active_timeout`* {#proxy.config.http.background_fill_active_timeout}
: `INT`
: Default: `60`
+: Reloadable.
: Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
*`proxy.config.http.background_fill_completed_threshold`* {#proxy.config.http.background_fill_completed_threshold}
: `FLOAT`
: Default: `0.50000`
+: Reloadable.
: The proportion of total document size already transferred when a client aborts at which the proxy continues fetching the document from the origin server to get it into the cache (a **background fill**).
@@ -564,51 +591,61 @@ the `records.config` file.
*`proxy.config.http.connect_attempts_max_retries`* {#proxy.config.http.connect_attempts_max_retries}
: `INT`
: Default: `6`
+: Reloadable.
: The maximum number of connection retries Traffic Server can make when the origin server is not responding.
*`proxy.config.http.connect_attempts_max_retries_dead_server`* {#proxy.config.http.connect_attempts_max_retries_dead_server}
: `INT`
: Default: `2`
+: Reloadable.
: The maximum number of connection retries Traffic Server can make when the origin server is unavailable.
*`proxy.config.http.server_max_connections`* {#proxy.config.http.server_max_connections}
: `INT`
: Default: `0`
+: Reloadable.
: Limits the number of socket connections across all origin servers to the value specified. To disable, set to zero (`0`).
*`proxy.config.http.origin_max_connections`* {#proxy.config.http.origin_max_connections}
: `INT`
: Default: `0`
+: Reloadable.
: Limits the number of socket connections per origin server to the value specified. To enable, set to one (`1`).
*`proxy.config.http.origin_min_keep_alive_connections`* {#proxy.config.http.origin_min_keep_alive_connections}
: `INT`
: Default: `0`
+: Reloadable.
: As connection to an origin server are opened, keep at least 'n' number of connections open to that origin, even if the connection isn't used for a long time period. Useful when the origin supports keep-alive, removing the time needed to set up a new connection from the next request at the expense of added (inactive) connections. To enable, set to one (`1`).
*`proxy.config.http.connect_attempts_rr_retries`* {#proxy.config.http.connect_attempts_rr_retries}
: `INT`
: Default: `2`
+: Reloadable.
: The maximum number of failed connection attempts allowed before a round-robin entry is marked as 'down' if a server has round-robin DNS entries.
*`proxy.config.http.connect_attempts_timeout`* {#proxy.config.http.connect_attempts_timeout}
: `INT`
: Default: `30`
+: Reloadable.
: The timeout value (in seconds) for an origin server connection.
*`proxy.config.http.post_connect_attempts_timeout`* {#proxy.config.http.post_connect_attempts_timeout}
: `INT`
: Default: `1800`
+: Reloadable.
: The timeout value (in seconds) for an origin server connection when the client request is a `POST` or `PUT` request.
*`proxy.config.http.down_server.cache_time`* {#proxy.config.http.down_server.cache_time}
: `INT`
: Default: `900`
+: Reloadable.
: Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
*`proxy.config.http.down_server.abort_threshold`* {#proxy.config.http.down_server.abort_threshold}
: `INT`
: Default: `10`
+: Reloadable.
: The number of seconds before Traffic Server marks an origin server as unavailable after a client abandons a request because the origin server was too slow in sending the response header.
@@ -625,6 +662,7 @@ the `records.config` file.
*`proxy.config.http.negative_caching_enabled`* {#proxy.config.http.negative_caching_enabled}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server caches negative responses (such as `404 Not Found`) when a requested page does not exist. The next time a client requests the same page, Traffic Server serves the negative response directly from cache.
**Note**: `Cache-Control` directives from the server forbidding cache are ignored for the following HTTP response codes, regardless of the value specified for the *`proxy.config.http.negative_caching_enabled`* variable. The following negative responses are cached by Traffic Server:
@@ -647,32 +685,38 @@ the `records.config` file.
*`proxy.config.http.anonymize_remove_from`* {#proxy.config.http.anonymize_remove_from}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server removes the `From` header to protect the privacy of your users.
*`proxy.config.http.anonymize_remove_referer`* {#proxy.config.http.anonymize_remove_referer}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server removes the `Referrer` header to protect the privacy of your site and users.
*`proxy.config.http.anonymize_remove_user_agent`* {#proxy.config.http.anonymize_remove_user_agent}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server removes the `User-agent` header to protect the privacy of your site and users.
*`proxy.config.http.anonymize_remove_cookie`* {#proxy.config.http.anonymize_remove_cookie}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server removes the `Cookie` header to protect the privacy of your site and users.
*`proxy.config.http.anonymize_remove_client_ip`* {#proxy.config.http.anonymize_remove_client_ip}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server removes `Client-IP` headers for more privacy.
*`proxy.config.http.anonymize_insert_client_ip`* {#proxy.config.http.anonymize_insert_client_ip}
: `INT`
: Default: `1`
+: Reloadable.
: When enabled (`1`), Traffic Server inserts `Client-IP` headers to retain the client IP address.
*`proxy.config.http.append_xforwards_header`* {#proxy.config.http.append_xforwards_header}
@@ -683,16 +727,19 @@ the `records.config` file.
*`proxy.config.http.anonymize_other_header_list`* {#proxy.config.http.anonymize_other_header_list}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The headers Traffic Server should remove from outgoing requests.
*`proxy.config.http.insert_squid_x_forwarded_for`* {#proxy.config.http.insert_squid_x_forwarded_for}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server adds the client IP address to the `X-Forwarded-For` header.
*`proxy.config.http.normalize_ae_gzip`* {#proxy.config.http.normalize_ae_gzip}
: `INT`
: Default: `0`
+: Reloadable.
: Enable (`1`) to normalize all `Accept-Encoding:` headers to one of the following:
- `Accept-Encoding: gzip` (if the header has `gzip` or `x-gzip` with any `q`) **OR**
@@ -706,6 +753,7 @@ the `records.config` file.
*`proxy.config.http.push_method_enabled`* {#proxy.config.http.push_method_enabled}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) the HTTP `PUSH` option, which allows you to deliver content directly to the cache without a user request.
**Important:** If you enable this option, then you must also specify a filtering rule in the [`ip_allow.config`](ip_allow.config) file to allow only certain machines to push content into the cache.
@@ -716,36 +764,43 @@ the `records.config` file.
*`proxy.config.cache.enable_read_while_writer`* {#proxy.config.cache.enable_read_while_writer}
: `INT`
: Default: `0`
+: 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. This must be enabled for connection collapsing to work
*`proxy.config.cache.force_sector_size`* {#proxy.config.cache.force_sector_size}
: `INT`
: Default: `512`
+: Reloadable.
: Forces the use of a specific hardware sector size (512 - 8192 bytes).
*`proxy.config.http.cache.http`* {#proxy.config.http.cache.http}
: `INT`
: Default: `1`
+: Reloadable.
: Enables (`1`) or disables (`0`) caching of HTTP requests.
*`proxy.config.http.cache.ignore_client_no_cache`* {#proxy.config.http.cache.ignore_client_no_cache}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server ignores client requests to bypass the cache.
*`proxy.config.http.cache.ims_on_client_no_cache`* {#proxy.config.http.cache.ims_on_client_no_cache}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server issues a conditional request to the origin server if an incoming request has a `No-Cache` header.
*`proxy.config.http.cache.ignore_server_no_cache`* {#proxy.config.http.cache.ignore_server_no_cache}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server ignores origin server requests to bypass the cache.
*`proxy.config.http.cache.cache_responses_to_cookies`* {#proxy.config.http.cache.cache_responses_to_cookies}
: `INT`
: Default: `3`
+: Reloadable.
: Specifies how cookies are cached:
* `0` = do not cache any responses to cookies
@@ -761,17 +816,20 @@ the `records.config` file.
*`proxy.config.http.cache.cache_urls_that_look_dynamic`* {#proxy.config.http.cache.cache_urls_that_look_dynamic}
: `INT`
: Default: `1`
+: Reloadable.
: Enables (`1`) or disables (`0`) caching of URLs that look dynamic, i.e.: URLs that end in **`.asp`** or contain a question mark (**`?`**), a semicolon (**`;`**), or **`cgi`**. For a full list, please refer to [HttpTransact::url_looks_dynamic](/link/to/doxygen)
*`proxy.config.http.cache.enable_default_vary_headers`* {#proxy.config.http.cache.enable_default_vary_headers}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) caching of alternate versions of HTTP objects that do not contain the `Vary` header.
*`proxy.config.http.cache.when_to_revalidate`* {#proxy.config.http.cache.when_to_revalidate}
: `INT`
: Default: `0`
+: Reloadable.
: Specifies when to revalidate content:
* `0` = use cache directives or heuristic (the default value)
@@ -786,6 +844,7 @@ the `records.config` file.
*`proxy.config.http.cache.when_to_add_no_cache_to_msie_requests`* {#proxy.config.http.cache.when_to_add_no_cache_to_msie_requests}
: `INT`
: Default: 0
+: Reloadable.
: Specifies when to add `no-cache` directives to Microsoft Internet Explorer requests. You can specify the following:
* `0` = `no-cache` is *not* added to MSIE requests
@@ -795,6 +854,7 @@ the `records.config` file.
*`proxy.config.http.cache.required_headers`* {#proxy.config.http.cache.required_headers}
: `INT`
: Default: `0`
+: Reloadable.
: The type of headers required in a request for the request to be cacheable.
* `0` = no headers required to make document cacheable
@@ -804,6 +864,7 @@ the `records.config` file.
*`proxy.config.http.cache.max_stale_age`* {#proxy.config.http.cache.max_stale_age}
: `INT`
: Default: `604800`
+: Reloadable.
: The maximum age allowed for a stale response before it cannot be cached.
*`proxy.config.http.cache.range.lookup`* {#proxy.config.http.cache.range.lookup}
@@ -835,11 +896,13 @@ the `records.config` file.
*`proxy.config.http.cache.fuzz.min_time`* {#proxy.config.http.cache.fuzz.min_time}
: `INT`
: Default: `0`
+: Reloadable.
: Sets a minimum fuzz time; the default value is `0`. **Effective fuzz time** is a calculation in the range (`fuzz.min_time` - `fuzz.min_time`).
*`proxy.config.http.cache.ignore_accept_mismatch`* {#proxy.config.http.cache.ignore_accept_mismatch}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server serves documents from cache with a `Content-Type:` header that does not match the `Accept:` header of the request.
**Note:** This option should only be enabled if you're having problems with caching *and* one of the following is true:
@@ -851,6 +914,7 @@ the `records.config` file.
*`proxy.config.http.cache.ignore_accept_language_mismatch`* {#proxy.config.http.cache.ignore_accept_language_mismatch}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server serves documents from cache with a `Content-Language:` header that does not match the `Accept-Language:` header of the request.
**Note:** This option should only be enabled if you're having problems with caching and your origin server is guaranteed to set `Vary: Accept-Language` when doing content negotiation with `Accept-Language`.
@@ -859,6 +923,7 @@ the `records.config` file.
*`proxy.config.http.cache.ignore_accept_charset_mismatch`* {#proxy.config.http.cache.ignore_accept_charset_mismatch}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server serves documents from cache with a `Content-Type:` header that does not match the `Accept-Charset:` header of the request.
**Note:** This option should only be enabled if you're having problems with caching and your origin server is guaranteed to set `Vary: Accept-Charset` when doing content negotiation with `Accept-Charset`.
@@ -866,11 +931,13 @@ the `records.config` file.
*`proxy.config.http.cache.ignore_client_cc_max_age`* {#proxy.config.http.cache.ignore_client_cc_max_age}
: `INT`
: Default: `1`
+: Reloadable.
: When enabled (`1`), Traffic Server ignores any `Cache-Control: max-age` headers from the client.
*`proxy.config.cache.permit.pinning`* {#proxy.config.cache.permit.pinning}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), Traffic Server will keep certain HTTP objects in the cache for a certain time as specified in [`cache.config`](cache.config).
# Heuristic Expiration # {#HeuristicExpiration}
@@ -878,27 +945,32 @@ the `records.config` file.
*`proxy.config.http.cache.heuristic_min_lifetime`* {#proxy.config.http.cache.heuristic_min_lifetime}
: `INT`
: Default: `3600` (1 hour)
+: Reloadable.
: The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
*`proxy.config.http.cache.heuristic_max_lifetime`* {#proxy.config.http.cache.heuristic_max_lifetime}
: `INT`
: Default: `86400` (1 day)
+: Reloadable.
: The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
*`proxy.config.http.cache.heuristic_lm_factor`* {#proxy.config.http.cache.heuristic_lm_factor}
: `FLOAT`
: Default: `0.10000`
+: Reloadable.
: The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that elapsed since it last changed.
*`proxy.config.http.cache.fuzz.time`* {#proxy.config.http.cache.fuzz.time}
: `INT`
: Default: `240`
+: Reloadable.
: How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval specified must be in seconds.
*`proxy.config.http.cache.fuzz.probability`* {#proxy.config.http.cache.fuzz.probability}
: `FLOAT`
: Default: `0.00500`
+: Reloadable.
: The probability that a refresh is made on a document during the specified fuzz time.
# Dynamic Content & Content Negotiation # {#DynamicContentAndContentNegotiation}
@@ -906,17 +978,20 @@ the `records.config` file.
*`proxy.config.http.cache.vary_default_text`* {#proxy.config.http.cache.vary_default_text}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The header on which Traffic Server varies for text documents.
For example: if you specify `User-agent`, then Traffic Server caches all the different user-agent versions of documents it encounters.
*`proxy.config.http.cache.vary_default_images`* {#proxy.config.http.cache.vary_default_images}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The header on which Traffic Server varies for images.
*`proxy.config.http.cache.vary_default_other`* {#proxy.config.http.cache.vary_default_other}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The header on which Traffic Server varies for anything other than text and images.
@@ -956,11 +1031,13 @@ the `records.config` file.
*`proxy.config.dns.search_default_domains`* {#proxy.config.dns.search_default_domains}
: `INT`
: Default: `1`
+: Reloadable.
: Enables (`1`) or disables (`0`) local domain expansion so that Traffic Server can attempt to resolve unqualified hostnames by expanding to the local domain. For example: if a client makes a request to an unqualified host (`host_x`) and the Traffic Server local domain is `y.com` , then Traffic Server will expand the hostname to `host_x.y.com`.
*`proxy.config.dns.splitDNS.enabled`* {#proxy.config.dns.splitDNS.enabled}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) DNS server selection. When enabled, Traffic Server refers to the `splitdns.config` file for the selection specification. Refer to [Configuring DNS Server Selection (Split DNS)](../security-options#ConfiguringDNSServerSelectionSplit).
@@ -979,16 +1056,19 @@ the `records.config` file.
*`proxy.config.dns.round_robin_nameservers`* {#proxy.config.dns.round_robin_nameservers}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) DNS server round-robin.
*`proxy.config.dns.nameservers`* {#proxy.config.dns.nameservers}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The DNS servers.
*`proxy.config.srv_enabled`* {#proxy.config.srv_enabled}
: `INT`
: Default: `0`
+: Reloadable.
: Indicates whether to use SRV records for orgin server lookup.
@@ -1014,6 +1094,7 @@ the `records.config` file.
*`proxy.config.hostdb.ttl_mode`* {#proxy.config.hostdb.ttl_mode}
: `INT`
: Default: `0`
+: Reloadable.
: The host database time to live mode. You can specify one of the following:
* `0` = obey
@@ -1024,11 +1105,13 @@ the `records.config` file.
*`proxy.config.hostdb.timeout`* {#proxy.config.hostdb.timeout}
: `INT`
: Default: `1440`
+: Reloadable.
: The foreground timeout (in minutes).
*`proxy.config.hostdb.strict_round_robin`* {#proxy.config.hostdb.strict_round_robin}
: `INT`
: Default: `0`
+: Reloadable.
: When disabled (`0`), Traffic Server always uses the same origin server for the same client, for as long as the origin server is available.
@@ -1037,6 +1120,7 @@ the `records.config` file.
*`proxy.config.log.logging_enabled`* {#proxy.config.log.logging_enabled}
: `INT`
: Default: `3`
+: Reloadable.
: Enables and disables event logging:
* `0` = logging disabled
@@ -1049,37 +1133,44 @@ the `records.config` file.
*`proxy.config.log.max_secs_per_buffer`* {#proxy.config.log.max_secs_per_buffer}
: `INT`
: Default: `5`
+: Reloadable.
: The maximum amount of time before data in the buffer is flushed to disk.
*`proxy.config.log.max_space_mb_for_logs`* {#proxy.config.log.max_space_mb_for_logs}
: `INT`
: Default: `2000`
+: Reloadable.
: The amount of space allocated to the logging directory (in MB). **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 max_space_mb_for_orphan_logs is set to a higher value than max_space_mb_for_logs, TS will take proxy.config.log.max_space_mb_for_orphan_logs for maximum allowed log space.
*`proxy.config.log.max_space_mb_for_orphan_logs`* {#proxy.config.log.max_space_mb_for_orphan_logs}
: `INT`
: Default: `25`
+: Reloadable.
: The amount of space allocated to the logging directory (in MB) if this node is acting as a collation client. **Note:** When max_space_mb_for_orphan_logs is take as the maximum allowedlog space in the logging system, the same rule apply to proxy.config.log.max_space_mb_for_logs also apply to proxy.config.log.max_space_mb_for_orphan_logs, ie: All files in the logging directory contribute to the space used, even if they are not log files. you may need to consider this when you enable full remote logging, and bump to the same size as proxy.config.log.max_space_mb_for_logs.
*`proxy.config.log.max_space_mb_headroom`* {#proxy.config.log.max_space_mb_headroom}
: `INT`
: Default: `10`
+: Reloadable.
: The tolerance for the log space limit (in bytes). If the variable *`proxy.config.log.auto_delete_rolled_file`* is set to `1` (enabled), then autodeletion of log files is triggered when the amount of free space available in the logging directory is less than the value specified here.
*`proxy.config.log.hostname`* {#proxy.config.log.hostname}
: `STRING`
: Default: `localhost`
+: Reloadable.
: The hostname of the machine running Traffic Server.
*`proxy.config.log.logfile_dir`* {#proxy.config.log.logfile_dir}
: `STRING`
: Default: *`install_dir`*`/logs`
+: Reloadable.
: The full path to the logging directory. This can be an absolute path or a path relative to the directory in which Traffic Server is installed. **Note:** The directory you specify must already exist.
*`proxy.config.log.logfile_perm`* {#proxy.config.log.logfile_perm}
: `STRING`
: Default: `rw-r--r--`
+: Reloadable.
: The log file permissions. The standard UNIX file permissions are used (owner, group, other). Permissible values are:
`-`no permission
@@ -1092,17 +1183,20 @@ the `records.config` file.
*`proxy.config.log.custom_logs_enabled`* {#proxy.config.log.custom_logs_enabled}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) custom logging.
*`proxy.config.log.squid_log_enabled`* {#proxy.config.log.squid_log_enabled}
: `INT`
: Default: `1`
+: Reloadable.
: Enables (`1`) or disables (`0`) the [squid log file format](../working-log-files/log-formats#SquidFormat).
*`proxy.config.log.squid_log_is_ascii`* {#proxy.config.log.squid_log_is_ascii}
: `INT`
: Default: `1`
+: Reloadable.
: The squid log file type:
* `1` = ASCII
@@ -1111,6 +1205,7 @@ the `records.config` file.
*`proxy.config.log.squid_log_name`* {#proxy.config.log.squid_log_name}
: `STRING`
: Default: `squid`
+: Reloadable.
: The [squid log](../working-log-files/log-formats#SquidFormat) filename.
*`proxy.config.log.squid_log_header`* {#proxy.config.log.squid_log_header}
@@ -1121,11 +1216,13 @@ the `records.config` file.
*`proxy.config.log.common_log_enabled`* {#proxy.config.log.common_log_enabled}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) the [Netscape common log file format](../working-log-files/log-formats#NetscapeFormats).
*`proxy.config.log.common_log_is_ascii`* {#proxy.config.log.common_log_is_ascii}
: `INT`
: Default: `1`
+: Reloadable.
: The [Netscape common log](../working-log-files/log-formats#NetscapeFormats) file type:
* `1` = ASCII
@@ -1134,16 +1231,19 @@ the `records.config` file.
*`proxy.config.log.common_log_name`* {#proxy.config.log.common_log_name}
: `STRING`
: Default: `common`
+: Reloadable.
: The [Netscape common log](../working-log-files/log-formats#NetscapeFormats) filename.
*`proxy.config.log.common_log_header`* {#proxy.config.log.common_log_header}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The [Netscape common log](../working-log-files/log-formats#NetscapeFormats) file header text.
*`proxy.config.log.extended_log_enabled`* {#proxy.config.log.extended_log_enabled}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) the [Netscape extended log file format](../working-log-files/log-formats#NetscapeFormats).
*`proxy.confg.log.extended_log_is_ascii`* {#proxy.confg.log.extended_log_is_ascii}
@@ -1162,16 +1262,19 @@ the `records.config` file.
*`proxy.config.log.extended_log_header`* {#proxy.config.log.extended_log_header}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The [Netscape extended log](../working-log-files/log-formats#NetscapeFormats) file header text.
*`proxy.config.log.extended2_log_enabled`* {#proxy.config.log.extended2_log_enabled}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) the [Netscape Extended-2 log file format](../working-log-files/log-formats#NetscapeFormats).
*`proxy.config.log.extended2_log_is_ascii`* {#proxy.config.log.extended2_log_is_ascii}
: `INT`
: Default: `1`
+: Reloadable.
: The [Netscape Extended-2 log](../working-log-files/log-formats#NetscapeFormats) file type:
* `1` = ASCII
@@ -1180,16 +1283,19 @@ the `records.config` file.
*`proxy.config.log.extended2_log_name`* {#proxy.config.log.extended2_log_name}
: `STRING`
: Default: `extended2`
+: Reloadable.
: The [Netscape Extended-2 log](../working-log-files/log-formats#NetscapeFormats) filename.
*`proxy.config.log.extended2_log_header`* {#proxy.config.log.extended2_log_header}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The [Netscape Extended-2 log](../working-log-files/log-formats#NetscapeFormats) file header text.
*`proxy.config.log.separate_icp_logs`* {#proxy.config.log.separate_icp_logs}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), configures Traffic Server to store ICP transactions in a separate log file.
* `0` = separation is disabled, all ICP transactions are recorded in the same file as HTTP transactions
@@ -1200,11 +1306,13 @@ the `records.config` file.
*`proxy.config.log.separate_host_logs`* {#proxy.config.log.separate_host_logs}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), configures Traffic Server to create a separate log file for HTTP transactions for each origin server listed in the `log_hosts.config` file. Refer to [HTTP Host Log Splitting](../working-log-files#HTTPHostLogSplitting).
*`proxy.local.log.collation_mode`* {#proxy.local.log.collation_mode}
: `INT`
: Default: `0`
+: Reloadable.
: The log collation mode:
* `0` = collation is disabled
@@ -1225,26 +1333,31 @@ the `records.config` file.
*`proxy.config.log.collation_port`* {#proxy.config.log.collation_port}
: `INT`
: Default: `8085`
+: Reloadable.
: The port used for communication between the collation server and client.
*`proxy.config.log.collation_secret`* {#proxy.config.log.collation_secret}
: `STRING`
: Default: `foobar`
+: Reloadable.
: The password used to validate logging data and prevent the exchange of unauthorized information when a collation server is being used.
*`proxy.config.log.collation_host_tagged`* {#proxy.config.log.collation_host_tagged}
: `INT`
: Default: `0`
+: Reloadable.
: When enabled (`1`), configures Traffic Server to include the hostname of the collation client that generated the log entry in each entry.
*`proxy.config.log.collation_retry_sec`* {#proxy.config.log.collation_retry_sec}
: `INT`
: Default: `5`
+: Reloadable.
: The number of seconds between collation server connection retries.
*`proxy.config.log.rolling_enabled`* {#proxy.config.log.rolling_enabled}
: `INT`
: Default: `1`
+: Reloadable.
: Specifies how log files are rolled. You can specify the following values:
* `0` = disables log file rolling
@@ -1256,6 +1369,7 @@ the `records.config` file.
*`proxy.config.log.rolling_interval_sec`* {#proxy.config.log.rolling_interval_sec}
: `INT`
: Default: `86400`
+: Reloadable.
: The log file rolling interval, in seconds. The minimum value is `300` (5 minutes). The maximum value is 86400 seconds (one day).
**Note:** If you start Traffic Server within a few minutes of the next rolling time, then rolling might not occur until the next rolling time.
@@ -1263,21 +1377,25 @@ the `records.config` file.
*`proxy.config.log.rolling_offset_hr`* {#proxy.config.log.rolling_offset_hr}
: `INT`
: Default: `0`
+: Reloadable.
: The file rolling offset hour. The hour of the day that starts the log rolling period.
*`proxy.config.log.rolling_size_mb`* {#proxy.config.log.rolling_size_mb}
: `INT`
: Default: `10`
+: Reloadable.
: The size that log files must reach before rolling takes place.
*`proxy.config.log.auto_delete_rolled_files`* {#proxy.config.log.auto_delete_rolled_files}
: `INT`
: Default: `1`
+: Reloadable.
: Enables (`1`) or disables (`0`) automatic deletion of rolled files.
*`proxy.config.log.sampling_frequency`* {#proxy.config.log.sampling_frequency}
: `INT`
: Default: `1`
+: Reloadable.
: Configures Traffic Server to log only a sample of transactions rather than every transaction. You can specify the following values:
* `1` = log every transaction
@@ -1288,6 +1406,7 @@ the `records.config` file.
*`proxy.config.http.slow.log.threshold`* {#proxy.config.http.slow.log.threshold}
: `INT`
: Default: `0`
+: Reloadable.
: The number of milliseconds before a slow connection's debugging stats are dumped. Specify `1` to enable or `0` to disable.
# Diagnostic Logging Configuration # {#DiagnosticLogging}
@@ -1319,6 +1438,7 @@ the `records.config` file.
*`proxy.config.reverse_proxy.enabled`* {#proxy.config.reverse_proxy.enabled}
: `INT`
: Default: `1`
+: Reloadable.
: Enables (`1`) or disables (`0`) HTTP reverse proxy.
@@ -1326,6 +1446,7 @@ the `records.config` file.
*`proxy.config.header.parse.no_host_url_redirect`* {#proxy.config.header.parse.no_host_url_redirect}
: `STRING`
: Default: `NULL`
+: Reloadable.
: The URL to which to redirect requests with no host headers (reverse proxy).
@@ -1334,21 +1455,25 @@ the `records.config` file.
*`proxy.config.url_remap.default_to_server_pac`* {#proxy.config.url_remap.default_to_server_pac}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) requests for a PAC file on the proxy service port (8080 by default) to be redirected to the PAC port. For this type of redirection to work, the variable *`proxy.config.reverse_proxy.enabled`* must be set to `1`.
*`proxy.config.url_remap.default_to_server_pac_port`* {#proxy.config.url_remap.default_to_server_pac_port}
: `INT`
: Default: `-1`
+: Reloadable.
: Sets the PAC port so that PAC requests made to the Traffic Server proxy service port are redirected this port. `-1` is the default setting that sets the PAC port to the autoconfiguration port (the default autoconfiguration port is 8083). This variable can be used together with the *`proxy.config.url_remap.default_to_server_pac`* variable to get a PAC file from a different port. You must create and run a process that serves a PAC file on this port. For example: if you create a Perl script that listens on port 9000 and writes a PAC file in response to any request, then you can set this variable to `9000`. Browsers that request the PAC file from a proxy server on port 8080 will get the PAC file served by the Perl script.
*`proxy.config.url_remap.remap_required`* {#proxy.config.url_remap.remap_required}
: `INT`
: Default: `1`
+: Reloadable.
: Set this variable to `1` if you want Traffic Server to serve requests only from origin servers listed in the mapping rules of the `remap.config` file. If a request does not match, then the browser will receive an error.
*`proxy.config.url_remap.pristine_host_hdr`* {#proxy.config.url_remap.pristine_host_hdr}
: `INT`
: Default: `1`
+: Reloadable.
: Set this variable to `1` if you want to retain the client host header in a request during remapping.
@@ -1508,11 +1633,13 @@ the `records.config` file.
*`proxy.config.icp.icp_port`* {#proxy.config.icp.icp_port}
: `INT`
: Default: `3130`
+: Reloadable.
: Specifies the UDP port that you want to use for ICP messages.
*`proxy.config.icp.query_timeout`* {#proxy.config.icp.query_timeout}
: `INT`
: Default: `2`
+: Reloadable.
: Specifies the timeout used for ICP queries.
@@ -1526,21 +1653,25 @@ the `records.config` file.
*`proxy.config.update.force`* {#proxy.config.update.force}
: `INT`
: Default: `0`
+: Reloadable.
: Enables (`1`) or disables (`0`) a force immediate update. When enabled, Traffic Server overrides the scheduling expiration time for all scheduled update entries and initiates updates until this option is disabled.
*`proxy.config.update.retry_count`* {#proxy.config.update.retry_count}
: `INT`
: Default: `10`
+: Reloadable.
: Specifies the number of times Traffic Server can retry the scheduled update of a URL in the event of failure.
*`proxy.config.update.retry_interval`* {#proxy.config.update.retry_interval}
: `INT`
: Default: `2`
+: Reloadable.
: Specifies the delay (in seconds) between each scheduled update retry for a URL in the event of failure.
*`proxy.config.update.concurrent_updates`* {#proxy.config.update.concurrent_updates}
: `INT`
: Default: `100`
+: Reloadable.
: Specifies the maximum simultaneous update requests allowed at any time. This option prevents the scheduled update process from overburdening the host.