Skip to content

Commit

Permalink
docs: Clarify UPSTREAM_REMOTE_ADDRESS and UPSTREAM_HOST access log va…
Browse files Browse the repository at this point in the history
…riables are the same (#29800)

docs: Clarify UPSTREAM_REMOTE_ADDRESS and UPSTREAM_HOST are the same

These access log variables use identical code so they should always be
equivalent.

Signed-off-by: Nick Muerdter <12112+GUI@users.noreply.github.com>
  • Loading branch information
GUI authored Sep 26, 2023
1 parent d5d2fae commit f1369ae
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/root/configuration/observability/access_log/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -511,8 +511,11 @@ UDP
TCP/UDP
Not implemented ("-")

.. _config_access_log_format_upstream_host:

%UPSTREAM_HOST%
Upstream host URL (e.g., tcp://ip:port for TCP connections).
Upstream host URL (e.g., tcp://ip:port for TCP connections). Identical to the :ref:`UPSTREAM_REMOTE_ADDRESS
<config_access_log_format_upstream_remote_address>` value.

%UPSTREAM_CLUSTER%
Upstream cluster to which the upstream host belongs to. :ref:`alt_stat_name
Expand All @@ -530,9 +533,11 @@ UDP
Local port of the upstream connection.
IP addresses are the only address type with a port component.

.. _config_access_log_format_upstream_remote_address:

%UPSTREAM_REMOTE_ADDRESS%
Remote address of the upstream connection. If the address is an IP address it includes both
address and port.
address and port. Identical to the :ref:`UPSTREAM_HOST <config_access_log_format_upstream_host>` value.

%UPSTREAM_REMOTE_ADDRESS_WITHOUT_PORT%
Remote address of the upstream connection, without any port component.
Expand Down

0 comments on commit f1369ae

Please sign in to comment.