Skip to content

Commit 97dee09

Browse files
authored
Added docs for /metrics endpoint (#2024)
1 parent b926a85 commit 97dee09

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/sources/k6/next/using-k6/k6-options/reference.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -912,7 +912,12 @@ export const options = {
912912

913913
## Profiling Enabled
914914

915-
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.
915+
Enables profiling endpoints under the [k6 REST API [address](#address) to help debug and profile k6 itself:
916+
917+
* [pprof](https://pkg.go.dev/net/http/pprof) profiling endpoints for CPU and memory profiling
918+
* Prometheus [/metrics](https://prometheus.io/docs/guides/go-application/#how-go-exposition-works) endpoint for exporting Go runtime metrics
919+
920+
The k6 REST API must be enabled for these endpoints to be available (this is the default behavior).
916921

917922
| Env | CLI | Code / Config file | Default |
918923
| ---------------------- | --------------------- | ------------------ | ------------------------------------ |

0 commit comments

Comments
 (0)