summaryrefslogtreecommitdiffstats
path: root/collectors/apps.plugin/integrations/users.md
blob: f325f05f683d473988491cf4f4323f6e313485fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/integrations/users.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/apps.plugin/metadata.yaml"
sidebar_label: "Users"
learn_status: "Published"
learn_rel_path: "Data Collection/Processes and System Services"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# Users


<img src="https://netdata.cloud/img/users.svg" width="150"/>


Plugin: apps.plugin
Module: users

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

This integration monitors resource utilization on a user context.



This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.


### Default Behavior

#### Auto-Detection

This integration doesn't support auto-detection.

#### Limits

The default configuration for this integration does not impose any limits on data collection.

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.


## Metrics

Metrics grouped by *scope*.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.



### Per user

These metrics refer to the user.

Labels:

| Label      | Description     |
|:-----------|:----------------|
| user | The name of the user. |

Metrics:

| Metric | Dimensions | Unit |
|:------|:----------|:----|
| user.cpu_utilization | user, system | percentage |
| user.cpu_guest_utilization | guest | percentage |
| user.cpu_context_switches | voluntary, involuntary | switches/s |
| user.mem_usage | rss | MiB |
| user.mem_private_usage | mem | MiB |
| user.vmem_usage | vmem | MiB |
| user.mem_page_faults | minor, major | pgfaults/s |
| user.swap_usage | swap | MiB |
| user.disk_physical_io | reads, writes | KiB/s |
| user.disk_logical_io | reads, writes | KiB/s |
| user.processes | processes | processes |
| user.threads | threads | threads |
| user.fds_open_limit | limit | percentage |
| user.fds_open | files, sockets, pipes, inotifies, event, timer, signal, eventpolls, other | fds |
| user.uptime | uptime | seconds |
| user.uptime_summary | min, avg, max | seconds |



## Alerts

There are no alerts configured by default for this integration.


## Setup

### Prerequisites

No action required.

### Configuration

#### File

There is no configuration file.
#### Options



There are no configuration options.

#### Examples
There are no configuration examples.