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