add option to hide /debug/ pages #8596
Conversation
| @@ -219,6 +219,10 @@ | |||
| # troubleshooting and monitoring. | |||
| # pprof-enabled = true | |||
|
|
|||
| # Determines whether the debug endpoint is enabled. This endpoint is used for | |||
| # gathering runtime statistics. | |||
| # pprof-enabled = true | |||
There was a problem hiding this comment.
This should be updated to debug-enabled rather than pprof-enabled.
| @@ -256,9 +256,9 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { | |||
|
|
|||
| if strings.HasPrefix(r.URL.Path, "/debug/pprof") && h.Config.PprofEnabled { | |||
| h.handleProfiles(w, r) | |||
| } else if strings.HasPrefix(r.URL.Path, "/debug/vars") { | |||
| } else if strings.HasPrefix(r.URL.Path, "/debug/vars") && h.Config.DebugEnabled { | |||
There was a problem hiding this comment.
Should setting debug-enabled to false also disable /debug/pprof?
There was a problem hiding this comment.
I think that is what pprof-enabled does.
| @@ -24,6 +24,7 @@ type Config struct { | |||
| LogEnabled bool `toml:"log-enabled"` | |||
| WriteTracing bool `toml:"write-tracing"` | |||
| PprofEnabled bool `toml:"pprof-enabled"` | |||
| DebugEnabled bool `toml:"debug-enabled"` | |||
There was a problem hiding this comment.
The default for this should be set to true.
There was a problem hiding this comment.
This features is a little confusing as implemented. There is a /debug/... endpoint that has pprof, requests, vars, etc.. handlers.
There is also already a pprof-enabled setting that disables the /debug/pprof endpoint only.
I would expect a debug-enabled flag to disable the whole /debug handler and everything under it since all of these endpoints are for debugging.
Following the same pattern as pprof-enabled, there could be a vars-enabled, requests-enabled to disable those endpoints, but I'm not sure there is much value in doing that is it just adds a bunch of config options and you might as well disable all of /debug.
|
Closing due to inactivity. |
ghost
removed
the
closes #5305
Required for all non-trivial PRs
Required only if applicable
etc/config.sample.toml), serverNewDemoConfigmethod, andDiagnosticsmethods reporting config settings, if necessary