-
Notifications
You must be signed in to change notification settings - Fork 449
Documentation patch #4303
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
Merged
Merged
Documentation patch #4303
Changes from all commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
52249d5
change the documentation for how to run tracee with config file, adde…
ShohamBit a7b12aa
added a file for the futer to write a documentation on how to write a…
ShohamBit f5f1e1a
changed the docs and tutorials palce, and added custom configure to …
ShohamBit aa3f1c1
added the option to view the custom configurtion of config file
ShohamBit feec697
fixed spelling issue
ShohamBit f9be897
added the finel version of custom configuration to docs section also …
ShohamBit 344a837
change the mkdocs file to serve ass the new docs represantation of tr…
ShohamBit dd9e7f8
added some changes to sutom config
ShohamBit 91330e2
added some missing flags in the yaml file
ShohamBit fdbd94e
deleted the custom configure file, marge it with the index, remove ba…
ShohamBit 9558b88
remove custom config from mkdocs
ShohamBit ddf421c
added things that was missing, changes and solved issues with files,…
ShohamBit d911b48
change a bit the looks
ShohamBit 6074dcd
added final changes
ShohamBit 589d058
removed wild card option for scope
ShohamBit 92fa3a6
changed Scope filters to Rules filter - need further changes on Even…
ShohamBit 221c86c
added a modified description of scope to the scope section under conf…
ShohamBit 32e8030
modified rules section under policy because scope filter was confusi…
ShohamBit 18738f9
modify rules and scope sections
ShohamBit 849ccf2
Update docs/docs/install/config/index.md
ShohamBit 4418b27
Update docs/docs/install/config/cli.md
ShohamBit 1e02ab4
Update docs/docs/policies/rules.md
ShohamBit 3aeaf76
resolve changes
ShohamBit d48b0fe
resolve more changes
ShohamBit f203f87
Update docs/docs/flags/scope.1.md
ShohamBit 356dedc
Update docs/docs/policies/rules.md
ShohamBit ee2d539
Update docs/docs/policies/rules.md
ShohamBit 65952c7
Update docs/docs/policies/rules.md
ShohamBit f9667c2
Update docs/docs/policies/rules.md
ShohamBit 8bdf002
Merge branch 'main' into documentation_patch
ShohamBit File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,143 +1,194 @@ | ||
# Configuring Tracee | ||
|
||
Tracee has many different options and settings that control how Tracee operates. | ||
This section presents available configuration options. To learn about how to apply configuration to Tracee, please refer to the [CLI](./cli.md) or [Kubernetes](./kubernetes.md) specific guides. | ||
|
||
|
||
To learn about how to apply configuration to Tracee, please refer to the [CLI](./cli.md) or [Kubernetes](./kubernetes.md) specific guides, depending on how you deploy Tracee. | ||
|
||
A complete config file with all available options can be found [here](https://github.com/aquasecurity/tracee/blob/main/examples/config/global_config.yaml). Most of the options are documented in different sections in the documentation. | ||
|
||
```yaml | ||
blob-perf-buffer-size: 1024 | ||
cache: | ||
type: none | ||
size: 1024 | ||
|
||
proctree: | ||
source: none | ||
cache: | ||
process: 8192 | ||
thread: 4096 | ||
|
||
capabilities: | ||
bypass: false | ||
add: | ||
- cap_sys_admin | ||
- cap_syslog | ||
drop: | ||
- cap_chown | ||
|
||
cri: | ||
- runtime: | ||
name: containerd | ||
socket: /var/run/containerd/containerd.sock | ||
- runtime: | ||
name: docker | ||
socket: /var/run/docker.sock | ||
|
||
healthz: false | ||
install-path: /tmp/tracee | ||
listen-addr: :3366 | ||
log: | ||
level: info | ||
file: "/path/to/log/file.log" | ||
aggregate: | ||
enabled: true | ||
flush-interval: "5s" | ||
filters: | ||
libbpf: false | ||
in: | ||
msg: | ||
- SampleMessage1 | ||
- SampleMessage2 | ||
pkg: | ||
- package1 | ||
- package2 | ||
file: | ||
- file1.go | ||
- file2.go | ||
level: | ||
- warn | ||
- error | ||
regex: | ||
- ^pattern1 | ||
- ^pattern2 | ||
out: | ||
msg: | ||
- ExcludedMessage1 | ||
pkg: | ||
- excludedPackage | ||
file: | ||
- excludedFile.go | ||
level: | ||
- debug | ||
regex: | ||
- ^excludedPattern | ||
|
||
metrics: false | ||
output: | ||
json: | ||
files: | ||
- stdout | ||
|
||
table: | ||
files: | ||
- /path/to/table1.out | ||
- /path/to/table2.out | ||
|
||
table-verbose: | ||
files: | ||
- stdout | ||
|
||
gotemplate: | ||
template: /path/to/my_template1.tmpl | ||
files: | ||
- /path/to/output1.out | ||
- /path/to/output2.out | ||
|
||
forward: | ||
- forward1: | ||
protocol: tcp | ||
user: user | ||
password: pass | ||
host: 127.0.0.1 | ||
port: 24224 | ||
tag: tracee1 | ||
- forward2: | ||
protocol: udp | ||
user: user | ||
password: pass | ||
host: 127.0.0.1 | ||
port: 24225 | ||
tag: tracee2 | ||
|
||
webhook: | ||
- webhook1: | ||
protocol: http | ||
host: localhost | ||
port: 8000 | ||
timeout: 5s | ||
gotemplate: /path/to/template/test.tmpl | ||
content-type: application/json | ||
- webhook2: | ||
protocol: http | ||
host: localhost | ||
port: 9000 | ||
timeout: 3s | ||
gotemplate: /path/to/template/test.tmpl | ||
content-type: application/json | ||
|
||
options: | ||
none: false | ||
stack-addresses: true | ||
exec-env: false | ||
exec-hash: dev-inode | ||
parse-arguments: true | ||
sort-events: false | ||
|
||
perf-buffer-size: 1024 | ||
pprof: false | ||
pyroscope: false | ||
rego: | ||
partial-eval: true | ||
aio: true | ||
signatures-dir: "" | ||
``` | ||
- __NOTE__: The YAML examples can be translated to JSON as well | ||
|
||
## Common configurations | ||
|
||
### Policy | ||
|
||
- **`--policy` (`-p`)**: Specifies a policy file or directory of policies that define what to trace. | ||
|
||
__NOTE__: You can view more in the [policy section](../../policies/index.md). | ||
|
||
YAML: | ||
```yaml | ||
policy: | ||
- /path/to/policy.yaml | ||
``` | ||
|
||
|
||
### Output | ||
|
||
- **`--output` (`-o`)**: Controls how and where the output is printed. | ||
|
||
__NOTE__: You can view more in the [output section](../../outputs/index.md). | ||
|
||
YAML: | ||
```yaml | ||
output: | ||
- json | ||
``` | ||
|
||
|
||
### Server | ||
|
||
|
||
- **`--metrics-endpoint`**: Enables the metrics endpoint. | ||
|
||
__NOTE__: You can view more in the [Prometheus section](../prometheus.md). | ||
|
||
YAML: | ||
```yaml | ||
metrics-endpoint: true | ||
``` | ||
|
||
- **`--grpc-listen-addr`**: Specifies the address for the gRPC server. | ||
|
||
YAML: | ||
```yaml | ||
grpc-listen-addr: tcp:50051 | ||
``` | ||
|
||
|
||
### Process Tree | ||
|
||
- **`--proctree` (`-t`)**: Controls process tree options. | ||
|
||
|
||
__NOTE__: You can view more in the [Process Tree section](../../advanced/data-sources/builtin/process-tree.md). | ||
|
||
YAML: | ||
```yaml | ||
proctree: | ||
- process | ||
``` | ||
|
||
### Install Path | ||
|
||
- **`--install-path`**: Specifies the directory where Tracee will install or look for its resources. If not specified, the default installation directory is `/tmp/tracee`. | ||
|
||
YAML: | ||
```yaml | ||
install-path: /opt/tracee | ||
``` | ||
|
||
__NOTE__: This option is useful when running Tracee in environments where `/tmp` is not suitable or secure. | ||
|
||
### Log | ||
|
||
- **`--log` (`-l`)**: Controls the verbosity level of Tracee's logging system. The default log level is `info`. | ||
|
||
|
||
__NOTE__: You can view more in the [Tracee Logs section](../../outputs/logging.md). | ||
|
||
YAML: | ||
```yaml | ||
log: | ||
- level: debug | ||
``` | ||
|
||
### Container | ||
|
||
- **`--no-containers`**: Disables container information enrichment in events. | ||
|
||
YAML: | ||
```yaml | ||
no-containers: true | ||
``` | ||
|
||
__NOTE__: You can view more in the [cri section](../../flags/containers.1.md). | ||
|
||
- **`--cri`**: Defines connected container runtimes in the format `<runtime:socket>`. | ||
|
||
YAML: | ||
```yaml | ||
cri: | ||
- docker:/var/run/docker.sock | ||
``` | ||
|
||
### DNS Cache | ||
|
||
- **`--dnscache`**: Enables DNS caching in Tracee. | ||
|
||
__NOTE__: You can view more in the [DNS Cache section](../../advanced/data-sources/builtin/dns.md). | ||
|
||
YAML: | ||
E31B ```yaml | ||
dnscache: enable | ||
``` | ||
|
||
### Capabilities | ||
|
||
- **`--capabilities` (`-C`)**: Define specific capabilities for Tracee to run with. This allows you to either bypass, add, or drop certain capabilities based on your security and operational needs. | ||
|
||
|
||
__NOTE__: You can view more in the [Tracee Capabilities section](../../flags/capabilities.1.md) | ||
|
||
YAML: | ||
```yaml | ||
capabilities: | ||
- add: | ||
- CAP_SYS_ADMIN | ||
- drop: | ||
- CAP_NET_RAW | ||
``` | ||
|
||
__NOTE__: Capabilities are Linux-specific permissions that control which privileged operations a program can perform. | ||
|
||
|
||
### Capture | ||
|
||
- **`--capture` (`-c`)**: Captures artifacts such as files or network packets that are written or executed. | ||
|
||
|
||
__NOTE__: You can view more in the [Capture section](../../flags/capture.1.md). | ||
|
||
YAML: | ||
```yaml | ||
capture: | ||
- write | ||
``` | ||
|
||
### Buffer and Cache | ||
|
||
- **`--perf-buffer-size` (`-b`)**: Specifies the size of the internal perf ring buffer in pages. | ||
|
||
Default: `1024` (4 MB) | ||
|
||
YAML: | ||
```yaml | ||
perf-buffer-size: 2048 | ||
``` | ||
|
||
- **`--blob-perf-buffer-size`**: Specifies the size of the internal perf ring buffer used to send blobs from the kernel. | ||
|
||
Default: `1024` (4 MB) | ||
|
||
YAML: | ||
```yaml | ||
blob-perf-buffer-size: 2048 | ||
``` | ||
|
||
- **`--pipeline-channel-size`**: Specifies the size of each pipeline stage's output channel. | ||
|
||
Default: `10000` | ||
|
||
YAML: | ||
```yaml | ||
pipeline-channel-size: 2048 | ||
``` | ||
|
||
- **`--cache` (`-a`)**: Controls event caching options. | ||
|
||
YAML: | ||
```yaml | ||
cache: | ||
- mem-cache-size=512 | ||
``` |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.