Skip to content
This repository was archived by the owner on Apr 30, 2025. It is now read-only.

Commit 05f2266

Browse files
maxmoehlameowlia
authored andcommitted
doc: update access log fields
1 parent aeeefc3 commit 05f2266

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -743,10 +743,14 @@ request:
743743
`<Request Host> - [<Start Date>] "<Request Method> <Request URL>
744744
<Request Protocol>" <Status Code> <Bytes Received> <Bytes Sent>
745745
"<Referer>" "<User-Agent>" <Remote Address> <Backend Address>
746-
x_forwarded_for:"<X-Forwarded-For>"
747-
x_forwarded_proto:"<X-Forwarded-Proto>"
748-
vcap_request_id:<X-Vcap-Request-ID> response_time:<Response Time> gorouter_time:<Gorouter Time>
749-
app_id:<Application ID> app_index:<Application Index> x_cf_routererror:<X-Cf-RouterError> <Extra Headers>`
746+
x_forwarded_for:"<X-Forwarded-For>" x_forwarded_proto:"<X-Forwarded-Proto>"
747+
vcap_request_id:<X-Vcap-Request-ID> response_time:<Response Time>
748+
gorouter_time:<Gorouter Time> app_id:<Application ID>
749+
app_index:<Application Index> instance_id:"<Instance ID>"
750+
failed_attempts:<Failed Attempts> failed_attempts_time:<Failed Attempts Time>
751+
dns_time:<DNS Time> dial_time:<Dial Time> tls_time:<TLS Time>
752+
backend_time:<Backend Time> x_cf_routererror:<X-Cf-RouterError>
753+
<Extra Headers>`
750754
751755
* Status Code, Response Time, Gorouter Time, Application ID, Application Index,
752756
X-Cf-RouterError, and Extra Headers are all optional fields. The absence of
@@ -765,6 +769,14 @@ app_id:<Application ID> app_index:<Application Index> x_cf_routererror:<X-Cf-Rou
765769
traversing the network to the app. This also does not include the time the app
766770
spends forming a response.
767771
772+
* `failed_attempts`, `failed_attempts_time`, `dns_time`, `dial_time`,
773+
`tls_time` and `backend_time` are only logged if
774+
`logging.enable_attempts_details` is set to true. The `*_time` will only be
775+
provided for the last, successful attempt, if the request fails they will be
776+
empty and the error log can be consulted to get the details about each
777+
attempt. `failed_attempts_time` contains the total time spent performing
778+
attempts that failed.
779+
768780
* `X-CF-RouterError` is populated if the Gorouter encounters an error. This can
769781
help distinguish if a non-2xx response code is due to an error in the Gorouter
770782
or the backend. For more information on the possible Router Error causes go to

0 commit comments

Comments
 (0)