Skip to content

Commit b9890b1

Browse files
shiroushirou
committed
[doc]: Update README for supported metrics.
1 parent 90efec0 commit b9890b1

File tree

1 file changed

+52
-66
lines changed

1 file changed

+52
-66
lines changed

‎README.md

+52-66
Original file line numberDiff line numberDiff line change
@@ -70,29 +70,16 @@ The output is below.
7070
Total: 3179569152, Free:284233728, UsedPercent:84.508194%
7171
{"total":3179569152,"available":492572672,"used":2895335424,"usedPercent":84.50819439828305, (snip...)}
7272

73-
You can set an alternative location to `/proc` by setting the `HOST_PROC`
74-
environment variable.
73+
You can set alternative locations for various system directories by using the following environment variables:
7574

76-
You can set an alternative location to `/sys` by setting the `HOST_SYS`
77-
environment variable.
78-
79-
You can set an alternative location to `/etc` by setting the `HOST_ETC`
80-
environment variable.
81-
82-
You can set an alternative location to `/var` by setting the `HOST_VAR`
83-
environment variable.
84-
85-
You can set an alternative location to `/run` by setting the `HOST_RUN`
86-
environment variable.
87-
88-
You can set an alternative location to `/dev` by setting the `HOST_DEV`
89-
environment variable.
90-
91-
You can set an alternative location to `/` by setting the `HOST_ROOT`
92-
environment variable.
93-
94-
You can set an alternative location to `/proc/N/mountinfo` by setting the
95-
`HOST_PROC_MOUNTINFO` environment variable.
75+
- /proc: `HOST_PROC`
76+
- /sys: `HOST_SYS`
77+
- /etc: `HOST_ETC`
78+
- /var: `HOST_VAR`
79+
- /run: `HOST_RUN`
80+
- /dev: `HOST_DEV`
81+
- /: `HOST_ROOT`
82+
- /proc/N/mountinfo: `HOST_PROC_MOUNTINFO`
9683

9784
### Adding settings using `context` (from v3.23.6)
9885

@@ -207,20 +194,19 @@ Some code is ported from Ohai. Many thanks.
207194

208195
- x: works
209196
- b: almost works, but something is broken
210-
- c: works in CGO only
211197

212198
|name |Linux |FreeBSD |OpenBSD |macOS |Windows |Solaris |Plan 9 |AIX |
213199
|----------------------|-------|---------|---------|--------|---------|---------|---------|---------|
214200
|cpu\_times |x |x |x |x |x | |b |x |
215201
|cpu\_count |x |x |x |x |x | |x |x |
216202
|cpu\_percent |x |x |x |x |x | | |x |
217203
|cpu\_times\_percent |x |x |x |x |x | | |x |
218-
|virtual\_memory |x |x |x |x |x | b |x |x |
204+
|virtual\_memory |x |x |x |x |x |b |x |x |
219205
|swap\_memory |x |x |x |x | | |x |X |
220206
|disk\_partitions |x |x |x |x |x | | |x |
221-
|disk\_io\_counters |x |x |x | | | | | |
207+
|disk\_io\_counters |x |x |x |x |x | | | |
222208
|disk\_usage |x |x |x |x |x | | |x |
223-
|net\_io\_counters |x |x |x |b |x | | | |
209+
|net\_io\_counters |x |x |x |b |x |x | | |
224210
|boot\_time |x |x |x |x |x | | |X |
225211
|users |x |x |x |x |x | | |x |
226212
|pids |x |x |x |x |x | | | |
@@ -230,6 +216,7 @@ Some code is ported from Ohai. Many thanks.
230216
|net\_if\_addrs | | | | | | | |x |
231217
|net\_if\_stats | | | | | | | |x |
232218
|netfilter\_conntrack |x | | | | | | | |
219+
|sensors_temperature |x | | |x |x |x | | |
233220

234221

235222
### Process class
@@ -239,27 +226,26 @@ Some code is ported from Ohai. Many thanks.
239226
|pid |x |x |x |x |x |
240227
|ppid |x |x |x |x |x |
241228
|name |x |x |x |x |x |
242-
|cmdline |x |x | |x |x |
229+
|cmdline |x |x |x |x |x |
243230
|create\_time |x | | |x |x |
244231
|status |x |x |x |x | |
245-
|cwd |x | | |x |x |
232+
|cwd |x |x |x |x |x |
246233
|exe |x |x |x | |x |
247234
|uids |x |x |x |x | |
248235
|gids |x |x |x |x | |
249236
|terminal |x |x |x | | |
250237
|io\_counters |x |x |x | |x |
251238
|nice |x |x |x |x |x |
252-
|num\_fds |x | | | | |
239+
|num\_fds |x | | | |x |
253240
|num\_ctx\_switches |x | | | | |
254241
|num\_threads |x |x |x |x |x |
255242
|cpu\_times |x | | | |x |
256243
|memory\_info |x |x |x |x |x |
257-
|memory\_info\_ex |x | | | | |
258244
|memory\_maps |x | | | | |
259-
|open\_files |x | | | | |
245+
|open\_files |x | | | |x |
260246
|send\_signal |x |x |x |x | |
261-
|suspend |x |x |x |x | |
262-
|resume |x |x |x |x | |
247+
|suspend |x |x |x |x |x |
248+
|resume |x |x |x |x |x |
263249
|terminate |x |x |x |x |x |
264250
|kill |x |x |x |x | |
265251
|username |x |x |x |x |x |
@@ -276,39 +262,39 @@ Some code is ported from Ohai. Many thanks.
276262
|is\_running | | | | | |
277263
|page\_faults |x | | | | |
278264

279-
### Original Metrics
280-
281-
|item |Linux |FreeBSD |OpenBSD |macOS |Windows |Solaris |AIX |
282-
|-----------------|-------|---------|---------|--------|--------|---------|---------|
283-
|**HostInfo** | | | | | | | |
284-
|hostname |x |x |x |x |x |x |X |
285-
|uptime |x |x |x |x | |x |x |
286-
|process |x |x |x | | |x | |
287-
|os |x |x |x |x |x |x |x |
288-
|platform |x |x |x |x | |x |x |
289-
|platformfamily |x |x |x |x | |x |x |
290-
|virtualization |x | | | | | | |
291-
|**CPU** | | | | | | | |
292-
|VendorID |x |x |x |x |x |x |x |
293-
|Family |x |x |x |x |x |x |x |
294-
|Model |x |x |x |x |x |x |x |
295-
|Stepping |x |x |x |x |x |x | |
296-
|PhysicalID |x | | | | |x | |
297-
|CoreID |x | | | | |x | |
298-
|Cores |x | | | |x |x |x |
299-
|ModelName |x |x |x |x |x |x |x |
300-
|Microcode |x | | | | |x | |
301-
|**LoadAvg** | | | | | | | |
302-
|Load1 |x |x |x |x | | |x |
303-
|Load5 |x |x |x |x | | |x |
304-
|Load15 |x |x |x |x | | |x |
305-
|**GetDockerID** | | | | | | | |
306-
|container id |x |no |no |no |no | | |
307-
|**CgroupsCPU** | | | | | | | |
308-
|user |x |no |no |no |no | | |
309-
|system |x |no |no |no |no | | |
310-
|**CgroupsMem** | | | | | | | |
311-
|various |x |no |no |no |no | | |
265+
### gopsutil Original Metrics
266+
267+
|item |Linux |FreeBSD |OpenBSD |macOS |Windows |Solaris |AIX |
268+
|------------------------|-------|---------|---------|--------|--------|---------|---------|
269+
|**HostInfo** | | | | | | | |
270+
|hostname |x |x |x |x |x |x |X |
271+
|uptime |x |x |x |x | |x |x |
272+
|process |x |x |x | | |x | |
273+
|os |x |x |x |x |x |x |x |
274+
|platform |x |x |x |x | |x |x |
275+
|platformfamily |x |x |x |x | |x |x |
276+
|virtualization |x | | | | | | |
277+
|**CPU** | | | | | | | |
278+
|VendorID |x |x |x |x |x |x |x |
279+
|Family |x |x |x |x |x |x |x |
280+
|Model |x |x |x |x |x |x |x |
281+
|Stepping |x |x |x |x |x |x | |
282+
|PhysicalID |x | | | | |x | |
283+
|CoreID |x | | | | |x | |
284+
|Cores |x | | |x |x |x |x |
285+
|ModelName |x |x |x |x |x |x |x |
286+
|Microcode |x | | | | |x | |
287+
|**LoadAvg** | | | | | | | |
288+
|Load1 |x |x |x |x |x |x |x |
289+
|Load5 |x |x |x |x |x |x |x |
290+
|Load15 |x |x |x |x |x |x |x |
291+
|**Docker GetDockerID** | | | | | | | |
292+
|container id |x |no |no |no |no |no |no |
293+
|**Docker CgroupsCPU** | | | | | | | |
294+
|user |x |no |no |no |no |no |no |
295+
|system |x |no |no |no |no |no |no |
296+
|**Docker CgroupsMem** | | | | | | | |
297+
|various |x |no |no |no |no |no |no |
312298

313299
- future work
314300
- process_iter

0 commit comments

Comments
 (0)