From d416099ffb8ad1d15cf77aa6b4a40e5f3b855ee3 Mon Sep 17 00:00:00 2001 From: thiagoftsm Date: Thu, 15 Apr 2021 18:18:51 +0000 Subject: Update eBPF documentation (#10982) --- collectors/apps.plugin/README.md | 2 +- collectors/ebpf.plugin/README.md | 4 ++-- collectors/ebpf.plugin/ebpf.c | 2 +- docs/configure/nodes.md | 4 ++-- docs/guides/troubleshoot/monitor-debug-applications-ebpf.md | 2 +- netdata-installer.sh | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/collectors/apps.plugin/README.md b/collectors/apps.plugin/README.md index d10af1cdd3..a85c07898d 100644 --- a/collectors/apps.plugin/README.md +++ b/collectors/apps.plugin/README.md @@ -160,7 +160,7 @@ There are a few command line options you can pass to `apps.plugin`. The list of ### Integration with eBPF If you don't see charts under the **eBPF syscall** or **eBPF net** sections, you should edit your -[`ebpf.conf`](/collectors/ebpf.plugin/README.md#ebpf-programs) file to ensure the eBPF program is enabled. +[`ebpf.d.conf`](/collectors/ebpf.plugin/README.md#ebpf-programs) file to ensure the eBPF program is enabled. Also see our [guide on troubleshooting apps with eBPF metrics](/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md) for ideas on how to interpret these charts in a diff --git a/collectors/ebpf.plugin/README.md b/collectors/ebpf.plugin/README.md index 405eab8758..c264b3f5f6 100644 --- a/collectors/ebpf.plugin/README.md +++ b/collectors/ebpf.plugin/README.md @@ -123,11 +123,11 @@ To enable the collector, scroll down to the `[plugins]` section ensure the relev ebpf = yes ``` -You can also configure the eBPF collector's behavior by editing `ebpf.conf`. +You can also configure the eBPF collector's behavior by editing `ebpf.d.conf`. ```bash cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /etc/netdata/ -./edit-config ebpf.conf +./edit-config ebpf.d.conf ``` ### `[global]` diff --git a/collectors/ebpf.plugin/ebpf.c b/collectors/ebpf.plugin/ebpf.c index 3b37ec67d2..fd5341bffd 100644 --- a/collectors/ebpf.plugin/ebpf.c +++ b/collectors/ebpf.plugin/ebpf.c @@ -1037,7 +1037,7 @@ static void parse_args(int argc, char **argv) if (load_collector_config(ebpf_user_config_dir, &disable_apps)) { info( - "Does not have a configuration file inside `%s/ebpf.conf. It will try to load stock file.", + "Does not have a configuration file inside `%s/ebpf.d.conf. It will try to load stock file.", ebpf_user_config_dir); if (load_collector_config(ebpf_stock_config_dir, &disable_apps)) { info("Does not have a stock file. It is starting with default options."); diff --git a/docs/configure/nodes.md b/docs/configure/nodes.md index c6e58cd8bb..a721c73c45 100644 --- a/docs/configure/nodes.md +++ b/docs/configure/nodes.md @@ -40,7 +40,7 @@ exist. - `edit-config` is a shell script used for [editing configuration files](#use-edit-config-to-edit-configuration-files). - Various configuration files ending in `.conf` for [configuring plugins or collectors](/docs/collect/enable-configure.md#enable-a-collector-or-its-orchestrator) behave. Examples: `go.d.conf`, - `python.d.conf`, and `ebpf.conf`. + `python.d.conf`, and `ebpf.d.conf`. - Various directories ending in `.d`, which contain other configuration files, each ending in `.conf`, for [configuring specific collectors](/docs/collect/enable-configure.md#configure-a-collector). - `apps_groups.conf` is a configuration file for changing how applications/processes are grouped when viewing the @@ -112,7 +112,7 @@ You can edit any Netdata configuration file using `edit-config`. A few examples: ```bash ./edit-config apps_groups.conf -./edit-config ebpf.conf +./edit-config ebpf.d.conf ./edit-config health.d/load.conf ./edit-config go.d/prometheus.conf ``` diff --git a/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md b/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md index 13efa20e8a..d6c4b06976 100644 --- a/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md +++ b/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md @@ -91,7 +91,7 @@ Let's turn on the `return` mode for more granularity when debugging Firefox's be ```bash cd /etc/netdata # Replace this path with your Netdata config directory -sudo ./edit-config ebpf.conf +sudo ./edit-config ebpf.d.conf ``` Replace `entry` with `return`: diff --git a/netdata-installer.sh b/netdata-installer.sh index ecf2caf214..c05dc30e10 100755 --- a/netdata-installer.sh +++ b/netdata-installer.sh @@ -1613,7 +1613,7 @@ remove_old_ebpf() { if [ -f "${NETDATA_PREFIX}/etc/netdata/ebpf_process.conf" ]; then echo >&2 "Renaming eBPF configuration file." - mv "${NETDATA_PREFIX}/etc/netdata/ebpf_process.conf" "${NETDATA_PREFIX}/etc/netdata/ebpf.conf" + mv "${NETDATA_PREFIX}/etc/netdata/ebpf_process.conf" "${NETDATA_PREFIX}/etc/netdata/ebpf.d.conf" fi # Added to remove eBPF programs with name pattern: NAME_VERSION.SUBVERSION.PATCH -- cgit v1.2.3