| 1 | # Generated metadata.yaml for websphere_mp module |
| 2 | plugin_name: ibm.d.plugin |
| 3 | modules: |
| 4 | - meta: |
| 5 | plugin_name: ibm.d.plugin |
| 6 | module_name: websphere_mp |
| 7 | monitored_instance: |
| 8 | name: IBM WebSphere MicroProfile |
| 9 | link: https://www.ibm.com/products/websphere-application-server |
| 10 | categories: |
| 11 | - data-collection.applications |
| 12 | icon_filename: "ibm.svg" |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | info_provided_to_referring_integrations: |
| 17 | description: "" |
| 18 | keywords: |
| 19 | - websphere_mp |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | Collects JVM, vendor, and REST endpoint metrics from WebSphere Liberty / Open Liberty |
| 24 | servers via the MicroProfile Metrics (Prometheus/OpenMetrics) endpoint. |
| 25 | |
| 26 | method_description: | |
| 27 | The collector connects to IBM WebSphere MicroProfile 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 MicroProfile monitoring interface is accessible. |
| 47 | configuration: |
| 48 | file: |
| 49 | name: ibm.d/websphere_mp.conf |
| 50 | options: |
| 51 | description: | |
| 52 | Configuration options for the websphere_mp 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: global |
| 88 | description: These metrics refer to the entire monitored instance. |
| 89 | labels: [] |
| 90 | metrics: |
| 91 | - name: websphere_mp.cpu_usage |
| 92 | description: JVM CPU Usage |
| 93 | unit: percentage |
| 94 | chart_type: line |
| 95 | dimensions: |
| 96 | - name: process |
| 97 | - name: utilization |
| 98 | - name: websphere_mp.cpu_time |
| 99 | description: JVM CPU Time |
| 100 | unit: seconds |
| 101 | chart_type: line |
| 102 | dimensions: |
| 103 | - name: total |
| 104 | - name: global |
| 105 | description: These metrics refer to the entire monitored instance. |
| 106 | labels: [] |
| 107 | metrics: |
| 108 | - name: websphere_mp.jvm_memory_heap_usage |
| 109 | description: JVM Heap Memory Usage |
| 110 | unit: bytes |
| 111 | chart_type: stacked |
| 112 | dimensions: |
| 113 | - name: used |
| 114 | - name: free |
| 115 | - name: websphere_mp.jvm_memory_heap_committed |
| 116 | description: JVM Heap Memory Committed |
| 117 | unit: bytes |
| 118 | chart_type: line |
| 119 | dimensions: |
| 120 | - name: committed |
| 121 | - name: websphere_mp.jvm_memory_heap_max |
| 122 | description: JVM Heap Memory Maximum |
| 123 | unit: bytes |
| 124 | chart_type: line |
| 125 | dimensions: |
| 126 | - name: limit |
| 127 | - name: websphere_mp.jvm_heap_utilization |
| 128 | description: JVM Heap Utilization |
| 129 | unit: percentage |
| 130 | chart_type: line |
| 131 | dimensions: |
| 132 | - name: utilization |
| 133 | - name: websphere_mp.jvm_gc_collections |
| 134 | description: JVM Garbage Collection Rate |
| 135 | unit: collections/s |
| 136 | chart_type: line |
| 137 | dimensions: |
| 138 | - name: rate |
| 139 | - name: websphere_mp.jvm_gc_time |
| 140 | description: JVM GC Time |
| 141 | unit: milliseconds |
| 142 | chart_type: line |
| 143 | dimensions: |
| 144 | - name: total |
| 145 | - name: per_cycle |
| 146 | - name: websphere_mp.jvm_threads_current |
| 147 | description: JVM Current Threads |
| 148 | unit: threads |
| 149 | chart_type: stacked |
| 150 | dimensions: |
| 151 | - name: daemon |
| 152 | - name: other |
| 153 | - name: websphere_mp.jvm_threads_peak |
| 154 | description: JVM Peak Threads |
| 155 | unit: threads |
| 156 | chart_type: line |
| 157 | dimensions: |
| 158 | - name: peak |
| 159 | - name: restendpoint |
| 160 | description: These metrics refer to restendpoint instances. |
| 161 | labels: |
| 162 | - name: method |
| 163 | description: Method identifier |
| 164 | - name: endpoint |
| 165 | description: Endpoint identifier |
| 166 | metrics: |
| 167 | - name: websphere_mp.rest_requests |
| 168 | description: REST Request Rate |
| 169 | unit: requests/s |
| 170 | chart_type: line |
| 171 | dimensions: |
| 172 | - name: requests |
| 173 | - name: websphere_mp.rest_response_time |
| 174 | description: REST Response Time |
| 175 | unit: milliseconds |
| 176 | chart_type: line |
| 177 | dimensions: |
| 178 | - name: average |
| 179 | - name: global |
| 180 | description: These metrics refer to the entire monitored instance. |
| 181 | labels: [] |
| 182 | metrics: |
| 183 | - name: websphere_mp.threadpool_usage |
| 184 | description: Thread Pool Usage |
| 185 | unit: threads |
| 186 | chart_type: stacked |
| 187 | dimensions: |
| 188 | - name: active |
| 189 | - name: idle |
| 190 | - name: websphere_mp.threadpool_size |
| 191 | description: Thread Pool Size |
| 192 | unit: threads |
| 193 | chart_type: line |
| 194 | dimensions: |
| 195 | - name: size |