| 1 | # Generated metadata.yaml for websphere_jmx module |
| 2 | plugin_name: ibm.d.plugin |
| 3 | modules: |
| 4 | - meta: |
| 5 | plugin_name: ibm.d.plugin |
| 6 | module_name: websphere_jmx |
| 7 | monitored_instance: |
| 8 | name: IBM WebSphere JMX |
| 9 | link: https://www.ibm.com/products/websphere-application-server |
| 10 | categories: |
| 11 | - data-collection.applications |
| 12 | icon_filename: "" |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | info_provided_to_referring_integrations: |
| 17 | description: "" |
| 18 | keywords: |
| 19 | - websphere_jmx |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | Collects JVM, thread pool, and middleware metrics from IBM WebSphere Application Server |
| 24 | via the embedded JMX bridge helper. |
| 25 | |
| 26 | method_description: | |
| 27 | The collector connects to IBM WebSphere JMX and collects metrics via its monitoring interface. |
| 28 | supported_platforms: |
| 29 | include: [] |
| 30 | exclude: [] |
| 31 | multi_instance: true |
| 32 | additional_permissions: |
| 33 | description: "" |
| 34 | default_behavior: |
| 35 | auto_detection: |
| 36 | description: "" |
| 37 | limits: |
| 38 | description: "" |
| 39 | performance_impact: |
| 40 | description: "" |
| 41 | setup: |
| 42 | prerequisites: |
| 43 | list: |
| 44 | - title: Enable monitoring interface |
| 45 | description: | |
| 46 | Ensure the IBM WebSphere JMX monitoring interface is accessible. |
| 47 | configuration: |
| 48 | file: |
| 49 | name: ibm.d/websphere_jmx.conf |
| 50 | options: |
| 51 | description: | |
| 52 | Configuration options for the websphere_jmx collector. |
| 53 | folding: |
| 54 | title: Config options |
| 55 | enabled: true |
| 56 | list: |
| 57 | - name: update_every |
| 58 | description: Data collection frequency. |
| 59 | default_value: 1 |
| 60 | required: false |
| 61 | - name: endpoint |
| 62 | description: Connection endpoint. |
| 63 | default_value: "dummy://localhost" |
| 64 | required: false |
| 65 | examples: |
| 66 | folding: |
| 67 | enabled: true |
| 68 | title: Config |
| 69 | list: |
| 70 | - name: Basic |
| 71 | description: Basic configuration example. |
| 72 | config: | |
| 73 | jobs: |
| 74 | - name: local |
| 75 | endpoint: dummy://localhost |
| 76 | troubleshooting: |
| 77 | problems: |
| 78 | list: [] |
| 79 | alerts: [] |
| 80 | metrics: |
| 81 | folding: |
| 82 | title: Metrics |
| 83 | enabled: false |
| 84 | description: "" |
| 85 | availability: [] |
| 86 | scopes: |
| 87 | - name: applications |
| 88 | description: These metrics refer to applications instances. |
| 89 | labels: |
| 90 | - name: application |
| 91 | description: Application identifier |
| 92 | - name: module |
| 93 | description: Module identifier |
| 94 | metrics: |
| 95 | - name: websphere_jmx.app_requests |
| 96 | description: Application Requests |
| 97 | unit: requests |
| 98 | chart_type: line |
| 99 | dimensions: |
| 100 | - name: requests |
| 101 | - name: websphere_jmx.app_response_time |
| 102 | description: Application Response Time |
| 103 | unit: milliseconds |
| 104 | chart_type: line |
| 105 | dimensions: |
| 106 | - name: response_time |
| 107 | - name: websphere_jmx.app_sessions_active |
| 108 | description: Active Sessions |
| 109 | unit: sessions |
| 110 | chart_type: line |
| 111 | dimensions: |
| 112 | - name: active |
| 113 | - name: websphere_jmx.app_sessions_live |
| 114 | description: Live Sessions |
| 115 | unit: sessions |
| 116 | chart_type: line |
| 117 | dimensions: |
| 118 | - name: live |
| 119 | - name: websphere_jmx.app_session_events |
| 120 | description: Session Events |
| 121 | unit: sessions |
| 122 | chart_type: stacked |
| 123 | dimensions: |
| 124 | - name: creates |
| 125 | - name: invalidates |
| 126 | - name: websphere_jmx.app_transactions |
| 127 | description: Application Transactions |
| 128 | unit: transactions |
| 129 | chart_type: line |
| 130 | dimensions: |
| 131 | - name: committed |
| 132 | - name: rolledback |
| 133 | - name: jca |
| 134 | description: These metrics refer to jca instances. |
| 135 | labels: |
| 136 | - name: pool |
| 137 | description: Pool identifier |
| 138 | metrics: |
| 139 | - name: websphere_jmx.jca_pool_size |
| 140 | description: JCA Pool Size |
| 141 | unit: connections |
| 142 | chart_type: line |
| 143 | dimensions: |
| 144 | - name: size |
| 145 | - name: websphere_jmx.jca_pool_usage |
| 146 | description: JCA Pool Usage |
| 147 | unit: connections |
| 148 | chart_type: stacked |
| 149 | dimensions: |
| 150 | - name: active |
| 151 | - name: free |
| 152 | - name: websphere_jmx.jca_pool_wait_time |
| 153 | description: JCA Average Wait Time |
| 154 | unit: milliseconds |
| 155 | chart_type: line |
| 156 | dimensions: |
| 157 | - name: wait |
| 158 | - name: websphere_jmx.jca_pool_use_time |
| 159 | description: JCA Average Use Time |
| 160 | unit: milliseconds |
| 161 | chart_type: line |
| 162 | dimensions: |
| 163 | - name: use |
| 164 | - name: websphere_jmx.jca_pool_connections |
| 165 | description: JCA Connections Totals |
| 166 | unit: connections |
| 167 | chart_type: line |
| 168 | dimensions: |
| 169 | - name: created |
| 170 | - name: destroyed |
| 171 | - name: websphere_jmx.jca_pool_waiting_threads |
| 172 | description: JCA Waiting Threads |
| 173 | unit: threads |
| 174 | chart_type: line |
| 175 | dimensions: |
| 176 | - name: waiting |
| 177 | - name: jdbc |
| 178 | description: These metrics refer to jdbc instances. |
| 179 | labels: |
| 180 | - name: pool |
| 181 | description: Pool identifier |
| 182 | metrics: |
| 183 | - name: websphere_jmx.jdbc_pool_size |
| 184 | description: JDBC Pool Size |
| 185 | unit: connections |
| 186 | chart_type: line |
| 187 | dimensions: |
| 188 | - name: size |
| 189 | - name: websphere_jmx.jdbc_pool_usage |
| 190 | description: JDBC Pool Usage |
| 191 | unit: connections |
| 192 | chart_type: stacked |
| 193 | dimensions: |
| 194 | - name: active |
| 195 | - name: free |
| 196 | - name: websphere_jmx.jdbc_pool_wait_time |
| 197 | description: JDBC Average Wait Time |
| 198 | unit: milliseconds |
| 199 | chart_type: line |
| 200 | dimensions: |
| 201 | - name: wait |
| 202 | - name: websphere_jmx.jdbc_pool_use_time |
| 203 | description: JDBC Average Use Time |
| 204 | unit: milliseconds |
| 205 | chart_type: line |
| 206 | dimensions: |
| 207 | - name: use |
| 208 | - name: websphere_jmx.jdbc_pool_connections |
| 209 | description: JDBC Connections Totals |
| 210 | unit: connections |
| 211 | chart_type: line |
| 212 | dimensions: |
| 213 | - name: created |
| 214 | - name: destroyed |
| 215 | - name: websphere_jmx.jdbc_pool_waiting_threads |
| 216 | description: JDBC Waiting Threads |
| 217 | unit: threads |
| 218 | chart_type: line |
| 219 | dimensions: |
| 220 | - name: waiting |
| 221 | - name: jms |
| 222 | description: These metrics refer to jms instances. |
| 223 | labels: |
| 224 | - name: destination |
| 225 | description: Destination identifier |
| 226 | - name: destination_type |
| 227 | description: Destination_type identifier |
| 228 | metrics: |
| 229 | - name: websphere_jmx.jms_messages_current |
| 230 | description: JMS Messages Current Depth |
| 231 | unit: messages |
| 232 | chart_type: line |
| 233 | dimensions: |
| 234 | - name: current |
| 235 | - name: websphere_jmx.jms_messages_pending |
| 236 | description: JMS Messages Pending |
| 237 | unit: messages |
| 238 | chart_type: line |
| 239 | dimensions: |
| 240 | - name: pending |
| 241 | - name: websphere_jmx.jms_messages_total |
| 242 | description: JMS Messages Added Total |
| 243 | unit: messages |
| 244 | chart_type: line |
| 245 | dimensions: |
| 246 | - name: total |
| 247 | - name: websphere_jmx.jms_consumers |
| 248 | description: JMS Consumers |
| 249 | unit: consumers |
| 250 | chart_type: line |
| 251 | dimensions: |
| 252 | - name: consumers |
| 253 | - name: global |
| 254 | description: These metrics refer to the entire monitored instance. |
| 255 | labels: [] |
| 256 | metrics: |
| 257 | - name: websphere_jmx.jvm_heap_memory |
| 258 | description: JVM Heap Memory |
| 259 | unit: bytes |
| 260 | chart_type: stacked |
| 261 | dimensions: |
| 262 | - name: used |
| 263 | - name: committed |
| 264 | - name: max |
| 265 | - name: websphere_jmx.jvm_heap_usage |
| 266 | description: JVM Heap Usage |
| 267 | unit: percentage |
| 268 | chart_type: line |
| 269 | dimensions: |
| 270 | - name: usage |
| 271 | - name: websphere_jmx.jvm_nonheap_memory |
| 272 | description: JVM Non-Heap Memory |
| 273 | unit: bytes |
| 274 | chart_type: stacked |
| 275 | dimensions: |
| 276 | - name: used |
| 277 | - name: committed |
| 278 | - name: websphere_jmx.jvm_gc_count |
| 279 | description: JVM Garbage Collection Count |
| 280 | unit: collections |
| 281 | chart_type: line |
| 282 | dimensions: |
| 283 | - name: collections |
| 284 | - name: websphere_jmx.jvm_gc_time |
| 285 | description: JVM Garbage Collection Time |
| 286 | unit: milliseconds |
| 287 | chart_type: line |
| 288 | dimensions: |
| 289 | - name: time |
| 290 | - name: websphere_jmx.jvm_threads |
| 291 | description: JVM Threads |
| 292 | unit: threads |
| 293 | chart_type: stacked |
| 294 | dimensions: |
| 295 | - name: total |
| 296 | - name: daemon |
| 297 | - name: websphere_jmx.jvm_thread_states |
| 298 | description: JVM Thread States |
| 299 | unit: threads |
| 300 | chart_type: line |
| 301 | dimensions: |
| 302 | - name: peak |
| 303 | - name: started |
| 304 | - name: websphere_jmx.jvm_classes |
| 305 | description: JVM Classes |
| 306 | unit: classes |
| 307 | chart_type: line |
| 308 | dimensions: |
| 309 | - name: loaded |
| 310 | - name: unloaded |
| 311 | - name: websphere_jmx.jvm_process_cpu_usage |
| 312 | description: JVM Process CPU Usage |
| 313 | unit: percentage |
| 314 | chart_type: line |
| 315 | dimensions: |
| 316 | - name: cpu |
| 317 | - name: websphere_jmx.jvm_uptime |
| 318 | description: JVM Uptime |
| 319 | unit: seconds |
| 320 | chart_type: line |
| 321 | dimensions: |
| 322 | - name: uptime |
| 323 | - name: threadpools |
| 324 | description: These metrics refer to threadpools instances. |
| 325 | labels: |
| 326 | - name: pool |
| 327 | description: Pool identifier |
| 328 | metrics: |
| 329 | - name: websphere_jmx.threadpool_size |
| 330 | description: Thread Pool Size |
| 331 | unit: threads |
| 332 | chart_type: line |
| 333 | dimensions: |
| 334 | - name: size |
| 335 | - name: max |
| 336 | - name: websphere_jmx.threadpool_active |
| 337 | description: Thread Pool Active Threads |
| 338 | unit: threads |
| 339 | chart_type: line |
| 340 | dimensions: |
| 341 | - name: active |