From 44549b06d293e351cbe48eedcfe3be2ddc348a89 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Thu, 2 Jul 2020 14:57:09 +0800 Subject: [PATCH] cherry pick #2943 to release-4.0 Signed-off-by: ti-srebot --- command-line-flags-for-tikv-configuration.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/command-line-flags-for-tikv-configuration.md b/command-line-flags-for-tikv-configuration.md index cd7d857f64be0..22db2ca94b424 100644 --- a/command-line-flags-for-tikv-configuration.md +++ b/command-line-flags-for-tikv-configuration.md @@ -22,9 +22,23 @@ TiKV supports some readable unit conversions for command line parameters. - The server advertise address for client traffic from outside - Default: ${addr} -- If the client cannot connect to TiKV through the default monitoring address because of Docker or NAT network, you must manually set the advertise address explicitly. +- If the client cannot connect to TiKV through the `--addr` address because of Docker or NAT network, you must manually set the `--advertise-addr` address. - For example, the internal IP address of Docker is 172.17.0.1, while the IP address of the host is 192.168.100.113 and the port mapping is set to `-p 20160:20160`. In this case, you can set `--advertise-addr` to "192.168.100.113:20160". The client can find this service through 192.168.100.113:20160. +## `--status-addr` + ++ The port through which the TiKV service status is listened ++ Default: "20180" ++ The Prometheus can access this status information via `http://host:status_port/metrics`. ++ The Profile can access this status information via `http://host:status_port/debug/pprof/profile`. + +## `--advertise-status-addr` + +- The address through which TiKV accesses service status from outside. +- Default: The value of `--status-addr` is used. +- If the client cannot connect to TiKV through the `--status-addr` address because of Docker or NAT network, you must manually set the `--advertise-status-addr` address. +- For example, the internal IP address of Docker is `172.17.0.1`, while the IP address of the host is `192.168.100.113` and the port mapping is set to `-p 20180:20180`. In this case, set `\-\-advertise-status-addr="192.168.100.113:20180"`. The client can find this service through `192.168.100.113:20180`. + ## `-C, --config` - The config file