| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/apps.plugin/integrations/users.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/apps.plugin/metadata.yaml" |
| 4 | sidebar_label: "Users" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Operating Systems" |
| 7 | keywords: ['users', 'processes', 'os', 'host monitoring'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # Users |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/users.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: apps.plugin |
| 18 | Module: users |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | This integration monitors resource utilization on a user context. |
| 25 | |
| 26 | |
| 27 | |
| 28 | This collector is supported on all platforms. |
| 29 | |
| 30 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 31 | |
| 32 | |
| 33 | ### Default Behavior |
| 34 | |
| 35 | #### Auto-Detection |
| 36 | |
| 37 | This integration doesn't support auto-detection. |
| 38 | |
| 39 | #### Limits |
| 40 | |
| 41 | The default configuration for this integration does not impose any limits on data collection. |
| 42 | |
| 43 | #### Performance Impact |
| 44 | |
| 45 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 46 | |
| 47 | ## Setup |
| 48 | |
| 49 | |
| 50 | ### Prerequisites |
| 51 | |
| 52 | No action required. |
| 53 | |
| 54 | ### Configuration |
| 55 | |
| 56 | #### Options |
| 57 | |
| 58 | |
| 59 | |
| 60 | There are no configuration options. |
| 61 | |
| 62 | |
| 63 | |
| 64 | #### via File |
| 65 | |
| 66 | There is no configuration file. |
| 67 | |
| 68 | ##### Examples |
| 69 | There are no configuration examples. |
| 70 | |
| 71 | |
| 72 | |
| 73 | ## Alerts |
| 74 | |
| 75 | There are no alerts configured by default for this integration. |
| 76 | |
| 77 | |
| 78 | ## Metrics |
| 79 | |
| 80 | Metrics grouped by *scope*. |
| 81 | |
| 82 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 83 | |
| 84 | |
| 85 | |
| 86 | ### Per user |
| 87 | |
| 88 | These metrics refer to the user. |
| 89 | |
| 90 | Labels: |
| 91 | |
| 92 | | Label | Description | |
| 93 | |:-----------|:----------------| |
| 94 | | user | The name of the user. | |
| 95 | |
| 96 | Metrics: |
| 97 | |
| 98 | | Metric | Dimensions | Unit | |
| 99 | |:------|:----------|:----| |
| 100 | | user.cpu_utilization | user, system | percentage | |
| 101 | | user.cpu_guest_utilization | guest | percentage | |
| 102 | | user.cpu_context_switches | voluntary, involuntary | switches/s | |
| 103 | | user.estimated_mem_usage | mem | MiB | |
| 104 | | user.mem_usage | rss | MiB | |
| 105 | | user.mem_private_usage | mem | MiB | |
| 106 | | user.vmem_usage | vmem | MiB | |
| 107 | | user.mem_page_faults | minor, major | pgfaults/s | |
| 108 | | user.swap_usage | swap | MiB | |
| 109 | | user.disk_physical_io | reads, writes | KiB/s | |
| 110 | | user.disk_logical_io | reads, writes | KiB/s | |
| 111 | | user.processes | processes | processes | |
| 112 | | user.threads | threads | threads | |
| 113 | | user.fds_open_limit | limit | percentage | |
| 114 | | user.fds_open | files, sockets, pipes, inotifies, event, timer, signal, eventpolls, other | fds | |
| 115 | | user.uptime | uptime | seconds | |
| 116 | | user.uptime_summary | min, avg, max | seconds | |
| 117 | |
| 118 |