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