Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

config: correct the explanation of status-host #13315

Closed
wants to merge 2 commits into from
Closed

config: correct the explanation of status-host #13315

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
606d5c7
revise the status-config pr
ericsyh Nov 9, 2019
c4a7800
Merge branch 'master' into ericsyh/status-config
sykp241095 Nov 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions config/config.toml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,12 +135,12 @@ cluster-ssl-key = ""
# If enable status report HTTP service.
report-status = true

# TiDB status host.
status-host = "0.0.0.0"

## status-host is the HTTP address for reporting the internal status of a TiDB server, for example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is not only for the status-host but also for status-port.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## status-host is the HTTP address for reporting the internal status of a TiDB server, for example:
## status-host and status-port together specify the HTTP address for reporting the internal status of a TiDB server, for example:

## API for prometheus: http://${status-host}:${status_port}/metrics
## API for pprof: http://${status-host}:${status_port}/debug/pprof
# TiDB status host.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually TiDB status host only have one more information than status-host, which is tidb... I think we can remove this useless comment. So as the tidb status port comment.

We should explain more about the status-host and status-port in the above comment block.

status-host = "0.0.0.0"

# TiDB status port.
status-port = 10080

Expand Down