Docs feedback: /docs/sources/static/api/_index.md

[ethirolle]

This page is missing any information on the /debug/pprof/... API endpoints.

In doc page https://grafana.com/docs/agent/latest/static/configuration/flags/#server, it is mentioned:

-server.register-instrumentation: Expose the /metrics and /debug/pprof/ instrumentation handlers over HTTP (default true)

And I can verify that at least /debug/pprof/heap and /debug/pprof/goroutine endpoints work... but I think there are other profile types available, as referenced in our doc section about Support Bundles:

The pprof/ directory contains Go runtime profiling data (CPU, heap, goroutine, mutex, block profiles) as exported by the pprof package.

Can we please add these API endpoints to this page? Thanks!

[rfratto]

👋 I'm genuinely not sure if we'd consider the /debug/pprof endpoints as part of the "API;" they're not necessarily guaranteed to be stable since it comes directly from the Go project.

I'd personally like to consider these as something different than API endpoints (debugging endpoints, maybe?) where we don't provide any backwards compatibility guarantees, since we don't control the endpoints or their function.

cc @clayton-cornell for thoughts

[clayton-cornell]

Mistakenly linked a PR to this issue.

[clayton-cornell]

@rfratto What's the usecase for poking at these endpoints? Is it just for debugging? Could we list what's included and link out to the Go API for definitions/details?

[github-actions]

This issue has not had any activity in the past 30 days, so the needs-attention label has been added to it.
If the opened issue is a bug, check to see if a newer release fixed your issue. If it is no longer relevant, please feel free to close this issue.
The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your issue will be kept open and you do not have to respond to this comment. The label will be removed the next time this job runs if there is new activity.
Thank you for your contributions!