Skip to content

Commit bd44a87

Browse files
committed
docs: Add ancestors and ancestor filter information
Add information about ancestors, ancestor filter and ancestors related metrics to documentation. Signed-off-by: t0x01 <[email protected]>
1 parent 22a3b88 commit bd44a87

File tree

6 files changed

+21
-3
lines changed

6 files changed

+21
-3
lines changed

api/v1/README.md

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/en/docs/concepts/events.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,9 @@ flags, or environment variables.
166166
| `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 |
167167
| `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). |
168168
| `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. |
169+
| `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). |
169170

170-
#### Field Filtering
171+
#### Field Filtering
171172

172173
In some cases, it is not desirable to include all of the fields exported in
173174
Tetragon events by default. In these cases, you can use field filters to

docs/content/en/docs/reference/grpc-api.md

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/content/en/docs/reference/metrics.md

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/data/tetragon_flags.yaml

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/configuration/tetragon.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ debug: false
1616
disable-kprobe-multi: false
1717
enable-export-aggregation: false
1818
enable-k8s-api: false
19+
enable-process-ancestors: false
1920
enable-process-cred: false
2021
enable-process-ns: false
2122
event-queue-size: 10000

0 commit comments

Comments
 (0)