You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: plugins/inputs/win_perf_counters/README.md
+31-7
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,30 @@ as counters used when performance monitoring
18
18
This file is likely to be updated in the future with more examples for
19
19
useful configurations for separate scenarios.
20
20
21
+
### Plugin wide
22
+
23
+
Plugin wide entries are underneath `[[inputs.win_perf_counters]]`.
24
+
25
+
#### PrintValid
26
+
27
+
Bool, if set to `true` will print out all matching performance objects.
28
+
29
+
Example:
30
+
`PrintValid=true`
31
+
32
+
#### PreVistaSupport
33
+
34
+
Bool, if set to `true` will use the localized PerfCounter interface that is present before Vista for backwards compatability.
35
+
36
+
It is recommended NOT to use this on OSes starting with Vista and newer because it requires more configuration to use this than the newer interface present since Vista.
37
+
38
+
Example for Windows Server 2003, this would be set to true:
39
+
`PreVistaSupport=true`
40
+
41
+
### Object
42
+
43
+
See Entry below.
44
+
21
45
### Entry
22
46
A new configuration entry consists of the TOML header to start with,
23
47
`[[inputs.win_perf_counters.object]]`.
@@ -26,14 +50,14 @@ beneath the main win_perf_counters entry, `[[inputs.win_perf_counters]]`.
26
50
27
51
Following this is 3 required key/value pairs and the three optional parameters and their usage.
28
52
29
-
### ObjectName
53
+
####ObjectName
30
54
**Required**
31
55
32
56
ObjectName is the Object to query for, like Processor, DirectoryServices, LogicalDisk or similar.
33
57
34
58
Example: `ObjectName = "LogicalDisk"`
35
59
36
-
### Instances
60
+
####Instances
37
61
**Required**
38
62
39
63
Instances (this is an array) is the instances of a counter you would like returned,
@@ -49,7 +73,7 @@ Some Objects does not have instances to select from at all,
49
73
here only one option is valid if you want data back,
50
74
and that is to specify `Instances = ["------"]`.
51
75
52
-
### Counters
76
+
####Counters
53
77
**Required**
54
78
55
79
Counters (this is an array) is the counters of the ObjectName
@@ -59,7 +83,7 @@ Example: `Counters = ["% Idle Time", "% Disk Read Time", "% Disk Write Time"]`
59
83
This must be specified for every counter you want the results of,
60
84
it is not possible to ask for all counters in the ObjectName.
61
85
62
-
### Measurement
86
+
####Measurement
63
87
*Optional*
64
88
65
89
This key is optional, if it is not set it will be win_perf_counters.
@@ -70,7 +94,7 @@ separate from Processor results.
70
94
71
95
Example: `Measurement = "win_disk"
72
96
73
-
### IncludeTotal
97
+
####IncludeTotal
74
98
*Optional*
75
99
76
100
This key is optional, it is a simple bool.
@@ -80,7 +104,7 @@ and you would also like all instances containg _Total returned,
80
104
like "_Total", "0,_Total" and so on where applicable
81
105
(Processor Information is one example).
82
106
83
-
### WarnOnMissing
107
+
####WarnOnMissing
84
108
*Optional*
85
109
86
110
This key is optional, it is a simple bool.
@@ -89,7 +113,7 @@ This only has an effect on the first execution of the plugin,
89
113
it will print out any ObjectName/Instance/Counter combinations
90
114
asked for that does not match. Useful when debugging new configurations.
91
115
92
-
### FailOnMissing
116
+
####FailOnMissing
93
117
*Internal*
94
118
95
119
This key should not be used, it is for testing purposes only.
0 commit comments