doc(troubleshooting): sync agent profiler usage #1166
Merged
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
✅ Deploy Preview for longhornio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
COLDTURNIP
force-pushed
the
11386-sync_agent_pprof
branch
from
680ccee to
10b8cde
Compare
sushant-suse
requested changes
Jul 28, 2025
Comment on lines
82
to
86
| ### Engine, replica, and sync agent runtime | ||
|
|
||
| Pprof server can be enabled dynamically for runtime profiling. | ||
|
|
||
| To enable profiling, shell into the instance manager pod, and check the port of the runtime using `ps`: |
There was a problem hiding this comment.
Suggested change
| ### Engine, replica, and sync agent runtime | |
| Pprof server can be enabled dynamically for runtime profiling. | |
| To enable profiling, shell into the instance manager pod, and check the port of the runtime using `ps`: | |
| ### Engine, Replica, and Sync Agent Runtime | |
| You can enable the `pprof` server dynamically to perform runtime profiling. | |
| To enable profiling, you can: | |
| 1. Shell into the instance manager pod. | |
| 2. Identify the runtime process and its port using `ps`: |
| --replica tcp://10.42.1.7:10000 --listen 0.0.0.0:10010 | ||
| ``` | ||
|
|
||
| And assign a port to enable the pprof server for given runtime process: |
There was a problem hiding this comment.
Suggested change
| And assign a port to enable the pprof server for given runtime process: | |
| 3. Enable the `pprof` server for the desired runtime (for example, sync-agent): | |
| > In this example, the sync-agent process listens on port `10002`. |
Comment on lines
108
to
110
| The pprof server of sync agent (serves at port `10002`) is available at `http://localhost:36060` inside the instance manager pod in the example. Refer to the [pprof official document](https://pkg.go.dev/net/http/pprof#hdr-Usage_examples) for the profiler usage. | ||
|
|
||
| The profiler can be disabled after profiling. |
There was a problem hiding this comment.
Suggested change
| The pprof server of sync agent (serves at port `10002`) is available at `http://localhost:36060` inside the instance manager pod in the example. Refer to the [pprof official document](https://pkg.go.dev/net/http/pprof#hdr-Usage_examples) for the profiler usage. | |
| The profiler can be disabled after profiling. | |
| > The `pprof` server is now accessible at `http://localhost:36060` *inside the instance manager pod*. | |
| 4. Use the `pprof` interface for runtime inspection. For more details, refer to the [official pprof documentation](https://pkg.go.dev/net/http/pprof#hdr-Usage_examples). | |
| 5. Disable the profiler after completing your analysis: |
COLDTURNIP
force-pushed
the
11386-sync_agent_pprof
branch
from
10b8cde to
0abe0a9
Compare
derekbit
approved these changes
Aug 11, 2025
longhorn-11386 Signed-off-by: Raphanus Lo <[email protected]>
derekbit
force-pushed
the
11386-sync_agent_pprof
branch
from
0abe0a9 to
1be89be
Compare
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.
Which issue(s) this PR fixes:
Issue longhorn/longhorn#11386
What this PR does / why we need it:
Special notes for your reviewer:
Additional documentation or context