diff options
Diffstat (limited to 'collectors/apps.plugin/README.md')
| -rw-r--r-- | collectors/apps.plugin/README.md | 130 |
1 files changed, 64 insertions, 66 deletions
diff --git a/collectors/apps.plugin/README.md b/collectors/apps.plugin/README.md index bf57ea648f..308fe657fa 100644 --- a/collectors/apps.plugin/README.md +++ b/collectors/apps.plugin/README.md @@ -26,38 +26,38 @@ that fork/spawn other short lived processes hundreds of times per second. `apps.plugin` provides charts for 3 sections: -1. Per application charts as **Applications** at Netdata dashboards -2. Per user charts as **Users** at Netdata dashboards -3. Per user group charts as **User Groups** at Netdata dashboards +1. Per application charts as **Applications** at Netdata dashboards +2. Per user charts as **Users** at Netdata dashboards +3. Per user group charts as **User Groups** at Netdata dashboards Each of these sections provides the same number of charts: -- CPU Utilization - - Total CPU usage - - User / System CPU usage -- Disk I/O - - Physical Reads / Writes - - Logical Reads / Writes - - Open Unique Files (if a file is found open multiple times, it is counted just once) -- Memory - - Real Memory Used (non shared) - - Virtual Memory Allocated - - Minor Page Faults (i.e. memory activity) -- Processes - - Threads Running - - Processes Running - - Pipes Open -- Swap Memory - - Swap Memory Used - - Major Page Faults (i.e. swap activity) -- Network - - Sockets Open +- CPU Utilization + - Total CPU usage + - User / System CPU usage +- Disk I/O + - Physical Reads / Writes + - Logical Reads / Writes + - Open Unique Files (if a file is found open multiple times, it is counted just once) +- Memory + - Real Memory Used (non shared) + - Virtual Memory Allocated + - Minor Page Faults (i.e. memory activity) +- Processes + - Threads Running + - Processes Running + - Pipes Open +- Swap Memory + - Swap Memory Used + - Major Page Faults (i.e. swap activity) +- Network + - Sockets Open The above are reported: -- For **Applications** per [target configured](apps_groups.conf). -- For **Users** per username or UID (when the username is not available). -- For **User Groups** per groupname or GID (when groupname is not available). +- For **Applications** per [target configured](apps_groups.conf). +- For **Users** per username or UID (when the username is not available). +- For **User Groups** per groupname or GID (when groupname is not available). ## Performance @@ -80,7 +80,7 @@ To do this, edit `/etc/netdata/netdata.conf` and find this section: # command options = ``` -Uncomment the line `update every` and set it to a higher number. If you just set it to ` 2 `, +Uncomment the line `update every` and set it to a higher number. If you just set it to `2`, its CPU resources will be cut in half, and data collection will be once every 2 seconds. ## Configuration @@ -105,28 +105,28 @@ undesirable, the line `other: *` should be appended to the `apps_groups.conf`. The process names are the ones returned by: - - `ps -e` or `cat /proc/PID/stat` - - in case of substring mode (see below): `/proc/PID/cmdline` +- `ps -e` or `cat /proc/PID/stat` +- in case of substring mode (see below): `/proc/PID/cmdline` To add process names with spaces, enclose them in quotes (single or double) -example: ` 'Plex Media Serv' ` or ` "my other process" `. +example: `'Plex Media Serv'` or `"my other process"`. -You can add an asterisk ` * ` at the beginning and/or the end of a process: +You can add an asterisk `*` at the beginning and/or the end of a process: - - `*name` *suffix* mode: will search for processes ending with `name` (at `/proc/PID/stat`) - - `name*` *prefix* mode: will search for processes beginning with `name` (at `/proc/PID/stat`) - - `*name*` *substring* mode: will search for `name` in the whole command line (at `/proc/PID/cmdline`) +- `*name` _suffix_ mode: will search for processes ending with `name` (at `/proc/PID/stat`) +- `name*` _prefix_ mode: will search for processes beginning with `name` (at `/proc/PID/stat`) +- `*name*` _substring_ mode: will search for `name` in the whole command line (at `/proc/PID/cmdline`) -If you enter even just one *name* (substring), `apps.plugin` will process +If you enter even just one _name_ (substring), `apps.plugin` will process `/proc/PID/cmdline` for all processes (of course only once per process: when they are first seen). -To add processes with single quotes, enclose them in double quotes: ` "process with this ' single quote" ` +To add processes with single quotes, enclose them in double quotes: `"process with this ' single quote"` -To add processes with double quotes, enclose them in single quotes: ` 'process with this " double quote' ` +To add processes with double quotes, enclose them in single quotes: `'process with this " double quote'` -If a group or process name starts with a ` - `, the dimension will be hidden from the chart (cpu chart only). +If a group or process name starts with a `-`, the dimension will be hidden from the chart (cpu chart only). -If a process starts with a ` + `, debugging will be enabled for it (debugging produces a lot of output - do not enable it in production systems). +If a process starts with a `+`, debugging will be enabled for it (debugging produces a lot of output - do not enable it in production systems). You can add any number of groups. Only the ones found running will affect the charts generated. However, producing charts with hundreds of dimensions may slow down your web browser. @@ -145,7 +145,7 @@ The problem is described in issue #157. When Netdata is installed, `apps.plugin` is given the capabilities `cap_dac_read_search,cap_sys_ptrace+ep`. If this fails (i.e. `setcap` fails), `apps.plugin` is setuid to `root`. -#### linux capabilities in containers +### linux capabilities in containers There are a few cases, like `docker` and `virtuozzo` containers, where `setcap` succeeds, but the capabilities are silently ignored (in `lxc` containers `setcap` fails). @@ -189,22 +189,21 @@ Here is an example for the process group `sql` at `https://registry.my-netdata.i Netdata is able give you a lot more badges for your app. Examples below for process group `sql`: -- CPU usage:  -- Disk Physical Reads  -- Disk Physical Writes  -- Disk Logical Reads  -- Disk Logical Writes  -- Open Files  -- Real Memory  -- Virtual Memory  -- Swap Memory  -- Minor Page Faults  -- Processes  -- Threads  -- Major Faults (swap activity)  -- Open Pipes  -- Open Sockets  - +- CPU usage:  +- Disk Physical Reads  +- Disk Physical Writes  +- Disk Logical Reads  +- Disk Logical Writes  +- Open Files  +- Real Memory  +- Virtual Memory  +- Swap Memory  +- Minor Page Faults  +- Processes  +- Threads  +- Major Faults (swap activity)  +- Open Pipes  +- Open Sockets  For more information about badges check [Generating Badges](../../web/api/badges) @@ -225,7 +224,7 @@ identify the process that consumes so much CPU**. Here is what common Linux console monitoring tools report: -#### top +### top `top` reports that `bash` is using just 14%. @@ -249,7 +248,7 @@ KiB Swap: 0 total, 0 free, 0 used. 753712 avail Mem 2 root 20 0 0 0 0 S 0.0 0.0 0:00.00 kthreadd ``` -#### htop +### htop Exactly like `top`, `htop` is providing an incomplete breakdown of the system CPU utilization. @@ -267,7 +266,7 @@ Exactly like `top`, `htop` is providing an incomplete breakdown of the system CP 7019 netdata 20 0 138M 21016 2712 S 0.0 2.1 0:00.14 /usr/sbin/netdata ``` -#### atop +### atop `atop` also fails to break down CPU usage. @@ -290,14 +289,13 @@ NET | eth0 ---- | pcki 16 | pcko 15 | si 1 Kbps | so 4 Kbps | 7009 0.01s 0.01s 0K 0K 0K 4K -- - S 0% netdata ``` -#### glances +### glances And the same is true for `glances`. The system runs at 100%, but `glances` reports only 17% per process utilization. Note also, that being a `python` program, `glances` uses 1.6% CPU while it runs. - ``` localhost Uptime: 3 days, 21:42:00 @@ -318,24 +316,24 @@ FILE SYS Used Total 0.3 2.1 7009 netdata 0 S /usr/sbin/netdata / (vda1) 1.56G 29.5G 0.0 0.0 17 root 0 S oom_reaper ``` -#### why does this happen? +### why does this happen? All the console tools report usage based on the processes found running *at the moment they examine the process tree*. So, they see just one `ls` command, which is actually very quick with minor CPU utilization. But the shell, is spawning hundreds of them, one after another (much like shell scripts do). -#### What does Netdata report? +### What does Netdata report? The total CPU utilization of the system:  -<br/>_**Figure 1**: The system overview section at Netdata, just a few seconds after the command was run_ +<br/>***Figure 1**: The system overview section at Netdata, just a few seconds after the command was run* And at the applications `apps.plugin` breaks down CPU usage per application:  -<br/>_**Figure 2**: The Applications section at Netdata, just a few seconds after the command was run_ +<br/>***Figure 2**: The Applications section at Netdata, just a few seconds after the command was run* So, the `ssh` session is using 95% CPU time. @@ -372,4 +370,4 @@ if you sum the CPU utilization of all processes, you might have more CPU time th total cpu time of the system. Netdata solves this, by adapting the per process cpu utilization to the total of the system. [Netdata adds charts that document this normalization](https://london.my-netdata.io/default.html#menu_netdata_submenu_apps_plugin). -[]() +[](<>) |