-
Notifications
You must be signed in to change notification settings - Fork 5.8k
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.
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
config: correct the explanation of status-host #13315
Conversation
Codecov Report
@@ Coverage Diff @@
## master #13315 +/- ##
===========================================
Coverage 80.1531% 80.1531%
===========================================
Files 469 469
Lines 112068 112068
===========================================
Hits 89826 89826
Misses 15294 15294
Partials 6948 6948 |
@@ -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: |
There was a problem hiding this comment.
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.
@@ -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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## 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: |
## status-host is 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. |
There was a problem hiding this comment.
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.
@ericsyh, please update your pull request. |
1 similar comment
@ericsyh, please update your pull request. |
@ericsyh PR closed due to no update for a long time. Feel free to reopen it anytime. |
What problem does this PR solve?
Revise the PR #13024 which add API example for prometheus and pprof.
What is changed and how it works?
Put the API example to the correct position.
Check List
Tests
Side effects
Related changes