docs: update go-pull.md #2844
Merged
docs: update go-pull.md #2844
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| | path | string | The path to the profile type on the target. | "/debug/pprof/delta_heap" | no | | ||
|
|
||
| ### `profile.godeltaprof_mutex` | ||
| ### Prepare Grafana Agent Flow configuration file |
| Or if you use gorilla/mux: | ||
| ```go | ||
| var router *mux.Router | ||
| router.PathPrefix("/debug/pprof").Handler(http.DefaultServeMux) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
What are the next steps for someone? is there a page that we can link them to for the next step in what they need to do? (Or maybe we need to write one?)
There was a problem hiding this comment.
not sure I understand your question. The last steps are: see profiles in browser, optimize your application, repeat
There was a problem hiding this comment.
Sometimes there is a series of tasks you need to do. Those tasks may be on multiple pages. The "next step" can be a link to the procedure the user needs to perform next. if that isn't the case here, then we don't need a link to another page.
However, if there are things a user should repeat to refine the results, we might want to mention that.
knylander-grafana
approved these changes
Dec 13, 2023
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Rperry2174
reviewed
Dec 14, 2023
|
|
||
| and add it to your imports: | ||
| ### Exposing pprof endpoints |
There was a problem hiding this comment.
Should this be at the end or the beginning? seems like we should have people expose their pprof endpoints and then do the rest of the steps to scrape from them
There was a problem hiding this comment.
There is a step 1 exposing pprof endpoints
And this paragraph is for "advanced" cases when user does not use DefaultServeMux or does use gorila/mux .
Probably this paragraph requires different title
There was a problem hiding this comment.
either way, I think we should put this next to, if not in, the "exposing pprof endpoints" section. I suspect someone who was looking for this would expect to find it near or in that section
There was a problem hiding this comment.
lets remove it alltogether. I dont want this to be next to the "exposing pprof endpoints" as it complicates it
knylander-grafana
added
the
type/docs
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
knylander-grafana
added a commit
that referenced
this pull request
Dec 15, 2023
* docs: update go-pull.md * fix links * rm comments * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * typo * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com>
knylander-grafana
added a commit
that referenced
this pull request
Dec 16, 2023
* Changes from 2855 intro doc * docs: update go-pull.md (#2844) * docs: update go-pull.md * fix links * rm comments * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * typo * Update docs/sources/configure-client/grafana-agent/go_pull.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> * Create release notes for v1.2.1 (#2860) * docs: Add sampling documentation (#2854) * Add sampling doc * Tweak wording and layout * Fix links * Fix absolute links * Variety of small tweaks in structure and wording * docs: Refactor ebpf installation (#2849) * docs: Refactor ebpf installation * docs: Refactor ebpf installation * Remove not useful sections. * review feedbac * remove absolute link to grafana.com * lint * review feedback * Add diagram for ebpf * linted * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/configuration/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/configuration/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-docker.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-docker.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/troubleshooting.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-linux.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/configure-client/grafana-agent/ebpf/setup-kubernetes.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> * docs: language SDK page updates (#2851) * docs changes * improvements * wip * fixes * fixes * fixes * Update docs/sources/configure-client/language-sdks/go_push.md * Update docs/sources/configure-client/language-sdks/go_push.md * Apply suggestions from code review * Update Before you begin sections --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> Co-authored-by: Kim Nylander <kim.nylander@grafana.com> * doc: Add sampling diagram (#2861) --------- Co-authored-by: Tolya Korniltsev <korniltsev.anatoly@gmail.com> Co-authored-by: Ryan Perry <Rperry2174@gmail.com> Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com> Co-authored-by: Cyril Tovena <cyril.tovena@gmail.com> Co-authored-by: Dmitry Filimonov <dmitry.filimonov@grafana.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#2773