docs(bcc/module.go): document attachperfevent arguments #327
Conversation
This file contains 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
The missing arguments documentation match perf_event_open syscall and bpf_attach_perf_event helper. Signed-off-by: Massimiliano Giovagnoli <me@maxgio.it>
maxgio92
changed the title
|
Hi @4ast, what do you think about this documentation addition? |
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.
Introduction
This PR tries to improve the documentation of the BCC
Module'sAttachPerfEventmethod.It fills the documentation for all the arguments.
Why
Even though the underlying ecosystem leverage BCC, libbpf and perf event, it can be useful to understand the usage of the gobpf binding directly from it, without the need of cross reference between BCC, libbpf and Linux headers.
Additional context
The arguments match the ones of
perf_event_opensyscall andbpf_attach_perf_eventhelper.Also, related issue on general BCC: iovisor/bcc#1756.