-
Notifications
You must be signed in to change notification settings - Fork 27
Expand file tree
/
Copy pathconfig.xsd
More file actions
367 lines (360 loc) · 12 KB
/
config.xsd
File metadata and controls
367 lines (360 loc) · 12 KB
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:element name="jmxpoller">
<xs:annotation>
<xs:documentation>
Root element of the configuration file.
This configuration file is where you specify local and remote JMX
servers to connect to across
your enterprise and extract whatever MBean attributes you have declared
to query.
The result will then be written to STDOUT for SPLUNK indexing.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" ref="formatter" />
<xs:element minOccurs="0" maxOccurs="1" ref="transport" />
<xs:element minOccurs="0" maxOccurs="unbounded" ref="cluster" />
<xs:element minOccurs="0" maxOccurs="unbounded" ref="jmxserver" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="formatter">
<xs:annotation>
<xs:documentation>Custom formatter declaration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="param" />
</xs:sequence>
<xs:attribute name="className" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Fully qualified Java class name of the formatter
implementation, implements the
com.dtdsoftware.splunk.formatter.Formatter interface
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="transport">
<xs:annotation>
<xs:documentation>Custom transport declaration</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="param" />
</xs:sequence>
<xs:attribute name="className" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Fully qualified Java class name of the transport
implementation, implements the
com.dtdsoftware.splunk.transport.Transport interface
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="cluster">
<xs:annotation>
<xs:documentation>
For JVMs with the same MBeans, you can group them
under this element so
you only have to declare the common beans to
query once.
You can still declare additional mbeans specfic to each
jmxserver
within the jmxserver elements.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="mbean" />
<xs:element maxOccurs="unbounded" ref="jmxserver" />
</xs:sequence>
<xs:attribute name="name" type="xs:string">
<xs:annotation>
<xs:documentation>Name for this cluster</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="description" type="xs:string">
<xs:annotation>
<xs:documentation>Description of this cluster</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="jmxserver">
<xs:annotation>
<xs:documentation>A local or remote JMX Server to connect to
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="mbean" />
</xs:sequence>
<xs:attribute name="host" type="xs:string">
<xs:annotation>
<xs:documentation>IP Address, Hostname or DNS Alias.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="jmxpass" type="xs:string">
<xs:annotation>
<xs:documentation>JMX Password
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="jmxport" type="xs:integer">
<xs:annotation>
<xs:documentation>JMX Port
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="jmxuser" type="xs:string">
<xs:annotation>
<xs:documentation>JMX Username
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="protocol">
<xs:annotation>
<xs:documentation>
The service protocol to use.Will default to "rmi".
Note : the "local", "soap", "hessian" and "burlap" protocols require MX4J to be used as the JMX
implementation at both the client and server endss of the connection.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="rmi" />
<xs:enumeration value="iiop" />
<xs:enumeration value="local" />
<xs:enumeration value="soap" />
<xs:enumeration value="hessian" />
<xs:enumeration value="burlap" />
<xs:enumeration value="soap+ssl" />
<xs:enumeration value="hessian+ssl" />
<xs:enumeration value="burlap+ssl" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="lookupPath" type="xs:string">
<xs:annotation>
<xs:documentation>The url path of the service.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stubSource">
<xs:annotation>
<xs:documentation>The source of the remote stub.Will default to "jndi"</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="jndi" />
<xs:enumeration value="stub" />
<xs:enumeration value="ior" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="encodedStub" type="xs:string">
<xs:annotation>
<xs:documentation>Base64 encoded stub value for stubSource types of "ior" and "stub"
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="jmxServiceURL" type="xs:string">
<xs:annotation>
<xs:documentation>
A raw jmx service url in format "service:jmx:protocol:sap"
ie: service:jmx:rmi:///jndi/rmi://myhost:9909/jmxrmi
If set will take precedence over other parameters
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="jvmDescription" type="xs:string">
<xs:annotation>
<xs:documentation>A description of this JVM
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="pid" type="xs:integer">
<xs:annotation>
<xs:documentation>Process ID for attaching directly to a locally
running JVM
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="pidFile" type="xs:string">
<xs:annotation>
<xs:documentation>File containing the Process ID for attaching
directly to a locally running JVM.The only file contents should
be the PID on the first line of the file.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="pidCommand" type="xs:string">
<xs:annotation>
<xs:documentation>Command/Script that outputs to STDOUT the Process ID for
attaching directly to a locally running JVM
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="mbean">
<xs:annotation>
<xs:documentation>
An MBean to query
Standard JMX object name wildcard
patterns * and ? are supported
If no values are specified for the
"domain" and "properties"
attributes , the value will default to the
* wildcard
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="1" ref="notificationListener" />
<xs:element minOccurs="0" maxOccurs="unbounded" ref="operation" />
<xs:element minOccurs="0" maxOccurs="unbounded" ref="attribute" />
</xs:sequence>
<xs:attribute name="domain" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>The MBean domain</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="properties" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>The MBean properties string in
"key=value,key2=value2" format</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="dumpAllAttributes" type="xs:boolean">
<xs:annotation>
<xs:documentation>If set to true will dump all of the attributes of the mbean.
Use as an alternative to explicitly declaring each individual attribute to extract.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="notificationListener">
<xs:annotation>
<xs:documentation>An MBean notification listener</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="filterImplementationClass" type="xs:string">
<xs:annotation>
<xs:documentation>
The canonical name of a class implementing the javax.management.NotificationFilter interface
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="operation">
<xs:annotation>
<xs:documentation>An MBean operation</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="parameter" />
</xs:sequence>
<xs:attribute name="name" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
The operation name.
For overloaded operations, the operation signature is inferred from the paramaters list.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="outputname" type="xs:string">
<xs:annotation>
<xs:documentation>The operation result key that is output to STDOUT for
SPLUNK indexing.Optional, some operations may not return values.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="parameter">
<xs:annotation>
<xs:documentation>An MBean operation parameter</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="value" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
The parameter value
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" use="required">
<xs:annotation>
<xs:documentation>The parameter type</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="int" />
<xs:enumeration value="byte" />
<xs:enumeration value="short" />
<xs:enumeration value="long" />
<xs:enumeration value="float" />
<xs:enumeration value="double" />
<xs:enumeration value="boolean" />
<xs:enumeration value="char" />
<xs:enumeration value="string" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="attribute">
<xs:annotation>
<xs:documentation>An MBean attribute</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="name" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
The attribute name
For attributes that are multi
level ie: composite and tabular
attributes , then you can use a ":"
delimited notation for
specifying the attribute name.
ie:
foo:goo:myattribute
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="outputname" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>The attribute key that is output to STDOUT for
SPLUNK indexing</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="param">
<xs:annotation>
<xs:documentation xml:lang="en">parameters for a ParameterizedConfig object</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="name" use="required" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">parameter name
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" use="required" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">parameter value
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>