-
Notifications
You must be signed in to change notification settings - Fork 431
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
Closed
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
…d an exemple for json over the yaml file, also add a note for where to find exemple file
…changed the overview file content to olny review the custom config, cli, and kubernatics sections
…sh and json, add view mores to sections
… 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
…changed the overview file content to olny review the custom config, cli, and kubernatics sections
…sh and json, add view mores to sections
… add a material fetures for copy to clipboard
…ig, take most of it from the cli flags section
…ng, also change a bit the discription of other section
…acee into documentation_patch
i will open a new one |
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.
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:
Events in built in and security events:
CLI flags in scope:
tutorials:
the link to Kubernetes guide didnt work
Overview file in the docs:
you can view less importent things in the files changed of the git hub pr