Improve the docs of pyroscope.scrape #5847
Co-authored-by: Ryan Perry <Rperry2174@gmail.com>
- Loading branch information
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,7 +17,7 @@ title: pyroscope.scrape | |
|
|
||
| `pyroscope.scrape` collects [pprof] performance profiles for a given set of HTTP `targets`. | ||
|
|
||
|
There was a problem hiding this comment. I usually share this picture to show visually what the grafana agent does... may be worth adding in here. we could update this image to have more detail (i.e. showing multiple endpoints for scraping)
There was a problem hiding this comment. Since the picture shows the interactions between different components, I'd prefer not to place it in the reference docs for I think having such an architecture picture would be great for most task-based docs, and it would be even better if they are all consistent. |
||
| `pyroscope.scrape` mimcks the scraping behavior of `prometheus.scrape`. | ||
| Similarly to how Prometheus scrapes metrics via HTTP, `pyroscope.scrape` collects profiles via HTTP requests. | ||
|
|
||
| Unlike Prometheus, which usually only scrapes one `/metrics` endpoint per target, | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@clayton-cornell - The changes in the PR make this page more in line with our Writing documentation for Flow components guide, but I have taken a few liberties which are noted in comments.
@knylander-grafana - there is a Go (pull mode) page on the Pyroscope website which contains lots of duplicate information. Should we remove the duplications?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We created that page in response to feedback that this page was too verbose and hard to get started quickly. We will definitely keep the other page for now and I'll just manage the duplicate work of making sure changes made here make it over there
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could look into converting Go (pull mode) and eBPF into new task-based docs under Agent's Getting Started section called "Profiling Go Applications" and "Profiling with eBPF".