Skip to content

Commit

Permalink
docs: Add ancestors and ancestor filter information
Browse files Browse the repository at this point in the history
Add information about ancestors, ancestor filter and ancestors related metrics to documentation.

Signed-off-by: t0x01 <[email protected]>
  • Loading branch information
t0x01 committed Dec 26, 2024
1 parent c99334a commit ab1d044
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 5 deletions.
8 changes: 7 additions & 1 deletion api/v1/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion docs/content/en/docs/concepts/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,9 @@ flags, or environment variables.
| `parent_arguments_regex` | Filter by the container ID in the process.docker field using RE2 regular expression syntax: https://github.com/google/re2/wiki/Syntax |
| `container_id` | Filter by parent process arguments using a list of regular expressions. You can find the full syntax [here](https://github.com/google/re2/wiki/Syntax). |
| `in_init_tree` | Filter containerized processes based on whether they are descendants of the container's init process. This can be used, for example, to watch for processes injected into a container via docker exec, kubectl exec, or similar mechanisms. |
| `ancestor_binary_regex` | Filter process events by a list of regular expressions of ancestor processes' binary names (e.g. `"^/home/kubernetes/bin/kubelet$"`). You can find the full syntax [here](https://github.com/google/re2/wiki/Syntax). |

#### Field Filtering
#### Field Filtering

In some cases, it is not desirable to include all of the fields exported in
Tetragon events by default. In these cases, you can use field filters to
Expand Down
8 changes: 7 additions & 1 deletion docs/content/en/docs/reference/grpc-api.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/content/en/docs/reference/metrics.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions docs/data/tetragon_flags.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions examples/configuration/tetragon.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ debug: false
disable-kprobe-multi: false
enable-export-aggregation: false
enable-k8s-api: false
enable-process-ancestors: false
enable-process-cred: false
enable-process-ns: false
event-queue-size: 10000
Expand Down

0 comments on commit ab1d044

Please sign in to comment.