@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
md 144 lines 3.74 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/kern.cp_time.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml"
4 sidebar_label: "kern.cp_time"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Operating Systems"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # kern.cp_time
11
12
13 <img src="https://netdata.cloud/img/freebsd.svg" width="150"/>
14
15
16 Plugin: freebsd.plugin
17 Module: kern.cp_time
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Total CPU utilization
24
25 The plugin calls `sysctl` function to collect necessary data.
26
27 This collector is supported on all platforms.
28
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30
31
32 ### Default Behavior
33
34 #### Auto-Detection
35
36 This integration doesn't support auto-detection.
37
38 #### Limits
39
40 The default configuration for this integration does not impose any limits on data collection.
41
42 #### Performance Impact
43
44 The default configuration for this integration is not expected to impose a significant performance impact on the system.
45
46 ## Setup
47
48
49 ### Prerequisites
50
51 No action required.
52
53 ### Configuration
54
55 #### Options
56
57 The netdata main configuration file.
58
59 <details open><summary>Config options</summary>
60
61
62
63 | Option | Description | Default | Required |
64 |:-----|:------------|:--------|:---------:|
65 | kern.cp_time | Enable or disable Total CPU usage. | yes | no |
66
67
68 </details>
69
70
71
72 #### via File
73
74 The configuration file name for this integration is `netdata.conf`.
75
76 The file format is a modified INI syntax. The general structure is:
77
78 ```ini
79 [section1]
80 option1 = some value
81 option2 = some other value
82
83 [section2]
84 option3 = some third value
85 ```
86 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
87 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
88
89 ```bash
90 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
91 sudo ./edit-config netdata.conf
92 ```
93
94 ##### Examples
95 There are no configuration examples.
96
97
98
99 ## Alerts
100
101
102 The following alerts are available:
103
104 | Alert name | On metric | Description |
105 |:------------|:----------|:------------|
106 | [ 10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cpu.conf) | system.cpu | average CPU utilization over the last 10 minutes (excluding iowait, nice and steal) |
107 | [ 10min_cpu_iowait ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cpu.conf) | system.cpu | average CPU iowait time over the last 10 minutes |
108 | [ 20min_steal_cpu ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cpu.conf) | system.cpu | average CPU steal time over the last 20 minutes |
109 | [ 10min_cpu_usage ](https://github.com/netdata/netdata/blob/master/src/health/health.d/cpu.conf) | system.cpu | average CPU utilization over the last 10 minutes (excluding nice) |
110
111
112 ## Metrics
113
114 Metrics grouped by *scope*.
115
116 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
117
118
119
120 ### Per kern.cp_time instance
121
122 These metrics show CPU usage statistics.
123
124 This scope has no labels.
125
126 Metrics:
127
128 | Metric | Dimensions | Unit |
129 |:------|:----------|:----|
130 | system.cpu | nice, system, user, interrupt, idle | percentage |
131
132 ### Per core
133
134
135
136 This scope has no labels.
137
138 Metrics:
139
140 | Metric | Dimensions | Unit |
141 |:------|:----------|:----|
142 | cpu.cpu | nice, system, user, interrupt, idle | percentage |
143
144