From 094cc58d6ef2429751fb0bb92cd15824a2e0aab6 Mon Sep 17 00:00:00 2001 From: codebien <2103732+codebien@users.noreply.github.com> Date: Fri, 8 Aug 2025 16:19:45 +0200 Subject: [PATCH] Added docs for /metrics endpoint --- docs/sources/k6/next/using-k6/k6-options/reference.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/sources/k6/next/using-k6/k6-options/reference.md b/docs/sources/k6/next/using-k6/k6-options/reference.md index 7f9e8d46b4..d48d32aae0 100644 --- a/docs/sources/k6/next/using-k6/k6-options/reference.md +++ b/docs/sources/k6/next/using-k6/k6-options/reference.md @@ -912,7 +912,12 @@ export const options = { ## 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. +Enables profiling endpoints under the [k6 REST API [address](#address) to help debug and profile k6 itself: + +* [pprof](https://pkg.go.dev/net/http/pprof) profiling endpoints for CPU and memory profiling +* Prometheus [/metrics](https://prometheus.io/docs/guides/go-application/#how-go-exposition-works) endpoint for exporting Go runtime metrics + +The k6 REST API must be enabled for these endpoints to be available (this is the default behavior). | Env | CLI | Code / Config file | Default | | ---------------------- | --------------------- | ------------------ | ------------------------------------ |