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

feat: Added uprobe, syscall tracing and how bpftime works in the docs #25

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

Viveksati5143
Copy link

@Viveksati5143 Viveksati5143 commented Feb 27, 2024

Description

  • Updated docs for using bpftime for uprobe, syscall tracing
  • Added how bpftime works

Fixes #92

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

  • Test A

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes
  • I have checked my code and corrected any misspellings

@yunwei37
Copy link
Member

The uprobe and syscall-traceing part maybe already covered by https://eunomia.dev/bpftime/documents/usage/, you can help improve the documents there.

You can also add a page about bpftimetool.

@Viveksati5143 Viveksati5143 marked this pull request as ready for review February 29, 2024 23:08
@Viveksati5143
Copy link
Author

Viveksati5143 commented Feb 29, 2024

The uprobe and syscall-traceing part maybe already covered by https://eunomia.dev/bpftime/documents/usage/, you can help improve the documents there.

You can also add a page about bpftimetool.

Can you please review it now @yunwei37 ?
Do lmk in case of any modifications...

Copy link
Member

@yunwei37 yunwei37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's first force on add a markdown page about bpftimetool.

@pull-request-size pull-request-size bot added size/S and removed size/M labels Mar 1, 2024
@Viveksati5143 Viveksati5143 marked this pull request as draft March 1, 2024 19:52
@pull-request-size pull-request-size bot added size/M and removed size/S labels Mar 2, 2024
@Viveksati5143 Viveksati5143 marked this pull request as ready for review March 2, 2024 00:56
@Viveksati5143
Copy link
Author

Hi @yunwei37
I've fulfilled the requested changes.
Is it good for 1st iteration? I've mentioned the references as well...
So, can you please review it?

@Officeyutong
Copy link
Contributor

Hi @yunwei37

I've fulfilled the requested changes.

Is it good for 1st iteration? I've mentioned the references as well...

So, can you please review it?

yunwei is very busy recently, so let me respond to you.

bpftimetool is a program concerning dumping/loading shared memory stuff, similar to bpftool for kernel. It does not mean the whole bpftime project. You may find that tool at tools/bpftimetool of the main repository

@Viveksati5143
Copy link
Author

Hi @yunwei37
I've fulfilled the requested changes.
Is it good for 1st iteration? I've mentioned the references as well...
So, can you please review it?

yunwei is very busy recently, so let me respond to you.

bpftimetool is a program concerning dumping/loading shared memory stuff, similar to bpftool for kernel. It does not mean the whole bpftime project. You may find that tool at tools/bpftimetool of the main repository

So, am I to write specifically about bpftimetool?

@Officeyutong
Copy link
Contributor

Hi @yunwei37

I've fulfilled the requested changes.

Is it good for 1st iteration? I've mentioned the references as well...

So, can you please review it?

yunwei is very busy recently, so let me respond to you.

bpftimetool is a program concerning dumping/loading shared memory stuff, similar to bpftool for kernel. It does not mean the whole bpftime project. You may find that tool at tools/bpftimetool of the main repository

So, am I to write specifically about bpftimetool?

Yes. But other parts are also welcomed. Thank you!

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

Successfully merging this pull request may close these issues.

None yet

3 participants