github.com/netdata/go.d.plugin@v0.58.1/modules/rabbitmq/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-rabbitmq 5 plugin_name: go.d.plugin 6 module_name: rabbitmq 7 monitored_instance: 8 name: RabbitMQ 9 link: https://www.rabbitmq.com/ 10 icon_filename: rabbitmq.svg 11 categories: 12 - data-collection.message-brokers 13 keywords: 14 - rabbitmq 15 - message brokers 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: false 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors RabbitMQ instances. 26 27 It collects data using an HTTP-based API provided by the [management plugin](https://www.rabbitmq.com/management.html). 28 The following endpoints are used: 29 30 - `/api/overview` 31 - `/api/node/{node_name}` 32 - `/api/vhosts` 33 - `/api/queues` (disabled by default) 34 method_description: "" 35 supported_platforms: 36 include: [] 37 exclude: [] 38 multi_instance: true 39 additional_permissions: 40 description: "" 41 default_behavior: 42 auto_detection: 43 description: "" 44 limits: 45 description: "" 46 performance_impact: 47 description: "" 48 setup: 49 prerequisites: 50 list: 51 - title: Enable management plugin. 52 description: | 53 The management plugin is included in the RabbitMQ distribution, but disabled. 54 To enable see [Management Plugin](https://www.rabbitmq.com/management.html#getting-started) documentation. 55 configuration: 56 file: 57 name: go.d/rabbitmq.conf 58 options: 59 description: | 60 The following options can be defined globally: update_every, autodetection_retry. 61 folding: 62 title: Config options 63 enabled: true 64 list: 65 - name: update_every 66 description: Data collection frequency. 67 default_value: 1 68 required: false 69 - name: autodetection_retry 70 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 71 default_value: 0 72 required: false 73 - name: url 74 description: Server URL. 75 default_value: http://localhost:15672 76 required: true 77 - name: collect_queues_metrics 78 description: Collect stats per vhost per queues. Enabling this can introduce serious overhead on both Netdata and RabbitMQ if many queues are configured and used. 79 default_value: false 80 required: false 81 - name: timeout 82 description: HTTP request timeout. 83 default_value: 1 84 required: false 85 - name: username 86 description: Username for basic HTTP authentication. 87 default_value: "" 88 required: false 89 - name: password 90 description: Password for basic HTTP authentication. 91 default_value: "" 92 required: false 93 - name: proxy_url 94 description: Proxy URL. 95 default_value: "" 96 required: false 97 - name: proxy_username 98 description: Username for proxy basic HTTP authentication. 99 default_value: "" 100 required: false 101 - name: proxy_password 102 description: Password for proxy basic HTTP authentication. 103 default_value: "" 104 required: false 105 - name: method 106 description: HTTP request method. 107 default_value: GET 108 required: false 109 - name: body 110 description: HTTP request body. 111 default_value: "" 112 required: false 113 - name: headers 114 description: HTTP request headers. 115 default_value: "" 116 required: false 117 - name: not_follow_redirects 118 description: Redirect handling policy. Controls whether the client follows redirects. 119 default_value: false 120 required: false 121 - name: tls_skip_verify 122 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 123 default_value: false 124 required: false 125 - name: tls_ca 126 description: Certification authority that the client uses when verifying the server's certificates. 127 default_value: "" 128 required: false 129 - name: tls_cert 130 description: Client TLS certificate. 131 default_value: "" 132 required: false 133 - name: tls_key 134 description: Client TLS key. 135 default_value: "" 136 required: false 137 examples: 138 folding: 139 title: Config 140 enabled: true 141 list: 142 - name: Basic 143 description: An example configuration. 144 config: | 145 jobs: 146 - name: local 147 url: http://127.0.0.1:15672 148 - name: Basic HTTP auth 149 description: Local server with basic HTTP authentication. 150 config: | 151 jobs: 152 - name: local 153 url: http://127.0.0.1:15672 154 username: admin 155 password: password 156 - name: Multi-instance 157 description: | 158 > **Note**: When you define multiple jobs, their names must be unique. 159 160 Local and remote instances. 161 config: | 162 jobs: 163 - name: local 164 url: http://127.0.0.1:15672 165 166 - name: remote 167 url: http://192.0.2.0:15672 168 troubleshooting: 169 problems: 170 list: [] 171 alerts: [] 172 metrics: 173 folding: 174 title: Metrics 175 enabled: false 176 description: "" 177 availability: [] 178 scopes: 179 - name: global 180 description: These metrics refer to the entire monitored application. 181 labels: [] 182 metrics: 183 - name: rabbitmq.messages_count 184 description: Messages 185 unit: messages 186 chart_type: stacked 187 dimensions: 188 - name: ready 189 - name: unacknowledged 190 - name: rabbitmq.messages_rate 191 description: Messages 192 unit: messages/s 193 chart_type: line 194 dimensions: 195 - name: ack 196 - name: publish 197 - name: publish_in 198 - name: publish_out 199 - name: confirm 200 - name: deliver 201 - name: deliver_no_ack 202 - name: get 203 - name: get_no_ack 204 - name: deliver_get 205 - name: redeliver 206 - name: return_unroutable 207 - name: rabbitmq.objects_count 208 description: Objects 209 unit: messages 210 chart_type: line 211 dimensions: 212 - name: channels 213 - name: consumers 214 - name: connections 215 - name: queues 216 - name: exchanges 217 - name: rabbitmq.connection_churn_rate 218 description: Connection churn 219 unit: operations/s 220 chart_type: line 221 dimensions: 222 - name: created 223 - name: closed 224 - name: rabbitmq.channel_churn_rate 225 description: Channel churn 226 unit: operations/s 227 chart_type: line 228 dimensions: 229 - name: created 230 - name: closed 231 - name: rabbitmq.queue_churn_rate 232 description: Queue churn 233 unit: operations/s 234 chart_type: line 235 dimensions: 236 - name: created 237 - name: deleted 238 - name: declared 239 - name: rabbitmq.file_descriptors_count 240 description: File descriptors 241 unit: fd 242 chart_type: stacked 243 dimensions: 244 - name: available 245 - name: used 246 - name: rabbitmq.sockets_count 247 description: Used sockets 248 unit: sockets 249 chart_type: stacked 250 dimensions: 251 - name: available 252 - name: used 253 - name: rabbitmq.erlang_processes_count 254 description: Erlang processes 255 unit: processes 256 chart_type: stacked 257 dimensions: 258 - name: available 259 - name: used 260 - name: rabbitmq.erlang_run_queue_processes_count 261 description: Erlang run queue 262 unit: processes 263 chart_type: line 264 dimensions: 265 - name: length 266 - name: rabbitmq.memory_usage 267 description: Memory 268 unit: bytes 269 chart_type: line 270 dimensions: 271 - name: used 272 - name: rabbitmq.disk_space_free_size 273 description: Free disk space 274 unit: bytes 275 chart_type: line 276 dimensions: 277 - name: free 278 - name: vhost 279 description: These metrics refer to the virtual host. 280 labels: 281 - name: vhost 282 description: virtual host name 283 metrics: 284 - name: rabbitmq.vhost_messages_count 285 description: Vhost messages 286 unit: messages 287 chart_type: line 288 dimensions: 289 - name: ready 290 - name: unacknowledged 291 - name: rabbitmq.vhost_messages_rate 292 description: Vhost messages rate 293 unit: messages/s 294 chart_type: line 295 dimensions: 296 - name: ack 297 - name: publish 298 - name: publish_in 299 - name: publish_out 300 - name: confirm 301 - name: deliver 302 - name: deliver_no_ack 303 - name: get 304 - name: get_no_ack 305 - name: deliver_get 306 - name: redeliver 307 - name: return_unroutable 308 - name: queue 309 description: These metrics refer to the virtual host queue. 310 labels: 311 - name: vhost 312 description: virtual host name 313 - name: queue 314 description: queue name 315 metrics: 316 - name: rabbitmq.queue_messages_count 317 description: Queue messages 318 unit: messages 319 chart_type: line 320 dimensions: 321 - name: ready 322 - name: unacknowledged 323 - name: paged_out 324 - name: persistent 325 - name: rabbitmq.queue_messages_rate 326 description: Queue messages rate 327 unit: messages/s 328 chart_type: line 329 dimensions: 330 - name: ack 331 - name: publish 332 - name: publish_in 333 - name: publish_out 334 - name: confirm 335 - name: deliver 336 - name: deliver_no_ack 337 - name: get 338 - name: get_no_ack 339 - name: deliver_get 340 - name: redeliver 341 - name: return_unroutable