Skip to content

Commit e48f5c8

Browse files
authored
Improve cgroup_regex docs with examples (#20425)
Signed-off-by: chrismark <chrismarkou92@gmail.com>
1 parent 496e3c9 commit e48f5c8

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

libbeat/processors/add_process_metadata/docs/add_process_metadata.asciidoc

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,23 +72,29 @@ field will be present in the output.
7272

7373
`host_path`:: (Optional) By default, the `host_path` field is set to the root
7474
directory of the host `/`. This is the path where `/proc` is mounted. For
75-
different runtime configurations of Kubernetes or Docker, the `host_path` can
75+
different runtime configurations of Kubernetes or Docker, the `host_path` can
7676
be set to overwrite the default.
7777

7878
`cgroup_prefixes`:: (Optional) By default, the `cgroup_prefixes` field is set
7979
to `/kubepods` and `/docker`. This is the prefix where the container ID is
8080
inside cgroup. For different runtime configurations of Kubernetes or Docker,
8181
the `cgroup_prefixes` can be set to overwrite the defaults.
8282

83-
`cgroup_regex`:: (Optional) By default, the container id is extracted from
84-
cgroup file based on `cgroup_prefixes`. This can be overwritten by specifying
85-
regular expression with capture group for capturing container id from cgroup
86-
path. For example: `^\/.+\/.+\/.+\/([0-9a-f]{64}).*`
87-
88-
`cgroup_cache_expire_time`:: (Optional) By default, the
83+
`cgroup_regex`:: (Optional) By default, the container id is extracted from
84+
cgroup file based on `cgroup_prefixes`. This can be overwritten by specifying
85+
regular expression with capture group for capturing container id from cgroup
86+
path. Examples:
87+
. `^\/.+\/.+\/.+\/([0-9a-f]{64}).*` will match the container id of a cgroup
88+
like `/kubepods/besteffort/pod665fb997-575b-11ea-bfce-080027421ddf/b5285682fba7449c86452b89a800609440ecc88a7ba5f2d38bedfb85409b30b1`
89+
. `^\/.+\/.+\/.+\/docker-([0-9a-f]{64}).scope` will match the container id of a cgroup
90+
like `/kubepods.slice/kubepods-burstable.slice/kubepods-burstable-pod69349abe_d645_11ea_9c4c_08002709c05c.slice/docker-80d85a3a585f1575028ebe468d83093c301eda20d37d1671ff2a0be50fc0e460.scope`
91+
. `^\/.+\/.+\/.+\/crio-([0-9a-f]{64}).scope` will match the container id of a cgroup
92+
like `/kubepods.slice/kubepods-burstable.slice/kubepods-burstable-pod69349abe_d645_11ea_9c4c_08002709c05c.slice/crio-80d85a3a585f1575028ebe468d83093c301eda20d37d1671ff2a0be50fc0e460.scope`
93+
94+
`cgroup_cache_expire_time`:: (Optional) By default, the
8995
`cgroup_cache_expire_time` is set to 30 seconds. This is the length of time
9096
before cgroup cache elements expire in seconds. It can be set to 0 to disable
91-
the cgroup cache. In some container runtimes technology like runc, the
97+
the cgroup cache. In some container runtimes technology like runc, the
9298
container's process is also process in the host kernel, and will be affected by
93-
PID rollover/reuse. The expire time needs to set smaller than the PIDs wrap
99+
PID rollover/reuse. The expire time needs to set smaller than the PIDs wrap
94100
around time to avoid wrong container id.

0 commit comments

Comments
 (0)