Option --profiling-enabled #1417
Conversation
olegbespalov
added
the
Area: OSS Content
olegbespalov
requested review from
oleiade and
joanlopez
and removed request for
a team
| @@ -904,6 +905,22 @@ export const options = { | |||
|
|
|||
| {{< /code >}} | |||
|
|
|||
| ## Profiling Enabled | |||
|
|
|||
| Enables [pprof](https://pkg.go.dev/net/http/pprof) profiling endpoints under the k6's REST API [address](#address). These endpoints help debug and profile k6 itself. k6's REST API should be enabled as well. | |||
There was a problem hiding this comment.
@olegbespalov I think this looks good, I just have one question here, what does "k6's REST API should be enabled as well" mean? Is that something the user needs to do as well for profiling to work?
There was a problem hiding this comment.
I guess it refers to this: https://k6.io/docs/misc/k6-rest-api/
However, the docs say: By default, that server listens on localhost:6565..., so I guess that comes by default, and just enabling profiling would be enough? 🤔
There was a problem hiding this comment.
The point is that enabled REST API is required for the profiling endpoints. It's enabled by default but could be manually turned off; in that case, profiling endpoints won't be exposed. So, this sentence tries to document that case.
There was a problem hiding this comment.
All good and clear to me :)
There was a problem hiding this comment.
Gotcha, that makes sense. How would one manually turn that off? 🤔
There was a problem hiding this comment.
Pass an empty string like k6 run --address "" script.js
What?
It documents a new
--profiling-enabledoption from the https://github.com/grafana/k6/pull/3370/files.Why?
This is a new option and it should be documented.