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

Documentation patch for config files #4282

Closed
wants to merge 42 commits into from

Conversation

ShohamBit
Copy link
Collaborator

@ShohamBit ShohamBit commented Sep 8, 2024

1. Explain what the PR does

the pr is mostly about the documantation of tracee
the first part is about fixing the configuration docs of tracee
i replaced the old section that was just a big file with a detailed explation of how to make a config yaml file
i added things to the global config file that wasn't there
as i made the docs with " mkdocs serve" i noticed some warnings that files had some issues so i solved that by making them do what they suppose to du
and for last i added a feature for the theme material in mkdocs file to add the option to copy content by a button click
and redid some work that i have done but got another perspactive on how it should be made

2. Explain how to test it

you can view the docs by pulling the pr and using the mkdocs serve
view the section of:
Events in built in and extra events:

  • security_settime64 that wasnt working
  • security_path_notify wasnt exisit
  • set_fs_pwd wasnt exisit
  • tracee_info wasnt exisit

Events in built in and security events:

  • format wasnt exist

CLI flags in scope:

  • removed the option of using wildcard because it doesn't work with tracee

tutorials:
the link to Kubernetes guide didnt work

Overview file in the docs:

  • section the Tutorials ,Docs and Contributing wasnt correct
  • the macfaq was in () insted of []
  • contribution documentation was with out the .md

you can view less importent things in the files changed of the git hub pr

ShohamBit and others added 19 commits September 9, 2024 12:56
… add a material fetures for copy to clipboard
…ig, take most of it from the cli flags section
The expirable LRU cache is not intended to be used in the ProcessTree
type since the TTL would impact its correctness on some scenarios.

Despite TTL can be disabled by setting it to 0, it is not a good idea
due to the potential performance impact of its implementation. See the
comparison between the simple LRU and the expirable LRU below:

| Benchmark                              | Exp LRU |  Simple |    %   |
|                                        |  TTL 0  |   LRU   |  Impr. |
|                                        | (ns/op) | (ns/op) |    *   |
|----------------------------------------|---------|---------|--------|
| GetProcessByHash-Concurrency1          | 4.264   | 6.301   | -47.8% |
| GetProcessByHash-Concurrency2          | 14.91   | 19.85   | -33.2% |
| GetProcessByHash-Concurrency4          | 74.03   | 63.22   | 14.6%  |
| GetProcessByHash-Concurrency8          | 247.2   | 174.7   | 29.3%  |
| GetOrCreateProcessByHash-Concurrency1  | 37.02   | 8.370   | 77.4%  |
| GetOrCreateProcessByHash-Concurrency2  | 80.84   | 23.37   | 71.1%  |
| GetOrCreateProcessByHash-Concurrency4  | 181.6   | 75.67   | 58.4%  |
| GetOrCreateProcessByHash-Concurrency8  | 408.3   | 194.5   | 52.4%  |
| GetThreadByHash-Concurrency1           | 38.13   | 7.675   | 79.9%  |
| GetThreadByHash-Concurrency2           | 79.98   | 22.71   | 71.6%  |
| GetThreadByHash-Concurrency4           | 177.1   | 60.76   | 65.7%  |
| GetThreadByHash-Concurrency8           | 403.2   | 190.0   | 52.9%  |
| GetOrCreateThreadByHash-Concurrency1   | 38.16   | 7.996   | 79.0%  |
| GetOrCreateThreadByHash-Concurrency2   | 79.82   | 23.73   | 70.3%  |
| GetOrCreateThreadByHash-Concurrency4   | 177.1   | 67.13   | 62.1%  |
| GetOrCreateThreadByHash-Concurrency8   | 405.1   | 151.3   | 62.7%  |

Therefore, this commit reverts the ProcessTree to use the simple LRU
cache until a better solution is designed.

* Part of the performance improvement is also due to the removal of the
outer lock done by 44e59d3.
…ng, also change a bit the discription of other section
An off-by-one bounds check on an argument type array resulted in timespec_t args not being submitted.
…d an exemple for json over the yaml file, also add a note for where to find exemple file
@ShohamBit
Copy link
Collaborator Author

i will open a new one

@ShohamBit ShohamBit closed this Sep 17, 2024
@ShohamBit ShohamBit deleted the documentation_patch branch September 17, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants