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 2011/03/23 03:56:50 UTC
svn commit: r1084466 [15/20] -
/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext?rev=1084466&r1=1084465&r2=1084466&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/records.config.en.mdtext Wed Mar 23 02:56:50 2011
@@ -1,4 +1,4 @@
-Title: Configuration Files
+Title: Configuration Files - records.config
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,1197 +16,7 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-Available Languages: [LANG]
-
-# Appendix E - Configuration Files # {#files}
-
-This appendix describes Traffic Server configuration files that you can edit.
-
-[TOC]
-
-
-## bypass.config ## {#bypass.config}
-
-The bypass.config file contains static bypass rules that Traffic Server
-uses in transparent proxy caching mode. Static bypass rules instruct
-Traffic Server to bypass certain incoming client requests so they are
-served by the origin server. The bypass.config file also accepts
-[Dynamic Deny Bypass Rules](#dynamic.deny_bypass).
-
-You can configure three types of static bypass rules:
-- **Source bypass rules** configure Traffic Server to bypass a particular
- source IP address or range of IP addresses. For example: bypass
- clients that do not want to use caching.
-- **Destination bypass rules** configure Traffic Server to bypass a
- particular destination IP address or range of IP addresses. For
- example: bypass origin servers that use IP authentication based on the
- client's real IP address.
- **IMPORTANT:** Destination bypass rules prevent Traffic Server from
- caching an entire site. You will experience hit rate impacts if the
- site you bypass is popular.
-- **Source/destination pair bypass rules** configure Traffic Server to
- bypass requests that originate from the specified source to the
- specified destination. For example: route around specific
- client-server pairs that experience broken IP authentication or
- out-of-band HTTP traffic problems when cached. Source/destination
- bypass rules can be preferable to destination rules because they block
- a destination server only for users that experience problems.
-
-**IMPORTANT:** After you modify the bypass.config file, you must restart
-Traffic Server.
-
-
-#### Format ####
-
-Bypass rules follow the format below:
-
- bypass src ipaddress | dst ipaddress | src ipaddress AND dst ipaddress
-
-The following list describes the variables.
-
-`src` *`ipaddress`*
-: Specifies the source (client) IP address in incoming requests Traffic
- Server must bypass.
-
- The variable ipaddress can be one of the following:
-
- - A simple IP address, such as 123.45.67.8
- - In CIDR (Classless Inter-Domain Routing) format, such as 1.1.1.0/24
- - A range separated by a dash, such as 1.1.1.1-2.2.2.2
- - Any combination of the above separated by commas, such as 1.1.1.0/24,
- 25.25.25.25, 123.1.23.1-123.1.23.123
-
-`dst` *`ipaddress`*
-: Specifies the destination (origin server) IP address in incoming
- requests Traffic Server must bypass.
-
- The variable ipaddress can be one of the following:
-
- - A simple IP address, such as 123.45.67.8
- - In CIDR (Classless Inter-Domain Routing) format, such as 1.1.1.0/24
- - A range separated by a dash, such as 1.1.1.1-2.2.2.2
- - Any combination of the above separated by commas, such as 1.1.1.0/24,
- 25.25.25.25, 123.1.23.1-123.1.23.123
-
-`src` *`ipaddress`* `AND dst` *`ipaddress`*
-: Specifies the source and destination IP address pair Traffic Server must
- bypass.
-
-The variable ipaddress must be a single IP address, such as 123.45.67.8
-
-
-#### Dynamic Deny Bypass Rules #### {#dynamic.bypass\_rules}
-
-In addition to static bypass rules, the bypass.config file also accepts
-dynamic deny bypass rules that prevent Traffic Server from bypassing
-certain incoming client requests dynamically (a deny bypass rule can
-prevent Traffic Server from bypassing itself). Dynamic deny bypass rules
-can be source, destination, or source/destination and have the following
-format:
-
- deny_dyn_bypass src ipaddress | dst ipaddress | src ipaddresss AND ipaddress
-
-For a description of the options, refer to the table above. For the
-dynamic deny bypass rules to work, you must set the variable
-`proxy.config.arm.bypass_dynamic_enabled` to `1` in the
-[records.config](#records.config) file.
-
-**IMPORTANT:** Static bypass rules overwrite dynamic deny bypass rules. If a
-static bypass rule and a dynamic bypass rule contain the same IP address,
-then the dynamic deny bypass rule will be ignored.
-
-
-#### Examples ####
-
-The following example shows source, destination, and source/destination
-**bypass rules**:
-
- bypass src 1.1.1.0/24, 25.25.25.25, 128.252.11.11-128.252.11.255
- bypass dst 24.24.24.0/24
- bypass src 25.25.25.25 AND dst 24.24.24.0
-
-The following example shows source, destination, and source/destination
-**dynamic deny bypass rules**:
-
- deny_dyn_bypass src 128.252.11.11-128.252.11.255
- deny_dyn_bypass dst 111.111.11.1
- deny_dyn_bypass src 111.11.11.1 AND dst 111.11.1.1
-
-
-
-## cache.config ## {#cache.config}
-
-The cache.config file defines how Traffic Server caches web objects. You
-can add caching rules to specify the following:
-- Not to cache objects from specific IP addresses
-- How long to pin particular objects in the cache
-- How long to consider cached objects as fresh
-- Whether to ignore no-cache directives from the server
-
-**IMPORTANT:** After you modify the `cache.config file`, navigate to the Traffic
-Server bin directory; then run the `traffic_line -x` command to apply
-changes. When you apply the changes to a node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-
-
-#### Format ####
-
-Each line in the cache.config file contains a caching rule. Traffic Server
-recognizes three space-delimited tags:
-
- primary_destination=value secondary_specifier=value action=value
-
-You can use more than one secondary specifier in a rule. However, you
-cannot repeat a secondary specifier.
-The following list shows the possible primary destinations with allowed values.
-
-*`dest_domain`*
-: A requested domain name. Traffic Server matches the domain name of the
- destination from the URL in the request.
-
-*`dest_host`*
-: A requested hostname. Traffic Server matches the hostname of the
- destination from the URL in the request.
-
-*`dest_ip`*
-: A requested IP address. Traffic Server matches the IP address of the
- destination in the request.
-
-*`url_regex`*
-: A regular expression (regex) to be found in a URL.
-
-
-The secondary specifiers are optional in the cache.config file. The
-following list shows possible secondary specifiers with allowed values.
-
-*`port`*
-: A requested URL port.
-
-*`scheme`*
-: A request URL protocol: http or https.
-
-*`prefix`*
-: A prefix in the path part of a URL.
-
-*`suffix`*
-: A file suffix in the URL.
-
-*`method`*
-: A request URL method: get, put, post, trace.
-
-*`time`*
-: A time range, such as 08:00-14:00.
-
-*`src_ip`*
-: A client IP address.
-
-
-The following list shows possible actions and their allowed values.
-
-*`action`*
-: One of the following values:
-
- `never-cache` configures Traffic Server to never cache specified objects.
- `ignore-no-cache` configures Traffic Server to ignore all
- `Cache-Control: no-cache` headers.
- `ignore-client-no-cache` configures Traffic Server to ignore
- `Cache-Control: no-cache` headers from client requests.
- `ignore-server-no-cache` configures Traffic Server to ignore
- `Cache-Control: no-cache` headers from origin server responses.
-
-*`pin-in-cache`*
-: The amount of time you want to keep the object(s) in the cache. The
- following time formats are allowed:
-
- `d` for days; for example: 2d
- `h` for hours; for example: 10h
- `m` for minutes; for example: 5m
- `s` for seconds; for example: 20s
- mixed units; for example: 1h15m20s
-
-*`revalidate`*
-: The amount of time object(s) are to be considered fresh. Use the same
- time formats as `pin-in-cache`.
-
-*`ttl-in-cache`*
-: The amount of time object(s) are to be kept in the cache, regardless of
- Cache-Control response headers. Use the same time formats as
- pin-in-cache and revalidate .
-
-
-#### Examples ####
-
-The following example configures Traffic Server to revalidate `gif` and `jpeg`
-objects in the domain `mydomain.com` every 6 hours, and all other objects in
-`mydomain.com` every hour. The rules are applied in the order listed.
-
- dest_domain=mydomain.com suffix=gif revalidate=6h
- dest_domain=mydomain.com suffix=jpeg revalidate=6h
- dest_domain=mydomain.com revalidate=1h
-
-
-## congestion.config ## {#congestion.config}
-
-The `congestion.config` file enables you to configure Traffic Server to stop
-forwarding HTTP requests to origin servers when they become congested, and
-then send the client a message to retry the congested origin server later.
-After you modify the `congestion.control` file, navigate to the Traffic
-Server bin directory; then run the `traffic_line -x` command to apply
-changes. When you apply the changes to a node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-Traffic Server uses the `congestion.config` file only if you enable the
-[Congestion Control](http#UsingCongestionControl) option.
-
-You can create rules in the congestion.config file to specify:
-- Which origin servers Traffic Server tracks for congestion.
-- The timeouts Traffic Server uses, depending on whether a server is
- congested.
-- The page Traffic Server sends to the client when a server becomes
- congested.
-- If Traffic Server tracks the origin servers per IP address or per
- hostname.
-
-
-#### Format ####
-
-Each line in `congestion.config` must follow the format below. Traffic
-Server applies the rules in the order listed, starting at the top of the
-file.
-Traffic Server recognizes three space-delimited tags:
-
- primary_destination=value secondary_specifier=value action=value
-
-The following list shows possible primary destinations with allowed
-values.
-
-*`dest_domain`*
-: A requested domain name.
-
-*`dest_host`*
-: A requested hostname.
-
-*`dest_ip`*
-: A requested IP address.
-
-*`url_regex`*
-: A regular expression (regex) to be found in a URL.
-
-The secondary specifiers are optional in the congestion.config file. The
-following list shows possible secondary specifiers with allowed values.
-You can use more than one secondary specifier in a rule; however, you
-cannot repeat a secondary specifier.
-
-*`port`*
-: A requested URL port or range of ports.
-
-*`prefix`*
-: A prefix in the path part of a URL.
-
-The following list shows the possible tags and their allowed values.
-
-*`max_connection_failures`*
-: Default: `5`
-: The maximum number of connection failures allowed within the fail
- window described below before Traffic Server marks the origin server as
- congested.
-
-*`fail_window`*
-: Default: `120` seconds.
-: The time period during which the maximum number of connection failures
- can occur before Traffic Server marks the origin server as congested.
-
-*`proxy_retry_interval`*
-: Default: `10` seconds.
-: The number of seconds that Traffic Server waits before contacting a
- congested origin server again.
-
-*`client_wait_interval`*
-: Default: `300` seconds.
-: The number of seconds that the client is advised to wait before
- retrying the congested origin server.
-
-*`wait_interval_alpha`*
-: Default: `30` seconds
-: The upper limit for a random number that is added to the wait interval.
-
-*`live_os_conn_timeout`*
-: Default: `60` seconds.
-: The connection timeout to the live (uncongested) origin server.
- If a client stops a request before the timeout occurs, then Traffic
- Server does not record a connection failure.
-
-*`live_os_conn_retries`*
-: Default: `2`
-: The maximum number of retries allowed to the live (uncongested) origin
- server.
-
-*`dead_os_conn_timeout`*
-: Default: `15` secondsj
-: The connection timeout to the congested origin server.
-
-*`dead_os_conn_retries`*
-: Default: `1`
-: The maximum number of retries allowed to the congested origin server.
-
-*`max_connection`*
-: Default: `-1`
-: The maximum number of connections allowed from Traffic Server to the
- origin server.
-
-*`error_page`*
-: Default: `"congestion#retryAfter"`
-: The error page sent to the client when a server is congested. You must
- enclose the value in quotes;
-
-*`congestion_scheme`*
-: Default: `"per_ip"`
-: Specifies if Traffic Server applies the rule on a per-host (`"per_host"`)
- or per-IP basis (`"per_ip"`). You must enclose the value in quotes.
-
- For example: if the server `www.host1.com` has two IP addresses and you
- use the tag value `"per_ip"`, then each IP address has its own number of
- connection failures and is marked as congested independently. If you
- use the tag value `"per_host"` and the server `www.host1.com` is marked as
- congested, then both IP addresses are marked as congested.
-
-
-#### Examples ####
-
-The following `congestion.config` rule configures Traffic Server to stop
-forwarding requests to the server `www.host.com` on port 80 (HTTP traffic)
-if the server is congested, according to the timeouts specified. Traffic
-Server uses the default tag values because no tag has been specified.
-
- dest_host=www.host.com port=80
-
-You can use one or more tags in a rule, but each tag must have one value
-only. If you specify no tags in the rule, then Traffic Server uses the
-default values.
-
-You can override any of the default tag values by adding configuration
-variables at the end of `records.config` as follows:
-
- CONFIG proxy.config.http.congestion_control.default.tag INT|STRING value
-
-where tag is one of the tags described in the table under
-[congestion.config](#congestion.config) and value is the value you want to use.
-
-For example:
-
- CONFIG proxy.config.http.congestion_control.default.congestion_scheme STRING per_host
-
-**IMPORTANT:** Rules in the congestion.config file override the following
-variables in the records.config file:
-
- proxy.config.http.connect_attempts_max_retries
- proxy.config.http.connect_attempts_max_retries_dead_server
- proxy.config.http.connect_attempts_rr_retries
- proxy.config.http.connect_attempts_timeout
- proxy.config.http.down_server.cache_time
- proxy.config.http.down_server.abort_threshold
-
-
-
-## hosting.config ## {#hosting.config}
-
-The `hosting.config` file enables you to assign cache partitions to specific
-origin servers and/or domains so that you can manage cache space
-efficiently and restrict disk usage. For step-by-step instructions on
-partitioning the cache according to origin servers and/or domains, refer
-to [Partitioning the Cache](cache) According to Origin Server or Domain.
-Before you can assign cache partitions to specific origin servers and/or
-domains, you must first partition your cache according to size and
-protocol in the [partition.config](#partition.config) file.
-For step-by-step instructions about partitioning your cache, refer to
-[Partitioning the Cache](cache). For a description of the
-`partition.config` file, refer to [partition.config](#partition.config).
-
-After you modify hosting.config, navigate to the Traffic Server bin
-directory and run the `traffic_line -x` command to apply your changes. When
-you apply the changes to a node in a cluster, Traffic Server automatically
-applies the changes to all other nodes in the cluster.
-
-**IMPORTANT:** The partition configuration must be the same on all nodes in a
-cluster.
-
-
-#### Format ####
-
-Each line in the `hosting.config` file must have one of the following
-formats:
-
- hostname= hostname partition= partition_numbers
- domain= domain_name partition= partition_numbers
-
-where hostname is the fully-qualified hostname of the origin server whose
-content you want to store on a particular partition (for example,
-`www.myhost.com`); `domain_name` is the domain whose content you want to store
-on a particular partition(for example, `mydomain.com`); and
-`partition_numbers` is a comma-separated list of the partitions on which you
-want to store the content that belongs to the origin server or domain
-listed. The partition numbers must be valid numbers listed in the
-[partition.config](#partition.config) file.
-
-**Note:** To allocate more than one partition to an origin server or domain,
-you must enter the partitions in a comma-separated list on one line, as
-shown in the example below. The [hosting.config](#hosting.config) file
-cannot contain multiple entries for the same origin server or domain.
-
-
-#### Generic Partition ####
-
-When configuring the hosting.config file, you must assign a generic
-partition to use for content that does not belong to any of the origin
-servers or domains listed. If all partitions for a particular origin
-server become corrupt, Traffic Server will also use the generic partition
-to store content for that origin server.
-
-The generic partition must have the following format:
-
- hostname=* partition=partition_numbers
-
-where `partition_numbers` is a comma-separated list of generic partitions.
-
-
-#### Examples ####
-
-The following example configures Traffic Server to store content from the
-domain `mydomain.com` in partition 1 and content from `www.myhost.com` in
-partition 2. Traffic Server stores content from all other origin servers
-in partitions 3 and 4.
-
- domain=mydomain.com partition=1
- hostname=www.myhost.com partition=2
- hostname=* partition=3,
-
-
-## icp.config ## {#icp.config}
-
-The `icp.config` file defines ICP peers (parent and sibling caches).
-
-**IMPORTANT:** After you modify the icp.config file, navigate to the Traffic
-Server bin directory and run the `traffic_line -x` command to apply the
-changes. When you apply the changes to a node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-
-#### Format ####
-Each line in the icp.config file contains the name and configuration
-information for a single ICP peer in the following format:
-
- host : host_IP : peer_type : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :
-
-Each field is described in the following list.
-
-`host`
-: The hostname of the ICP peer.
- This field is optional; if you do not specify the hostname of the ICP
- peer, you must specify the IP address.
-
-`host _IP`
-: The IP address of the ICP peer.
- This field is optional; if you do not specify the IP address of the ICP
- peer, you must specify the hostname.
-
-`ctype`
-: Use the following options:
-
- 1 to indicate an ICP parent cache
- 2 to indicate an ICP sibling cache
-
-`proxy_port`
-: The port number of the TCP port used by the ICP peer for proxy
- communication.
-
-`icp_port`
-: The port number of the UDP port used by the ICP peer for ICP
- communication.
-
-
-#### Examples ####
-
-The following example configuration is for three nodes: the local host,
-one parent, and one sibling.
-
- localhost:0.0.0.0:3:8080:3130:0:0.0.0.0:1
- host1:123.12.1.23:1:8080:3131:0:0.0.0.0:1
- host2:123.12.1.24:2:8080:3131:0:0.0.0.0:1
-
-
-## ip\_allow.config ## {#ip\_allow.config}
-
-The `ip_allow.config` file controls client access to the Traffic Server
-proxy cache. You can specify ranges of IP addresses that are allowed to
-use the Traffic Server as a web proxy cache.
-After you modify the `ip_allow.config` file, navigate to the Traffic Server
-bin directory and run the `traffic_line -x` command to apply changes. When
-you apply the changes to a node in a cluster, Traffic Server automatically
-applies the changes to all other nodes in the cluster.
-
-
-#### Format ####
-
-Each line in the `ip_allow.config` file must have the following format:
-
- src_ip=ipaddress action=ip_allow | ip_deny
-
-where ipaddress is the IP address or range of IP addresses of the clients
-allowed to access the Traffic Server proxy cache, the action `ip_allow`
-enables the specified clients to access the Traffic Server proxy cache,
-and `ip_deny` denies the specified clients to access the Traffic Server
-proxy cache.
-
-By default, the `ip_allow.config` file contains the following line, which
-allows all clients to access the Traffic Server proxy cache. To restrict
-access, comment out or delete this line before adding rules:
-
- src_ip=0.0.0.0-255.255.255.255 action=ip_allow
-
-
-#### Examples ####
-
-The following example enables all clients to access the Traffic Server
-proxy cache:
-
- src_ip=0.0.0.0-255.255.255.255 action=ip_allow
-
-The following example allows all clients on a specific subnet to access
-the Traffic Server proxy cache:
-
- src_ip=123.12.3.000-123.12.3.123 action=ip_allow
-
-The following example denies all clients on a specific subnet to access
-the Traffic Server proxy cache:
-
- src_ip=123.45.6.0-123.45.6.123 action=ip_deny
-
-
-## logs.config ## {#logs.config}
-
-The `logs.config` file establishes and formats **traditional**
-custom transaction log files.
-Although Traffic Server supports traditional custom logging, you
-should use the more versatile XML-based custom logging (refer to
-[Using the Custom Format](log) and
-[logs\_xml.config](#logs_xml.config)). If you opt to use
-traditional custom logging instead of the more versatile XML-based
-custom logging, then you must enable the traditional custom logging
-option manually (refer to
-[Support for Traditional Custom Logging](log)).
-
-**IMPORTANT:** After you modify `logs.config`, navigate to the
-Traffic Server`bin` directory and run the `traffic_line -x` command
-to apply changes. When you apply the changes to a node in a
-cluster, Traffic Server automatically applies the changes to all
-other nodes in the cluster.
-
-
-#### Format ####
-
-Each line in the `logs.config` file establishes and formats a
-custom transaction log file. Lines consist of the following fields,
-separated by colons (:).
-
-*`format`*
-: All lines must begin with the word `format` .
-
-*`activation flag`*
-: Specifies if the custom log file is activated. You can specify one
- of the following options:
-
- enabled
- disabled
-
-*`unique format identifier`*
-: You must use a unique integer for each custom log file you create.
-
-*`format name`*
-: The name for the format you define.
-
-*`format string`*
-: Identifies the `printf` -style format string specifying the field
- symbols to be displayed and how they should look in ASCII. Refer to
- this [Appendix](logfmts) for a list of the available field
- symbols and their meanings.
-
- Field symbols are indicated by %<`field_symbol` \> format. For
- example: to indicate that `chi` is the client host IP and not the
- string `chi` to be printed, enter `% <chi>` .
-
-*`file name`*
-: The name of the custom log file you create.
-
-*`file type`*
-: The format of the file: `ASCII` or `BINARY.`
-
-*`file header data`*
-: The header text. Enter `none` if you do not want header text; enter
- the text of the header if you want your custom log file to have a
- header.
-
-
-#### Examples ####
-
-The following example shows a custom log format for a file named
-**`minimalist`**. It records the client host IP address (`chi`),
-the client request universal resource identifier (`cqu`), and the
-proxy response status code (`pssc`).
-
- format:enabled:1:minimal:%<chi> / %<cqu> / %<pssc>:minimalist:ASCII:none
-
-The output file for the above example format is:
-
- 123.12.3.123 / GET http://earth/ocean/index.html HTTP/1.0 / 200
-
-The following example shows a custom log format for a file named
-**`test`**. It records the `User-Agent`value of the client
-request header (`cqh`) and the `Retry-After` value of the proxy
-response header (`psh`).
-
- format:enabled:1:test:%<{User-Agent}cqh> %<{Retry-After}psh>:test:ASCII:none
-
-
-#### WELF ####
-
-Traffic Server supports **WELF**, the WebTrends Enhanced Log
-format, so you can analyze Traffic Server log files with WebTrends
-reporting tools. A predefined custom format for WELF is provided in
-the `logs.config` file. To create a WELF format log file, comment
-out the following section at the end of the file and replace
-`<FORMAT_ID>` with a unique integer.
-
- #format:enabled:<FORMAT_ID>:welf:id=firewall time="%<cqtd> %<cqtt>" fw=%<phn> pri=6 proto=%<cqus> duration=%<ttmsf> sent=%<psql> rcvd=%<cqhl> src=%<chi> dst=%<shi> dstname=%<shn> user=%<caun> op=%<cqhm> arg="%<cqup>" result=%<pssc> ref="%<{Referer}cqh>" agent="%<{user-agent}cqh>" cache=%<crc>:welf:ASCII:none
-
-
- #
-
-
-## log\_hosts.config ## {#log\_hosts.config}
-
-To record HTTP transactions for different origin servers in
-separate log files, you must list each origin server hostname in
-the `log_hosts.config` file. In addition, you must enable the
-[HTTP Host Log Splitting](log) option. You should use the same
-`log_hosts.config` file on every Traffic Server node in your
-cluster. After you modify the `log_hosts.config` file,
-navigate to the Traffic Server`bin` directory and run the
-`traffic_line -x` command to apply the changes. When you apply the
-changes to a node in a cluster, Traffic Server automatically
-applies the changes to all other nodes in the cluster.
-
-
-#### Format ####
-
-Each line in the `log_hosts.config` file has the following format:
-
-*`hostname`*
-
-where *`hostname`* is the hostname of the origin server.
-
-**Tip:** You can specify keywords in the `log_hosts.config` file to
-record all transactions from origin servers with the specified
-keyword in their names in a separate log file. See the example
-below.
-
-
-#### Examples ####
-
-The following example configures Traffic Server to create separate
-log files containing all HTTP transactions for the origin servers
-`webserver1`, `webserver2`, and `webserver3`.
-
- webserver1
- webserver2
- webserver3
-
-The following example records all HTTP transactions from origin
-servers that contain `sports` in their names. For example:
-`sports.yahoo.com` and `www.foxsports.com` in a log file called
-`squid-sport.log` (the Squid format is enabled).
-
- sports
-
-
-
-## logs\_xml.config ## {#logs\_xml.config}
-
-The `logs_xml.config` file defines the custom log file formats,
-filters, and processing options. The format of this file is modeled
-after **XML**, the Extensible Markup Language.
-
-
-#### Format ####
-
-The `logs_xml.config` file contains the specifications below:
-
-- `LogFormat` specifies the fields to be gathered from each
- protocol event access.
-- `LogFilter` specifies the filters that are used to include or
- exclude certain entries being logged based on the value of a field
- within that entry.
-- `LogObject` specifies an object that contains a particular
- format, a local filename, filters, and collation servers.
-
-The `logs_xml.config` file ignores extra white space, blank lines,
-and all comments.
-
-
-#### LogFormat #### {#logformat}
-
-The following list shows **`LogFormat`** specifications.
-
-
-`<Name = "valid_format_name"/>`
-: Required. Valid format names include any name except `squid`,
- `common`, `extended`, or `extended2`, which are pre-defined
- formats. There is no default for this tag.
-
-`<Format = "valid_format_specification"/>`
-: Required. A valid format specification is a printf-style string
- describing each log entry when formatted for ASCII output. Use
- `%<` `*field*` `>` as a placeholder for valid field names. For
- more information, refer to
- [Custom Logging Fields](logfmts#custom-logging-fields).
-
- The specified field can be one of the following types:
-
- Simple. For example: `%<cqu>`
- A field within a container, such as an HTTP header or a statistic.
- Fields of this type have the syntax:
-
- %<{ field } containe>
-
- Aggregates, such as `COUNT`, `SUM`, `AVG`, `FIRST`, `LAST`. Fields
- of this type have the syntax: `%<operator (` *`field`* `)>`
- **Note:** You cannot create a format specification that contains
- both aggregate operators and regular fields.
-
-`<Interval = "aggregate_interval_secs"/>`
-: Use this tag when the format contains aggregate operators. The
- value "`aggregate_interval_secs`" represents the number of seconds
- between individual aggregate values being produced.
-
- The valid set of aggregate operators are:
-
- COUNT
- SUM
- AVG
- FIRST
- LAST
-
-
-### LogFilters ### {#logfilters}
-
-The following list shows the `LogFilter` specifications.
-
-`<Name = "valid_filter_name"/>`
-: Required. All filters must be uniquely named.
-
-`<Condition = "valid_log_field valid_operator valid_comparison_value"/>`
-: Required. This field contains the following elements:
-
- **`valid\_log\_field`** - the field that will be compared against
- the given value. For more information, refer to
- [Logging Format Cross-Reference](logfmts#cross-reference).
-
- **`valid\_operator\_field`** - any one of the following: `MATCH`,
- `CASE_INSENSITIVE_MATCH`, `CONTAIN`, `CASE_INSENSITIVE_CONTAIN`.
-
- - `MATCH` is true if the field and value are identical
- (case-sensitive).
- - `CASE_INSENSITIVE_MATCH` is similar to `MATCH`, except that it
- is case-**insensitive**.
- - `CONTAIN` is true if the field contains the value (the value is
- a substring of the field).
- - `CASE_INSENSITIVE_CONTAIN` is a case-insensitive version of
- `CONTAIN`.
-
- **`valid\_comparison\_value`** - any string or integer matching
- the field type. For integer values, all of the operators are
- equivalent and mean that the field must be equal to the specified
- value.
-
- **Note:** There are no negative comparison operators. If you want to
- specify a negative condition, then use the `Action` field to
- `REJECT` the record.
-
-`<Action = "valid_action_field"/>`
-: This instructs Traffic Server to either accept or reject records
- that satisfy the filter condition. `<br />`Required:`ACCEPT` or
- `REJECT` .
-
-
-### LogObject ### {#LogObject}
-
-The following list shows the `LogObject` specifications.
-
-`<Format = "valid_format_name"/>`
-: Required. Valid format names include the predefined logging
- formats: `squid`, `common`, `extended`, and `extended2`, as well as
- any previously-defined custom log formats. There is no default for
- this tag.
-
-`<Filename = "file_name"/>`
-: Required. The filename to which the given log file is written on
- the local file system or on a remote collation server. No local log
- file will be created if you fail to specify this tag. All filenames
- are relative to the default logging directory.
-
- If the name does not contain an extension (for example, `squid`),
- then the extension `.log` is automatically appended to it for ASCII
- logs and `.blog` for binary logs (refer to
- [Mode = "valid\_logging\_mode"](files#0_73225)).
-
- If you do not want an extension to be added, then end the filename with a
- single (.) dot (for example: `squid.` ).
-
-`<Mode = "valid_logging_mode"/>`
-: Valid logging modes include `ascii` , `binary` , and `ascii_pipe` .
- The default is `ascii` .
-
- - Use `ascii` to create event log files in human-readable form
- (plain ASCII).
- - Use `binary` to create event log files in binary format.
- Binary log files generate lower system overhead and occupy less
- space on the disk (depending on the information being logged). You
- must use the `logcat` utility to translate binary log files to
- ASCII format before you can read them.
- - Use `ascii_pipe` to write log entries to a UNIX named pipe (a
- buffer in memory). Other processes can then read the data using
- standard I/O functions. The advantage of using this option is that
- Traffic Server does not have to write to disk, which frees disk
- space and bandwidth for other tasks. In addition, writing to a pipe
- does not stop when logging space is exhausted because the pipe does
- not use disk space.
-
- If you are using a collation server, then the log is written to a
- pipe on the collation server. A local pipe is created even before a
- transaction is processed, so you can see the pipe right after
- Traffic Server starts. Pipes on a collation server, however, *are*
- created when Traffic Server starts.
-
-`<Filters = "list_of_valid_filter_names"/>`
-: A comma-separated list of names of any previously-defined log
- filters. If more than one filter is specified, then all filters
- must accept a record for the record to be logged.
-
-`<Protocols = "list_of_valid_protocols"/>`
-: A comma-separated list of the protocols this object should log.
- Valid protocol names for this release are `HTTP` (FTP is
- deprecated).
-
-`<ServerHosts = "list_of_valid_servers"/>`
-: A comma-separated list of valid hostnames.This tag indicates that
- only entries from the named servers will be included in the file.
-
-`<CollationHosts = "list_of_valid_hostnames"/>`
-: A comma-separated list of collation servers to which all log
- entries (for this object) are forwarded. Collation servers can be
- specified by name or IP address. Specify the collation port with a
- colon after the name; for example, `host:port` .
-
-`<Header = "header"/>`
-: The header text you want the log files to contain. The header text
- appears at the beginning of the log file, just before the first
- record.
-
-`<RollingEnabled = "truth value"/>`
-: Enables or disables log file rolling for the `LogObject`. This
- setting overrides the value for the
- *`proxy.config.log.rolling_enabled`* variable in the
- `records.config` file. Set *`truth value`* to one of the
- following values:
-
- `0` to disable rolling for this particular `LogObject`.
- `1` to roll log files at specific intervals during the day (you
- specify time intervals with the `RollingIntervalSec` and
- `RollingOffsetHr` fields).
- `2` to roll log files when they reach a certain size (you specify
- the size with the`RollingSizeMb` field).
- `3` to roll log files at specific intervals during the day or when
- they reach a certain size (whichever occurs first).
- `4` to roll log files at specific intervals during the day when log
- files reach a specific size (at a specified time if the file is of
- the specified size).
-
-
-`<RollingIntervalSec = "seconds"/>`
-: The seconds between log file rolling for the `LogObject`; enables
- you to specify different rolling intervals for different
- `LogObjects`.
- This setting overrides the value for
- *`proxy.config.log.rolling_interval_sec`* in the
- `records.config` file.
-
-`<RollingOffsetHr = "hour"/>`
-: Specifies an hour (from 0 to 23) at which rolling is guaranteed to
- align. Rolling might start before then, but a rolled file will be
- produced only at that time. The impact of this setting is only
- noticeable if the rolling interval is larger than one hour.
- This setting overrides the configuration setting
- for *`proxy.config.log.rolling_offset_hr`* in the
- `records.config` file.
-
-`<RollingSizeMb = "size_in_MB"/>`
-: The size at which log files are rolled.
-
-
-#### Examples ####
-
-The following is an example of a **`LogFormat`** specification
-that collects information using three common fields:
-
- <LogFormat>
- <Name = "minimal"/>
- <Format = "%<chi> : %<cqu> : %<pssc>"/>
- </LogFormat>
-
-The following is an example of a **`LogFormat`** specification
-that uses aggregate operators:
-
- <LogFormat>
- <Name = "summary"/>
- <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)>"/>
- <Interval = "10"/>
- </LogFormat>
-
-The following is an example of a **`LogFilter`** that will cause
-only `REFRESH_HIT` entries to be logged:
-
- <LogFilter>
- <Name = "only_refresh_hits"/>
- <Action = "ACCEPT"/>
- <Condition = "%<pssc> MATCH REFRESH_HIT"/>
- </LogFilter>
-
-**Note:** When specifying the field in the filter condition, you
-can omit the`%<>`. This means that the filter below is equivalent
-to the example directly above:
-
- <LogFilter>
- <Name = "only_refresh_hits"/>
- <Action = "ACCEPT"/>
- <Condition = "pssc MATCH REFRESH_HIT"/>
- </LogFilter>
-The following is an example of a **`LogObject`** specification
-that creates a local log file for the minimal format defined
-earlier. The log filename will be `minimal.log` because this is an
-ASCII log file (the default).
-
- <LogObject>
- <Format = "minimal"/>
- <Filename = "minimal"/>
- </LogObject>
-
-The following is an example of a **`LogObject`** specification
-that includes only HTTP requests served by hosts in the domain
-`company.com` or by the specific server `server.somewhere.com`. Log
-entries are sent to port 4000 of the collation host
-`logs.company.com` and to port 5000 of the collation host
-`209.131.52.129.`
-
- <LogObject>
- <Format = "minimal"/>
- <Filename = "minimal"/>
- <ServerHosts = "company.com,server.somewhere.com"/>
- <Protocols = "http"/>
- <CollationHosts = "logs.company.com:4000,209.131.52.129:5000"/>
- </LogObject>
-
-
-#### WELF ####
-
-Traffic Server supports WELF (WebTrends Enhanced Log Format) so you
-can analyze Traffic Server log files with WebTrends reporting
-tools. A predefined `<LogFormat>` that is compatible with WELF is
-provided at the end of the `logs.config` file (shown below).
-To create a WELF format log file, create a `<LogObject>` that
-uses this predefined format.
-
- <LogFormat>
- <Name = "welf"/>
- <Format = "id=firewall time=\"%<cqtd> %<cqtt>\" fw=%<phn> pri=6
- proto=%<cqus> duration=%<ttmsf> sent=%<psql> rcvd=%<cqhl>
- src=%<chi> dst=%<shi> dstname=%<shn> user=%<caun> op=%<cqhm>
- arg=\"%<cqup>\" result=%<pssc> ref=\"%<{Referer}cqh>\"
- agent=\"%<{user-agent}cqh>\" cache=%<crc>"/>
- </LogFormat>
-
-
-## parent.config ## {#parent.config}
-
-The `parent.config` file identifies the parent proxies used in an
-cache hierarchy. Use this file to perform the following
-configuration:
-
-- Set up parent cache hierarchies, with multiple parents and
- parent failover
-- Configure selected URL requests to bypass parent proxies
-
-Traffic Server uses the `parent.config` file only when the parent
-caching option is enabled (refer to
-[Configuring Traffic Server to Use a Parent Cache](hier)).
-
-**IMPORTANT:** After you modify the `parent.config` file, navigate
-to the Traffic Server`bin` directory and run the `traffic_line -x`
-command to apply your changes. When you apply the changes to one
-node in a cluster, Traffic Server automatically applies the changes
-to all other nodes in the cluster.
-
-
-#### Format ####
-
-Each line in the `parent.config` file must contain a parent caching
-rule. Traffic Server recognizes three space-delimited tags:
-
- primary_destination=value secondary_specifie=value action=value
-
-The following list shows the possible primary destinations and
-their allowed values.
-
-*`dest_domain`*
-: A requested domain name.
-
-*`dest_host`*
-: A requested hostname.
-
-*`dest_ip`*
-: A requested IP address or range of IP addresses separated by a dash
- (-).
-
-*`url_regex`*
-: A regular expression (regex) to be found in a URL
-
-The secondary specifiers are optional in the `parent.config` file.
-The following list shows the possible secondary specifiers and
-their allowed values.
-
-*`port`*
-: A requested URL port.
-
-*`scheme`*
-: A request URL protocol: `http` or `https`.
-
-*`prefix`*
-: A prefix in the path part of a URL.
-
-*`suffix`*
-: A file suffix in the URL.
-
-*`method`*
-: A request URL method. It can be one of the following:
-
- get
- post
- put
- trace
-
-*`time`*
-: A time range, such as 08:00-14:00, during which the parent cache is
- used to serve requests.
-
-*`src_ip`*
-: A client IP address.
-
-The following list shows the possible actions and their allowed
-values.
-
-`parent`
-: An ordered list of parent servers. If the request cannot be handled
- by the last parent server in the list, then it will be routed to
- the origin server. You can specify either a hostname or an IP
- address, but; you must specify the port number.
-
-`round_robin`
-: One of the following values:
-
- `true` - Traffic Server goes through the parent cache list in a
- round robin-based on client IP address.
- `strict` - Traffic Server machines serve requests strictly in turn.
- For example: machine `proxy1` serves the first request, `proxy2`
- serves the second request, and so on.
- `false` - Round robin selection does not occur.
-
-`go_direct`
-: One of the following values:
-
- `true` - requests bypass parent hierarchies and go directly to the
- origin server.
- `false` - requests do not bypass parent hierarchies.
-
-
-### Examples ###
-
-The following rule configures a parent cache hierarchy consisting
-of Traffic Server (which is the child) and two parents, `p1.x.com`
-and `p2.x.com`. Traffic Server forwards the requests it cannot
-serve to the parent servers `p1.x.com` and `p2.x.com` in a
-round-robin fashion because:
-
- round_robin=true
- dest_domain=. method=get parent="p1.x.com:8080; p2.y.com:8080" round_robin=true
-
-The following rule configures Traffic Server to route all requests
-containing the regular expression `politics` and the path
-/`viewpoint` directly to the origin server (bypassing any parent
-hierarchies):
-`url_regex=politics prefix=/viewpoint go_direct=true`
-
-Every line in the `parent.config` file must contain either a
-`parent=` or `go_direct=` directive.
-
-
-## partition.config ## {#parition.config}
-
-The `partition.config` file enables you to manage your cache space
-more efficiently and restrict disk usage by creating cache
-partitions of different sizes for specific protocols. You can
-further configure these partitions to store data from certain
-origin servers and/or domains in
-the [hosting.config](#hosting.config) file.
-
-**IMPORTANT:** The partition configuration must be the same on all
-nodes in a cluster. You must stop Traffic Server before you change
-the cache partition size and protocol assignment. For step-by-step
-instructions about partitioning the cache, refer to
-[Partitioning the Cache](cache).
-
-
-#### Format ####
-
-For each partition you want to create, enter a line with the
-following format:
-
- partition=partition_number scheme=protocol_type size=partition_size
-
-where *`partition_number`* is a number between 1 and 255 (the
-maximum number of partitions is 255) and *`protocol_type`* is
-`http`. Traffic Server supports `http` for HTTP partition types;
-*`partition_size`* is the amount of cache space allocated to
-the partition. This value can be either a percentage of the total
-cache space or an absolute value. The absolute value must be a
-multiple of 128 MB, where 128 MB is the smallest value. If you
-specify a percentage, then the size is rounded down to the closest
-multiple of 128 MB.
-
-Each partition is striped across several disks to achieve parallel
-I/O. For example: if there are four disks, then a 1-GB partition
-will have 256 MB on each disk (assuming each disk has enough free
-space available). If you do not allocate all the disk space in the
-cache, then the extra disk space is not used. You can use the extra
-space later to create new partitions without deleting and clearing
-the existing partitions.
-
-
-#### Examples ###
-
-The following example partitions the cache evenly between HTTP and
-HTTPS requests:
-
- partition=1 scheme=http size=50%
- partition=2 scheme=https size=50%
-
-
-## records.config ## {#records.config}
+# records.config # {#records.config}
The `records.config` file is a list of configurable variables used
by the Traffic Server software. Many of the variables in the
@@ -1218,7 +28,7 @@ apply the changes. When you apply change
Traffic Server automatically applies the changes to all other nodes
in the cluster.
-#### Format ####
+## Format ## {#Format}
Each variable has the following format:
CONFIG variable_name DATATYPE variable_value
@@ -1226,7 +36,7 @@ Each variable has the following format:
where `DATATYPE` is `INT` (integer), `STRING` (string), or `FLOAT`
(floating point).
-#### Examples ####
+## Examples ## {#Examples}
In the following example, the
variable *`proxy.config.proxy_name`* is a `STRING` datatype
@@ -1246,13 +56,13 @@ timeout to 10 seconds.
CONFIG proxy.config.cluster.startup_timeout INT 10
-#### Configuration Variables ####
+## Configuration Variables ## {#ConfigurationVariables}
The following list describes the configuration variables available in
the `records.config` file.
-### System Variables ### {#records.config-system-variables}
+### System Variables ### {#SystemVariables}
*`proxy.config.product_company`*
: `STRING`
@@ -1385,7 +195,7 @@ the `records.config` file.
default is set at 1 MB.
-**Local Manager**
+### Local Manager ### {#LocalManager}
*`proxy.config.lm.sem_id `*
: `INT`
@@ -1463,7 +273,7 @@ the `records.config` file.
Set the `user_id=#-1` and start trafficserver as root.
-**Process Manager**
+### Process Manager ### {#ProcessManager}
*`proxy.config.process_manager.mgmt_port`*
: `INT`
@@ -1472,7 +282,7 @@ the `records.config` file.
`traffic_manager` and `traffic_server` processes.
-**Alarm Configuration**
+### Alarm Configuration ### {#ProcessManager}
*`proxy.config.alarm.bin`*
: `STRING`
@@ -1489,7 +299,7 @@ the `records.config` file.
about Traffic Server problems.
-**Authentication Basic Realm**
+### Authentication Basic Realm ### {#AuthenticationBasicRealm}
*`proxy.config.proxy.authenticate.basic.realm`*
: `STRING`
@@ -1498,7 +308,7 @@ the `records.config` file.
specified, then`traffic_edge` is used.
-**HTTP Engine**
+### HTTP Engine ### {#HTTPEngine}
*`proxy.config.http.server_port`*
: `INT`
@@ -1645,7 +455,7 @@ the `records.config` file.
This solution must be considered interim. In the longer term, it should be possible to arrange for much finer grained control of DNS lookup so that wildcard domain can be set to use Traffic Server or client resolution. In both known use cases, marking specific domains as client determined (rather than a single global switch) would suffice. It is possible to do this crudely with this flag by enabling it and then use identity URL mappings to re-disable it for specific domains.
-**Parent Proxy Configuration**
+### Parent Proxy Configuration ### {#ParentProxyConfiguration)
*`proxy.config.http.parent_proxy_routing_enable`*
: `INT`
@@ -1696,7 +506,7 @@ the `records.config` file.
-**HTTP Connection Timeouts (secs)**
+### HTTP Connection Timeouts ### {#HTTPConnectionTimeouts}
*`proxy.config.http.keep_alive_no_activity_timeout_in`*
: `INT`
@@ -1764,7 +574,7 @@ the `records.config` file.
**background fill**).
-**Origin Server Connect Attempts**
+### Origin Server Connect Attempts ### {#OriginServerConnectAttempts}
*`proxy.config.http.connect_attempts_max_retries`*
: `INT`
@@ -1838,7 +648,7 @@ the `records.config` file.
server was too slow in sending the response header.
-**Congestion Control**
+### Congestion Control ### {#CongestionControl}
*`proxy.config.http.congestion_control.enabled`*
: `INT`
@@ -1852,7 +662,7 @@ the `records.config` file.
[Using Congestion Control](http#UsingCongestionControl).
-**Negative Response Caching**
+### Negative Response Caching ### {#NegativeResponseCaching)
*`proxy.config.http.negative_caching_enabled`*
: `INT`
@@ -1878,10 +688,10 @@ the `records.config` file.
501 Not Implemented
502 Bad Gateway
503 Service Unavailable
- 504 Gateway Timeout`
+ 504 Gateway Timeout
-**Proxy User Variables**
+### Proxy User Variables ### {#ProxyUserVariables}
*`proxy.config.http.anonymize_remove_from`*
: `INT`
@@ -1951,7 +761,7 @@ the `records.config` file.
recommended if your origin servers use no encodings other than `gzip`.
-**Security**
+### Security ### {#Security}
*`proxy.config.http.push_method_enabled `*
: `INT`
@@ -1966,7 +776,7 @@ the `records.config` file.
certain machines to push content into the cache.
-**Cache Control**
+### Cache Control ### {#CacheControl}
*`proxy.config.cache.enable_read_while_writer`*
: `INT`
@@ -2164,7 +974,7 @@ the `records.config` file.
`Cache-Control: max-age` headers from the client.
-**Heuristic Expiration**
+### Heuristic Expiration ### {#HeuristicExpiration}
*`proxy.config.http.cache.heuristic_min_lifetime`*
: `INT`
@@ -2195,7 +1005,7 @@ the `records.config` file.
: The probability that a refresh is made on a document during the
specified fuzz time.
-**Dynamic Content & Content Negotiation**
+### Dynamic Content & Content Negotiation ### {#DynamicContentAndContentNegotiation}
*`proxy.config.http.cache.vary_default_text`*
: `STRING`
@@ -2218,7 +1028,7 @@ the `records.config` file.
text and images.
-**Customizable User Response Pages**
+### Customizable User Response Pages ### {#CustomizableUserResponsePages}
*`proxy.config.body_factory.enable_customizations`*
: `INT`
@@ -2254,7 +1064,7 @@ the `records.config` file.
`2` = suppress response pages only for intercepted traffic
-**DNS**
+### DNS ### {#DNS}
*`proxy.config.dns.search_default_domains`*
: `INT`
@@ -2316,7 +1126,7 @@ the `records.config` file.
: Indicates whether to utilize SRV records for orgin server lookup.
-**HostDB**
+### HostDB ### {#HostDB}
*`proxy.config.hostdb.serve_stale_for`*
: `INT`
@@ -2364,7 +1174,7 @@ the `records.config` file.
available.
-**Logging Config**
+### Logging Config ### {#LoggingConfig}
*`proxy.config.log.logging_enabled`*
: `INT`
@@ -2678,7 +1488,7 @@ the `records.config` file.
Specify `1` to enable or `0` to disable.
-**Reverse Proxy**
+### Reverse Proxy ### {#ReverseProxy}
*`proxy.config.reverse_proxy.enabled`*
: `INT`
@@ -2692,7 +1502,7 @@ the `records.config` file.
proxy).
-**URL Remap Rules**
+### URL Remap Rules ### {#URLRemapRules}
*`proxy.config.url_remap.default_to_server_pac`*
: `INT`
@@ -2740,7 +1550,7 @@ the `records.config` file.
header in a request during remapping.
-**SSL Termination**
+### SSL Termination ### {#SSLTermination}
*`proxy.config.ssl.accelerator_required`*
: `INT`
@@ -2913,7 +1723,7 @@ the `records.config` file.
which the origin server will be verified.
-**ICP Configuration**
+### ICP Configuration ### {#ICPConfiguration}
*`proxy.config.icp.enabled`*
: `INT`
@@ -2947,7 +1757,7 @@ the `records.config` file.
: Specifies the timeout used for ICP queries.
-**Scheduled Update Configuration**
+### Scheduled Update Configuration ### {#ScheduledUpdatesConfiguration}
*`proxy.config.update.enabled`*
`INT`
@@ -2982,7 +1792,7 @@ the `records.config` file.
overburdening the host.
-**Remap Plugin Processor**
+### Remap Plugin Processor ### {#RemapPluginProcessor}
*`proxy.config.remap.use_remap_processor`*
: `INT`
@@ -2997,7 +1807,7 @@ the `records.config` file.
processing.
-**Plug-in Configuration**
+### Plug-in Configuration ### {#PluginConfiguration}
*`proxy.config.plugin.plugin_dir`*
: `STRING`
@@ -3005,7 +1815,7 @@ the `records.config` file.
: Specifies the location of Traffic Server plugins.
-**Sockets**
+### Sockets ### {#Sockets}
*`proxy.config.net.sock_send_buffer_size_in`*
: `INT`
@@ -3061,577 +1871,3 @@ the `records.config` file.
: `0`
: Same as the command line option `--accept_mss` that sets the MSS
for all incoming requests.
-
-
-
-## remap.config ## {#remap.config}
-
-The `remap.config` file contains mapping rules that Traffic Server
-uses to perform the following actions:
-
-- Map URL requests for a specific origin server to the
- appropriate location on Traffic Server when Traffic Server acts as
- a reverse proxy for that particular origin server
-- Reverse-map server location headers so that when origin servers
- respond to a request with a location header that redirects the
- client to another location, the clients do not bypass Traffic
- Server
-- Redirect HTTP requests permanently or temporarily without
- Traffic Server having to contact any origin servers
-
-Refer to [Reverse Proxy and HTTP Redirects](reverse), for
-information about redirecting HTTP requests and using reverse
-proxy.
-
-**IMPORTANT:** After you modify the `remap.config` file, navigate to
-the Traffic Server`bin` directory; then run the `traffic_line -x`
-command to apply the changes. When you apply the changes to one
-node in a cluster, Traffic Server automatically applies the changes
-to all other nodes in the cluster.
-
-
-#### Format ####
-
-Each line in the `remap.config` file must contain a mapping rule.
-Traffic Server recognizes three space-delimited fields: `type`,
-`target`, and `replacement`. The following list describes the
-format of each field.
-
-`type`
-: Enter one of the following:
-
- `map` --translates an incoming request URL to the appropriate
- origin server URL.
-
- `reverse_map` --translates the URL in origin server redirect
- responses to point to the Traffic Server.
-
- `redirect` --redirects HTTP requests permanently without having to
- contact the origin server. Permanent redirects notify the browser
- of the URL change (by returning an HTTP status code 301) so that
- the browser can update bookmarks.
-
- `redirect_temporary` --redirects HTTP requests temporarily without
- having to contact the origin server. Temporary redirects notify the
- browser of the URL change for the current request only (by
- returning an HTTP status code 307).
-
- **Note:** use the `regex_` prefix to indicate that the line has a
- regular expression (regex).
-
-`target`
-: Enter the origin ("from") URL. You can enter up to four
- components:
-
- scheme://host:port/path_prefix
-
-where *`scheme`* is `http`.
-
-`replacement`
-: Enter the destination ("to") URL. You can enter up to four
- components:
-
- scheme://host:port/path_prefix
-
- where *`scheme`* can be `http` or `https`.
-
-
-#### Examples ####
-
-The following section shows example mapping rules in the
-`remap.config` file.
-
-##### Reverse Proxy Mapping Rules #####
-
-The following example shows a map rule that does not specify a path
-prefix in the target or replacement:
-
- map http://www.x.com/ http://server.hoster.com/
-
-This rule results in the following translations:
-
-| Client Request | Translated Request |
-| `http://www.x.com/Widgets/index.html` | `http://server.hoster.com/Widgets/index.html` |
-| `http://www.x.com/cgi/form/submit.sh?arg=true` | `http://server.hoster.com/cgi/form/submit.sh?arg=true` |
-
-The following example shows a map rule with path prefixes specified
-in the target:
-
- map http://www.intranet.y.com/marketing http://marketing.y.com/
- map http://intranet.y.com/sales http://sales.y.com/
- map http://intranet.y.com/engineering http://engineering.y.com/
- map http://intranet.y.com/ http://info.y.com/`
-
-These rules result in the following translations:
-
-| Client Request | Translated Request |
-| `http://www.y.com/marketing/projects/manhattan/specs.html` | `http://marketing.y.com/projects/manhattan/specs.html` |
-| `http://www.y.com/stuff/marketing/projects/boston/specs.html` | `http://info.y.com/marketing/projects/boston/specs.html` |
-| `http://www.y.com/engineering/marketing/requirements.html` | `http://engineering.y.com/marketing/requirements.html` |
-
-The following example shows that the order of the rules matters:
-
- map http://www.g.com/ http://external.g.com/
- map http://www.g.com/stuff http://stuff.g.com`
-
-These rules result in the following translation.
-
-| Client Request | Translated Request |
-| `http://www.g.com/stuff/a.gif` | `http://external.g.com/stuff/a.gif` |
-
-In the above examples, the second rule is never applied because all
-URLs that match the second rule also match the first rule. The
-first rule takes precedence because it appears earlier in the
-`remap.config` file.
-
-The following example shows a mapping with a path prefix specified
-in the target and replacement:
-
- map http://www.h.com/a/b http://server.h.com/customers/x/y
-
-This rule results in the following translation.
-
-| Client Request | Translated Request |
-| `http://www.h.com/a/b/c/d/doc.html` | `http://server.h.com/customers/x/y/c/d/doc.html` |
-| `http://www.h.com/a/index.html` | `Translation fails` |
-
-The following example shows reverse-map rules:
-
- map http://www.x.com/ http://server.hoster.com/x/
- reverse_map http://server.hoster.com/x/ http://www.x.com/
-
-These rules result in the following translations.
-
-| Client Request | Translated Request |
-| `http://www.x.com/Widgets` | `http://server.hoster.com/x/Widgets` |
-
-Â
-
-| Client Request | Origin server Header | Translated Header |
-| `http://www.x.com/Widgets` | `http://server.hoster.com/x/Widgets/` | `http://www.x.com/Widgets/` |
-
-When acting as a reverse proxy for multiple servers, Traffic Server
-is unable to route to URLs from older browsers that do not send the
-`Host:` header. As a solution, set the variable
-*`proxy.config.header.parse.no_host_url_redirect`* in the
-`records.config` file to the URL to which Traffic Server will
-redirect requests without host headers.
-
-##### Redirect Mapping Rules #####
-
-The following rule permanently redirects all HTTP requests for
-`www.company.com` to `www.company2.com`:
-
- redirect http://www.company.com http://www.company2.com
-
-The following rule *temporarily* redirects all HTTP requests for
-`www.company1.com` to `www.company2.com`:
-
- redirect_temporary http://www.company1.com http://www.company2.com
-
-##### Regular Expression (regex) Remap Support #####
-
-Regular expressions can be specified in remapping rules, with the
-limitations below:
-
-- Only the `host` field can contain a regex; the `scheme`,
- `port`, and other fields cannot. For path manipulation via regexes,
- use the `regex_remap` plugin.
-- The number of capturing subpatterns is limited to 9. This means
- that `$0` thru `$9` can be used as subtraction placeholders (`$0`
- will be the entire input string).
-- The number of substitutions in the expansion string is limited
- to 10.
-
-#### Examples ####
-
- regex_map http://x ([0-9]+).z.com http://real-x$1.z.com
- regex_redirect http://old.(.*).z.com http://new.$1.z.com
-
-#### Plugin Chaining
-
-Plugins can be configured to be evaluated in a specific order,
-passing the results from one in to the next (unless a plugin
-returns 0, then the "chain" is broken).
-
-#### Examples
-
- map http://url/path http://url/path @plugin=/etc/traffic_server/config/plugins/plugin1.so @pparam=1 @pparam=2 @plugin=/etc/traffic_server/config/plugins/plugin2.so @pparam=3
-
-will pass "1" and "2" to plugin1.so and "3" to plugin2.so.
-
-This will pass "1" and "2" to plugin1.so and "3" to plugin2.so
-
-
-## splitdns.config ## {#splitdns.config}
-
-The `splitdns.config` file enables you to specify the DNS server
-that Traffic Server should use for resolving hosts under specific
-conditions. For more information, refer to
-[Configuring DNS Server Selection (Split DNS)](secure).
-
-To specify a DNS server, you must supply the following information
-in each active line within the file:
-
-- A primary destination specifier in the form of a destination
- domain, a destination host, or a URL regular expression
-- A set of server directives, listing one or more DNS servers
- with corresponding port numbers
-
-You can also include the following optional information with each
-DNS server specification:
-
-- A default domain for resolving hosts
-- A search list specifying the domain search order when multiple
- domains are specified
-
-**IMPORTANT:** After you modify the `splitdns.config` file, navigate
-to the Traffic Server`bin` directory and run the `traffic_line -x`
-command to apply the changes. When you apply changes to a node in a
-cluster, Traffic Server automatically applies the changes to all
-other nodes in the cluster.
-
-### Format ###
-
-Each line in the `splitdns.config` file uses one of the following
-formats:
-
- dest_domain=dest_domain | dest_host | url_regex named=dns_server def_domain=def_domain search_list=search_list
-
-The following list describes each field.
-
-*`dest_domain`*
-: A valid domain name. This specifies that DNS server selection will
- be based on the destination domain. You can prefix the domain with
- an exclamation mark (`!`) to indicate the NOT logical operator.
-
-*`dest_host`*
-: A valid hostname. This specifies that DNS server selection will be
- based on the destination host. You can prefix the host with an
- exclamation mark (`!`) to indicate the `NOT` logical operator.
-
-*`url_regex`*
-: A valid URL regular expression. This specifies that DNS server
- selection will be based on a regular expression.
-
-*`dns_server`*
-: This is a required directive. It identifies the DNS server that
- Traffic Server should use with the given destination specifier. You
- can specify a port using a colon (`:`). If you do not specify a
- port, then 53 is used. Specify multiple DNS servers with spaces or
- semicolons (`;`) as separators.
-
- You must specify the domains with IP addresses in CIDR ("dot")
- notation.
-
-*`def_domain`*
-: A valid domain name. This optional directive specifies the default
- domain name to use for resolving hosts. Only one entry is allowed.
- If you do not provide the default domain, the system determines its
- value from `/etc/resolv.conf`
-
-*`search_list`*
-: A list of domains separated by spaces or semicolons (;). This
- specifies the domain search order. If you do not provide the search
- list, the system determines the value from `/etc/resolv.conf`
-
-### Examples
-
-Consider the following DNS server selection specifications:
-
-> dest_domain=internal.company.com named=255.255.255.255:212 255.255.255.254 def_domain=company.com search_list=company.com company1.com
->
-> dest_domain=!internal.company.com named=255.255.255.253
-
-Now consider the following two requests:
-
- http://minstar.internal.company.com
-
-This request matches the first line and therefore selects DNS
-server `255.255.255.255` on port `212`. All resolver requests
-use `company.com` as the default domain, and `company.com`
-and `company1.com` as the set of domains to search first.
-
- http://www.microsoft.com
-
-This request matches the second line. Therefore, Traffic Server
-selects DNS server `255.255.255.253`. Because no `def_domain` or
-`search_list` was supplied, Traffic Server retrieves this
-information from `/etc/resolv.conf`
-
-
-## ssl\_multicert.config ## {#ssl\_multicert.config}
-
-The `ssl_multicert.config` file lets you configure Traffic Server
-to use multiple SSL server certificates with the SSL termination
-option. If you have a Traffic Server system with more than one IP
-address assigned to it, then you can assign a different SSL
-certificate to be served when a client requests a particular IP
-address.
-
-### Format ###
-
-The format of the `ssl_multicert.config` file is:
-
- dest_ip=ipaddress ssl_cert_name=cert_name ssl_key_name=key_name
-
-where *`ipaddress`* is an IP address assigned to Traffic
-Server , *`cert_name`* is the filename of the Traffic Server
-SSL server certificate, and *`key_name`* is the filename of
-the Traffic Server SSL private key. If the private key is located
-in the certificate file, then you do not need to specify the name
-of the private key.
-
-### Examples
-
-The following example configures Traffic Server to use the SSL
-certificate `server.pem` for all requests to the IP address
-111.11.11.1 and the SSL certificate `server1.pem` for all requests
-to the IP address 11.1.1.1. Since the private key *is* included in
-the certificate files, no private key name is specified.
-
- dest_ip=111.11.11.1 ssl_cert_name=server.pem
- dest_ip=11.1.1.1 ssl_cert_name=server1.pem
-
-The following example configures Traffic Server to use the SSL
-certificate `server.pem` and the private key `serverKey.pem` for
-all requests to the IP address 111.11.11.1. Traffic Server uses the
-SSL certificate `server1.pem` and the private key `serverKey1.pem`
-for all requests to the IP address 11.1.1.1.
-
- dest_ip=111.11.11.1 ssl_cert_name=server.pem ssl_key_name=serverKey.pem
- dest_ip=11.1.1.1 ssl_cert_name=server1.pem ssl_key_name=serverKey1.pem
-
-## storage.config ## {#storage.config}
-
-The `storage.config` file lists all the files, directories, and/or
-hard disk partitions that make up the Traffic Server cache. After
-you modify the `storage.config` file, you must restart Traffic
-Server.
-
-### Format
-
-The format of the `storage.config` file is:
-
-*`pathname size`*
-
-where *`pathname`* is the name of a partition, directory or
-file, and *`size`* is the size of the named partition,
-directory or file (in bytes). You must specify a size for
-directories or files; size is optional for raw partitions.
-
-You can use any partition of any size. For best performance:
-
-- Use raw disk partitions.
-- For each disk, make all partitions the same size.
-- For each node, use the same number of partitions on all disks.
-
-Specify pathnames according to your operating system requirements.
-See the following examples. In the `storage.config` file, a
-formatted or raw disk must be at least 128 MB.
-
-### Examples
-
-The following basic example shows 64 MB of cache storage in the
-`/big_dir` directory:
-
- /big_dir 67108864
-
-You can use the `.` symbol for the current directory. Here is an
-example for 64 MB of cache storage in the current directory:
-
- . 67108864
-
-#### Solaris Example ####
-
-The following example is for the Solaris operating system:
-
- /dev/rdsk/c0t0d0s5
- /dev/rdsk/c0t0d1s5
-
-**Note:** Size is optional. If not specified, the entire
-partition is used.
-
-#### Linux Example
-
-The following example will use an entire raw disk in the Linux operating system:
-
- /dev/sdb
-
-
-
-## update.config ## {#update.config}
-
-The `update.config` file controls how Traffic Server performs a
-scheduled update of specific local cache content. The file contains
-a list of URLs specifying objects that you want to schedule for
-update.
-
-A scheduled update performs a local HTTP `GET` on the objects at
-the specific time or interval. You can control the following
-parameters for each specified object:
-
-- The URL
-- URL-specific request headers, which overrides the default
-- The update time and interval
-- The recursion depth
-
-**IMPORTANT:** After you modify the `update.config` file, navigate
-to the Traffic Server`bin` directory and run the `traffic_line -x`
-command to apply changes. When you apply changes to one node in a
-cluster, Traffic Server automatically applies the changes to all
-other nodes in the cluster.
-
-### Supported Tag/Attribute Pairs ###
-
-Scheduled update supports the following tag/attribute pairs when
-performing recursive URL updates:
-
-- `<a href=" ">`
-- `<img src=" ">`
-- `<img href=" ">`
-- `<body background=" ">`
-- `<frame src=" ">`
-- `<iframe src=" ">`
-- `<fig src=" ">`
-- `<overlay src=" ">`
-- `<applet code=" ">`
-- `<script src=" ">`
-- `<embed src=" ">`
-- `<bgsound src=" ">`
-- `<area href=" ">`
-- `<base href=" ">`
-- `<meta content=" ">`
-
-Scheduled update is designed to operate on URL sets consisting of
-hundreds of input URLs (expanded to thousands when recursive URLs
-are included); it is *not* intended to operate on extremely large
-URL sets, such as those used by Internet crawlers.
-
-### Format ###
-
-Each line in the `update.config` file uses the following format:
-
- URL\request_headers\offset_hour\interval\recursion_depth\
-
-The following list describes each field.
-
-*`URL`*
-: HTTP-based URLs.
-
-*`request_headers`*
-: Optional. A list of headers, separated by semicolons, passed in
- each `GET` request. You can define any request header that conforms
- to the HTTP specification; the default is no request header.
-
-*`offset_hour`*
-: The base hour used to derive the update periods. The range is 00-23
- hours.
-
-*`interval`*
-: The interval (in seconds) at which updates should occur, starting
- at the offset hour.
-
-*`recursion_depth`*
-: The depth to which referenced URLs are recursively updated,
- starting at the given URL. This field applies only to HTTP.
-
-
-#### Examples ####
-
-An example HTTP scheduled update is provided below:
-
- http://www.company.com\User-Agent: noname user agent\13\3600\5\
-
-The example specifies the URL and request headers, an offset hour
-of 13 (1 pm), an interval of one hour, and a recursion depth of 5.
-This would result in updates at 13:00, 14:00, 15:00, and so on. To
-schedule an update that occurs only once a day, use an interval
-value 86400 (i.e., 24 hours x 60 minutes x 60 seconds = 86400).
-
-
-## Specifying URL Regular Expressions (`url_regex`) ## {#url\_regex}
-
-This section describes how to specify a `url_regex`. Entries of
-type `url_regex` within the configuration files use regular
-expressions to perform a match.
-
-The following list provides examples to show how to create a valid
-`url_regex`.
-
-`x`
-: Matches the character`x`
-
-`.`
-: Match any character
-
-`^`
-: Specifies beginning of line
-
-`$`
-: Specifies end of line
-
-`[xyz]`
-: A **character class**. In this case, the pattern matches either
- `x`,`y`, or`z`
-
-`[abj-oZ]`
-: A **character class** with a range. This pattern matches `a`,`b`,
- any letter from`j`thru`o`, or`Z`
-
-`[^A-Z]`
-: A **negated character class**. For example, this pattern matches
- any character except those in the class.
-
-`r*`
-: Zero or more`r`, where`r`is any regular expression.
-
-`r+`
-: One or more`r`, where `r` is any regular expression.
-
-`r?`
-: Zero or one`r`, where`r`is any regular expression.
-
-`r{2,5}`
-: From two to five `r`, where`r`is any regular expression.
-
-`r{2,}`
-: Two or more `r`, where`r`is any regular expression.
-
-`r{4}`
-: Exactly four`r`, where`r`is any regular expression.
-
-`"[xyz]\"images"`
-: The literal string`[xyz]"images"`
-
-`\X`
-: If`X`is`a, b, f, n, r, t,`or`v,`then the `ANSI-C`interpretation of
- `\x`; otherwise, a literal`X`. This is used to escape operators
- such as`*`
-
-`\0`
-: A`NULL`character
-
-`\123`
-: The character with octal value`123`
-
-`\x2a`
-: The character with hexadecimal value`2a`
-
-`(r)`
-: Matches an`r`, where`r`is any regular expression. You can use
- parentheses to override precedence.
-
-`rs`
-: The regular expression`r`, followed by the regular expression`s`
-
-`r|s`
-: Either an `r`or an`s`
-
-`#<n>#`
-: Inserts an **end node**, which causes regular expression matching to
- stop when reached. The value`n`is returned.
-
-You can specify`dest_domain=mydomain.com`to match any host
-in`mydomain.com`. Likewise, you can specify `dest_domain=.`to match
-any request.