github.com/netdata/go.d.plugin@v0.58.1/modules/pulsar/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-pulsar 5 plugin_name: go.d.plugin 6 module_name: pulsar 7 monitored_instance: 8 name: Apache Pulsar 9 link: https://pulsar.apache.org/ 10 icon_filename: pulsar.svg 11 categories: 12 - data-collection.message-brokers 13 keywords: 14 - pulsar 15 related_resources: 16 integrations: 17 list: 18 - plugin_name: apps.plugin 19 module_name: apps 20 info_provided_to_referring_integrations: 21 description: "" 22 most_popular: true 23 overview: 24 data_collection: 25 metrics_description: | 26 This collector monitors Pulsar servers. 27 method_description: | 28 It collects broker statistics using Pulsar's [Prometheus endpoint](https://pulsar.apache.org/docs/en/deploy-monitoring/#broker-stats). 29 supported_platforms: 30 include: [] 31 exclude: [] 32 multi_instance: true 33 additional_permissions: 34 description: "" 35 default_behavior: 36 auto_detection: 37 description: | 38 By default, it detects Pulsar instances running on localhost. 39 limits: 40 description: "" 41 performance_impact: 42 description: "" 43 setup: 44 prerequisites: 45 list: [] 46 configuration: 47 file: 48 name: go.d/pulsar.conf 49 options: 50 description: | 51 The following options can be defined globally: update_every, autodetection_retry. 52 folding: 53 title: Config options 54 enabled: true 55 list: 56 - name: update_every 57 description: Data collection frequency. 58 default_value: 1 59 required: false 60 - name: autodetection_retry 61 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 62 default_value: 0 63 required: false 64 - name: url 65 description: Server URL. 66 default_value: http://127.0.0.1:8080/metrics 67 required: true 68 - name: timeout 69 description: HTTP request timeout. 70 default_value: 1 71 required: false 72 - name: username 73 description: Username for basic HTTP authentication. 74 default_value: "" 75 required: false 76 - name: password 77 description: Password for basic HTTP authentication. 78 default_value: "" 79 required: false 80 - name: proxy_url 81 description: Proxy URL. 82 default_value: "" 83 required: false 84 - name: proxy_username 85 description: Username for proxy basic HTTP authentication. 86 default_value: "" 87 required: false 88 - name: proxy_password 89 description: Password for proxy basic HTTP authentication. 90 default_value: "" 91 required: false 92 - name: method 93 description: HTTP request method. 94 default_value: GET 95 required: false 96 - name: body 97 description: HTTP request body. 98 default_value: "" 99 required: false 100 - name: headers 101 description: HTTP request headers. 102 default_value: "" 103 required: false 104 - name: not_follow_redirects 105 description: Redirect handling policy. Controls whether the client follows redirects. 106 default_value: no 107 required: false 108 - name: tls_skip_verify 109 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 110 default_value: no 111 required: false 112 - name: tls_ca 113 description: Certification authority that the client uses when verifying the server's certificates. 114 default_value: "" 115 required: false 116 - name: tls_cert 117 description: Client TLS certificate. 118 default_value: "" 119 required: false 120 - name: tls_key 121 description: Client TLS key. 122 default_value: "" 123 required: false 124 examples: 125 folding: 126 title: Config 127 enabled: true 128 list: 129 - name: Basic 130 folding: 131 enabled: false 132 description: A basic example configuration. 133 config: | 134 jobs: 135 - name: local 136 url: http://127.0.0.1:8080/metrics 137 - name: HTTP authentication 138 description: Basic HTTP authentication. 139 config: | 140 jobs: 141 - name: local 142 url: http://127.0.0.1:8080/metrics 143 username: username 144 password: password 145 - name: HTTPS with self-signed certificate 146 description: | 147 Do not validate server certificate chain and hostname. 148 config: | 149 jobs: 150 - name: local 151 url: https://127.0.0.1:8080/metrics 152 tls_skip_verify: yes 153 - name: Multi-instance 154 description: | 155 > **Note**: When you define multiple jobs, their names must be unique. 156 157 Collecting metrics from local and remote instances. 158 config: | 159 jobs: 160 - name: local 161 url: http://127.0.0.1:8080/metrics 162 163 - name: remote 164 url: http://192.0.2.1:8080/metrics 165 troubleshooting: 166 problems: 167 list: [] 168 alerts: [] 169 metrics: 170 folding: 171 title: Metrics 172 enabled: false 173 description: | 174 - topic_* metrics are available when `exposeTopicLevelMetricsInPrometheus` is set to true. 175 - subscription_* and namespace_subscription metrics are available when `exposeTopicLevelMetricsInPrometheus` si set to true. 176 - replication_* and namespace_replication_* metrics are available when replication is configured and `replicationMetricsEnabled` is set to true. 177 availability: [] 178 scopes: 179 - name: global 180 description: These metrics refer to the entire monitored application. 181 labels: [] 182 metrics: 183 - name: pulsar.broker_components 184 description: Broker Components 185 unit: components 186 chart_type: line 187 dimensions: 188 - name: namespaces 189 - name: topics 190 - name: subscriptions 191 - name: producers 192 - name: consumers 193 - name: pulsar.messages_rate 194 description: Messages Rate 195 unit: messages/s 196 chart_type: line 197 dimensions: 198 - name: publish 199 - name: dispatch 200 - name: pulsar.throughput_rate 201 description: Throughput Rate 202 unit: KiB/s 203 chart_type: area 204 dimensions: 205 - name: publish 206 - name: dispatch 207 - name: pulsar.storage_size 208 description: Storage Size 209 unit: KiB 210 chart_type: line 211 dimensions: 212 - name: used 213 - name: pulsar.storage_operations_rate 214 description: Storage Read/Write Operations Rate 215 unit: message batches/s 216 chart_type: area 217 dimensions: 218 - name: read 219 - name: write 220 - name: pulsar.msg_backlog 221 description: Messages Backlog Size 222 unit: messages 223 chart_type: line 224 dimensions: 225 - name: backlog 226 - name: pulsar.storage_write_latency 227 description: Storage Write Latency 228 unit: entries/s 229 chart_type: stacked 230 dimensions: 231 - name: <=0.5ms 232 - name: <=1ms 233 - name: <=5ms 234 - name: =10ms 235 - name: <=20ms 236 - name: <=50ms 237 - name: <=100ms 238 - name: <=200ms 239 - name: <=1s 240 - name: '>1s' 241 - name: pulsar.entry_size 242 description: Entry Size 243 unit: entries/s 244 chart_type: stacked 245 dimensions: 246 - name: <=128B 247 - name: <=512B 248 - name: <=1KB 249 - name: <=2KB 250 - name: <=4KB 251 - name: <=16KB 252 - name: <=100KB 253 - name: <=1MB 254 - name: '>1MB' 255 - name: pulsar.subscription_delayed 256 description: Subscriptions Delayed for Dispatching 257 unit: message batches 258 chart_type: line 259 dimensions: 260 - name: delayed 261 - name: pulsar.subscription_msg_rate_redeliver 262 description: Subscriptions Redelivered Message Rate 263 unit: messages/s 264 chart_type: line 265 dimensions: 266 - name: redelivered 267 - name: pulsar.subscription_blocked_on_unacked_messages 268 description: Subscriptions Blocked On Unacked Messages 269 unit: subscriptions 270 chart_type: line 271 dimensions: 272 - name: blocked 273 - name: pulsar.replication_rate 274 description: Replication Rate 275 unit: messages/s 276 chart_type: line 277 dimensions: 278 - name: in 279 - name: out 280 - name: pulsar.replication_throughput_rate 281 description: Replication Throughput Rate 282 unit: KiB/s 283 chart_type: line 284 dimensions: 285 - name: in 286 - name: out 287 - name: pulsar.replication_backlog 288 description: Replication Backlog 289 unit: messages 290 chart_type: line 291 dimensions: 292 - name: backlog 293 - name: namespace 294 description: TBD 295 labels: [] 296 metrics: 297 - name: pulsar.namespace_broker_components 298 description: Broker Components 299 unit: components 300 chart_type: line 301 dimensions: 302 - name: topics 303 - name: subscriptions 304 - name: producers 305 - name: consumers 306 - name: pulsar.namespace_messages_rate 307 description: Messages Rate 308 unit: messages/s 309 chart_type: line 310 dimensions: 311 - name: publish 312 - name: dispatch 313 - name: pulsar.namespace_throughput_rate 314 description: Throughput Rate 315 unit: KiB/s 316 chart_type: area 317 dimensions: 318 - name: publish 319 - name: dispatch 320 - name: pulsar.namespace_storage_size 321 description: Storage Size 322 unit: KiB 323 chart_type: line 324 dimensions: 325 - name: used 326 - name: pulsar.namespace_storage_operations_rate 327 description: Storage Read/Write Operations Rate 328 unit: message batches/s 329 chart_type: area 330 dimensions: 331 - name: read 332 - name: write 333 - name: pulsar.namespace_msg_backlog 334 description: Messages Backlog Size 335 unit: messages 336 chart_type: line 337 dimensions: 338 - name: backlog 339 - name: pulsar.namespace_storage_write_latency 340 description: Storage Write Latency 341 unit: entries/s 342 chart_type: stacked 343 dimensions: 344 - name: <=0.5ms 345 - name: <=1ms 346 - name: <=5ms 347 - name: =10ms 348 - name: <=20ms 349 - name: <=50ms 350 - name: <=100ms 351 - name: <=200ms 352 - name: <=1s 353 - name: '>1s' 354 - name: pulsar.namespace_entry_size 355 description: Entry Size 356 unit: entries/s 357 chart_type: stacked 358 dimensions: 359 - name: <=128B 360 - name: <=512B 361 - name: <=1KB 362 - name: <=2KB 363 - name: <=4KB 364 - name: <=16KB 365 - name: <=100KB 366 - name: <=1MB 367 - name: '>1MB' 368 - name: pulsar.namespace_subscription_delayed 369 description: Subscriptions Delayed for Dispatching 370 unit: message batches 371 chart_type: line 372 dimensions: 373 - name: delayed 374 - name: pulsar.namespace_subscription_msg_rate_redeliver 375 description: Subscriptions Redelivered Message Rate 376 unit: messages/s 377 chart_type: line 378 dimensions: 379 - name: redelivered 380 - name: pulsar.namespace_subscription_blocked_on_unacked_messages 381 description: Subscriptions Blocked On Unacked Messages 382 unit: subscriptions 383 chart_type: line 384 dimensions: 385 - name: blocked 386 - name: pulsar.namespace_replication_rate 387 description: Replication Rate 388 unit: messages/s 389 chart_type: line 390 dimensions: 391 - name: in 392 - name: out 393 - name: pulsar.namespace_replication_throughput_rate 394 description: Replication Throughput Rate 395 unit: KiB/s 396 chart_type: line 397 dimensions: 398 - name: in 399 - name: out 400 - name: pulsar.namespace_replication_backlog 401 description: Replication Backlog 402 unit: messages 403 chart_type: line 404 dimensions: 405 - name: backlog 406 - name: pulsar.topic_producers 407 description: Topic Producers 408 unit: producers 409 chart_type: stacked 410 dimensions: 411 - name: a dimension per topic 412 - name: pulsar.topic_subscriptions 413 description: Topic Subscriptions 414 unit: subscriptions 415 chart_type: stacked 416 dimensions: 417 - name: a dimension per topic 418 - name: pulsar.topic_consumers 419 description: Topic Consumers 420 unit: consumers 421 chart_type: stacked 422 dimensions: 423 - name: a dimension per topic 424 - name: pulsar.topic_messages_rate_in 425 description: Topic Publish Messages Rate 426 unit: publishes/s 427 chart_type: stacked 428 dimensions: 429 - name: a dimension per topic 430 - name: pulsar.topic_messages_rate_out 431 description: Topic Dispatch Messages Rate 432 unit: dispatches/s 433 chart_type: stacked 434 dimensions: 435 - name: a dimension per topic 436 - name: pulsar.topic_throughput_rate_in 437 description: Topic Publish Throughput Rate 438 unit: KiB/s 439 chart_type: stacked 440 dimensions: 441 - name: a dimension per topic 442 - name: pulsar.topic_throughput_rate_out 443 description: Topic Dispatch Throughput Rate 444 unit: KiB/s 445 chart_type: stacked 446 dimensions: 447 - name: a dimension per topic 448 - name: pulsar.topic_storage_size 449 description: Topic Storage Size 450 unit: KiB 451 chart_type: stacked 452 dimensions: 453 - name: a dimension per topic 454 - name: pulsar.topic_storage_read_rate 455 description: Topic Storage Read Rate 456 unit: message batches/s 457 chart_type: stacked 458 dimensions: 459 - name: a dimension per topic 460 - name: pulsar.topic_storage_write_rate 461 description: Topic Storage Write Rate 462 unit: message batches/s 463 chart_type: stacked 464 dimensions: 465 - name: a dimension per topic 466 - name: pulsar.topic_msg_backlog 467 description: Topic Messages Backlog Size 468 unit: messages 469 chart_type: stacked 470 dimensions: 471 - name: a dimension per topic 472 - name: pulsar.topic_subscription_delayed 473 description: Topic Subscriptions Delayed for Dispatching 474 unit: message batches 475 chart_type: stacked 476 dimensions: 477 - name: a dimension per topic 478 - name: pulsar.topic_subscription_msg_rate_redeliver 479 description: Topic Subscriptions Redelivered Message Rate 480 unit: messages/s 481 chart_type: stacked 482 dimensions: 483 - name: a dimension per topic 484 - name: pulsar.topic_subscription_blocked_on_unacked_messages 485 description: Topic Subscriptions Blocked On Unacked Messages 486 unit: blocked subscriptions 487 chart_type: stacked 488 dimensions: 489 - name: a dimension per topic 490 - name: pulsar.topic_replication_rate_in 491 description: Topic Replication Rate From Remote Cluster 492 unit: messages/s 493 chart_type: stacked 494 dimensions: 495 - name: a dimension per topic 496 - name: pulsar.topic_replication_rate_out 497 description: Topic Replication Rate To Remote Cluster 498 unit: messages/s 499 chart_type: stacked 500 dimensions: 501 - name: a dimension per topic 502 - name: pulsar.topic_replication_throughput_rate_in 503 description: Topic Replication Throughput Rate From Remote Cluster 504 unit: messages/s 505 chart_type: stacked 506 dimensions: 507 - name: a dimension per topic 508 - name: pulsar.topic_replication_throughput_rate_out 509 description: Topic Replication Throughput Rate To Remote Cluster 510 unit: messages/s 511 chart_type: stacked 512 dimensions: 513 - name: a dimension per topic 514 - name: pulsar.topic_replication_backlog 515 description: Topic Replication Backlog 516 unit: messages 517 chart_type: stacked 518 dimensions: 519 - name: a dimension per topic