pyroscope.scrape: do not drop __meta labels #2710
Conversation
|
💻 Deploy preview available: https://deploy-preview-alloy-2710-zb444pucvq-vp.a.run.app/docs/alloy/latest/ |
| `pyroscope.write` receives performance profiles from other components and forwards them to a series of user-supplied endpoints using [Pyroscope' Push API](/oss/pyroscope/). When forwarding profiles, most labels starting with double underscore (`__`) are dropped before sending the data, with the following exceptions: | ||
| - `__name__` - preserved as it identifies the profile type | ||
| - `__delta__` - preserved as it's required for delta profiles |
There was a problem hiding this comment.
| `pyroscope.write` receives performance profiles from other components and forwards them to a series of user-supplied endpoints using [Pyroscope' Push API](/oss/pyroscope/). When forwarding profiles, most labels starting with double underscore (`__`) are dropped before sending the data, with the following exceptions: | |
| - `__name__` - preserved as it identifies the profile type | |
| - `__delta__` - preserved as it's required for delta profiles | |
| `pyroscope.write` receives performance profiles from other components and forwards them to a series of user-supplied endpoints using [Pyroscope' Push API](/oss/pyroscope/). | |
| When `pyroscope.write` forwards profiles, most labels starting with double underscore (`__`) are dropped before the data is sent, with the following exceptions: | |
| * `__name__` is preserved because it identifies the profile type. | |
| * `__delta__`is preserved because it's required for delta profiles. |
The link to /oss/pyroscope lands on https://grafana.com/oss/pyroscope/ Is this really where we want to direct people? Or shoudl we maybe point people at the API docs instead? Maybe here https://grafana.com/docs/pyroscope/latest/reference-server-api/ instead?
There was a problem hiding this comment.
I agree we should put a better link to push API, however I'm afraid we don't have the doc for the push API or at least I'm not aware of such docs.
The link you shared is not Push API, but Ingest API which is doing the same thing, just with different APIS.
The API itself is here https://github.com/grafana/pyroscope/tree/main/api maybe we can link to the source code at least.
Or remove "Push API" mentioning and the link alltogether
There was a problem hiding this comment.
If the user doesn't have any direct interaction with the endpoints - and it reads that way - then I'd just remove it and leave the sentence as
`pyroscope.write` receives performance profiles from other components and forwards them to a series of user-supplied endpoints.
clayton-cornell
added
the
type/docs
PR Description
Modify pyroscope.scrape to not drop meta labels
Update docs for pyroscope.write to clarify what labels are dropped and preserved
Which issue(s) this PR fixes
Fixes #2629
Notes to the Reviewer
PR Checklist