Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(bcc/module.go): document attachperfevent arguments #327

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

maxgio92
Copy link

@maxgio92 maxgio92 commented May 30, 2023

Introduction

This PR tries to improve the documentation of the BCC Module's AttachPerfEvent method.
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_open syscall and bpf_attach_perf_event helper.

Also, related issue on general BCC: iovisor/bcc#1756.

The missing arguments documentation match perf_event_open syscall and bpf_attach_perf_event helper.

Signed-off-by: Massimiliano Giovagnoli <[email protected]>
@maxgio92 maxgio92 changed the title docs(bcc/module.go): document attachperfevent arguments and usage docs(bcc/module.go): document attachperfevent arguments May 30, 2023
@maxgio92
Copy link
Author

maxgio92 commented Jun 1, 2023

Hi @4ast, what do you think about this documentation addition?
Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant