github.com/netdata/go.d.plugin@v0.58.1/modules/cassandra/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-cassandra 5 module_name: cassandra 6 plugin_name: go.d.plugin 7 monitored_instance: 8 categories: 9 - data-collection.database-servers 10 icon_filename: cassandra.svg 11 name: Cassandra 12 link: https://cassandra.apache.org/_/index.html 13 alternative_monitored_instances: [] 14 keywords: 15 - nosql 16 - dbms 17 - db 18 - database 19 related_resources: 20 integrations: 21 list: [] 22 info_provided_to_referring_integrations: 23 description: "" 24 most_popular: false 25 overview: 26 data_collection: 27 metrics_description: | 28 This collector gathers metrics about client requests, cache hits, and many more, while also providing metrics per each thread pool. 29 method_description: | 30 The [JMX Exporter](https://github.com/prometheus/jmx_exporter) is used to fetch metrics from a Cassandra instance and make them available at an endpoint like `http://127.0.0.1:7072/metrics`. 31 supported_platforms: 32 include: [] 33 exclude: [] 34 multi_instance: true 35 additional_permissions: 36 description: "" 37 default_behavior: 38 auto_detection: 39 description: | 40 This collector discovers instances running on the local host that provide metrics on port 7072. 41 42 On startup, it tries to collect metrics from: 43 44 - http://127.0.0.1:7072/metrics 45 limits: 46 description: "" 47 performance_impact: 48 description: "" 49 setup: 50 prerequisites: 51 list: 52 - title: Configure Cassandra with Prometheus JMX Exporter 53 description: | 54 To configure Cassandra with the [JMX Exporter](https://github.com/prometheus/jmx_exporter): 55 56 > **Note**: paths can differ depends on your setup. 57 58 - Download latest [jmx_exporter](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent/) jar file 59 and install it in a directory where Cassandra can access it. 60 - Add 61 the [jmx_exporter.yaml](https://raw.githubusercontent.com/netdata/go.d.plugin/master/modules/cassandra/jmx_exporter.yaml) 62 file to `/etc/cassandra`. 63 - Add the following line to `/etc/cassandra/cassandra-env.sh` 64 ``` 65 JVM_OPTS="$JVM_OPTS $JVM_EXTRA_OPTS -javaagent:/opt/jmx_exporter/jmx_exporter.jar=7072:/etc/cassandra/jmx_exporter.yaml 66 ``` 67 - Restart cassandra service. 68 configuration: 69 file: 70 name: go.d/cassandra.conf 71 options: 72 description: | 73 The following options can be defined globally: update_every, autodetection_retry. 74 folding: 75 title: Config options 76 enabled: true 77 list: 78 - name: update_every 79 description: Data collection frequency. 80 default_value: 5 81 required: false 82 - name: autodetection_retry 83 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 84 default_value: 0 85 required: false 86 - name: url 87 description: Server URL. 88 default_value: http://127.0.0.1:7072/metrics 89 required: true 90 - name: username 91 description: Username for basic HTTP authentication. 92 default_value: "" 93 required: false 94 - name: password 95 description: Password for basic HTTP authentication. 96 default_value: "" 97 required: false 98 - name: proxy_url 99 description: Proxy URL. 100 default_value: "" 101 required: false 102 - name: proxy_username 103 description: Username for proxy basic HTTP authentication. 104 default_value: "" 105 required: false 106 - name: proxy_password 107 description: Password for proxy basic HTTP authentication. 108 default_value: "" 109 required: false 110 - name: timeout 111 description: HTTP request timeout. 112 default_value: 2 113 required: false 114 - name: not_follow_redirects 115 description: Redirect handling policy. Controls whether the client follows redirects. 116 default_value: false 117 required: false 118 - name: tls_skip_verify 119 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 120 default_value: false 121 required: false 122 - name: tls_ca 123 description: Certification authority that the client uses when verifying the server's certificates. 124 default_value: "" 125 required: false 126 - name: tls_cert 127 description: Client TLS certificate. 128 default_value: "" 129 required: false 130 - name: tls_key 131 description: Client TLS key. 132 default_value: "" 133 required: false 134 examples: 135 folding: 136 title: Config 137 enabled: true 138 list: 139 - name: Basic 140 folding: 141 enabled: false 142 description: A basic example configuration. 143 config: | 144 jobs: 145 - name: local 146 url: http://127.0.0.1:7072/metrics 147 - name: HTTP authentication 148 description: Local server with basic HTTP authentication. 149 config: | 150 jobs: 151 - name: local 152 url: http://127.0.0.1:7072/metrics 153 username: foo 154 password: bar 155 - name: HTTPS with self-signed certificate 156 description: Local server with enabled HTTPS and self-signed certificate. 157 config: | 158 jobs: 159 - name: local 160 url: https://127.0.0.1:7072/metrics 161 tls_skip_verify: yes 162 - name: Multi-instance 163 description: | 164 > **Note**: When you define multiple jobs, their names must be unique. 165 166 Collecting metrics from local and remote instances. 167 config: | 168 jobs: 169 - name: local 170 url: http://127.0.0.1:7072/metrics 171 172 - name: remote 173 url: http://192.0.2.1:7072/metrics 174 troubleshooting: 175 problems: 176 list: [] 177 alerts: [] 178 metrics: 179 folding: 180 title: Metrics 181 enabled: false 182 description: "" 183 availability: [] 184 scopes: 185 - name: global 186 description: These metrics refer to the entire monitored application. 187 labels: [] 188 metrics: 189 - name: cassandra.client_requests_rate 190 availability: [] 191 description: Client requests rate 192 unit: requests/s 193 chart_type: line 194 dimensions: 195 - name: read 196 - name: write 197 - name: cassandra.client_request_read_latency_histogram 198 availability: [] 199 description: Client request read latency histogram 200 unit: seconds 201 chart_type: line 202 dimensions: 203 - name: p50 204 - name: p75 205 - name: p95 206 - name: p98 207 - name: p99 208 - name: p999 209 - name: cassandra.client_request_write_latency_histogram 210 availability: [] 211 description: Client request write latency histogram 212 unit: seconds 213 chart_type: line 214 dimensions: 215 - name: p50 216 - name: p75 217 - name: p95 218 - name: p98 219 - name: p99 220 - name: p999 221 - name: cassandra.client_requests_latency 222 availability: [] 223 description: Client requests total latency 224 unit: seconds 225 chart_type: line 226 dimensions: 227 - name: read 228 - name: write 229 - name: cassandra.row_cache_hit_ratio 230 availability: [] 231 description: Key cache hit ratio 232 unit: percentage 233 chart_type: line 234 dimensions: 235 - name: hit_ratio 236 - name: cassandra.row_cache_hit_rate 237 availability: [] 238 description: Key cache hit rate 239 unit: events/s 240 chart_type: stacked 241 dimensions: 242 - name: hits 243 - name: misses 244 - name: cassandra.row_cache_utilization 245 availability: [] 246 description: Key cache utilization 247 unit: percentage 248 chart_type: line 249 dimensions: 250 - name: used 251 - name: cassandra.row_cache_size 252 availability: [] 253 description: Key cache size 254 unit: bytes 255 chart_type: line 256 dimensions: 257 - name: size 258 - name: cassandra.key_cache_hit_ratio 259 availability: [] 260 description: Row cache hit ratio 261 unit: percentage 262 chart_type: line 263 dimensions: 264 - name: hit_ratio 265 - name: cassandra.key_cache_hit_rate 266 availability: [] 267 description: Row cache hit rate 268 unit: events/s 269 chart_type: stacked 270 dimensions: 271 - name: hits 272 - name: misses 273 - name: cassandra.key_cache_utilization 274 availability: [] 275 description: Row cache utilization 276 unit: percentage 277 chart_type: line 278 dimensions: 279 - name: used 280 - name: cassandra.key_cache_size 281 availability: [] 282 description: Row cache size 283 unit: bytes 284 chart_type: line 285 dimensions: 286 - name: size 287 - name: cassandra.storage_live_disk_space_used 288 availability: [] 289 description: Disk space used by live data 290 unit: bytes 291 chart_type: line 292 dimensions: 293 - name: used 294 - name: cassandra.compaction_completed_tasks_rate 295 availability: [] 296 description: Completed compactions rate 297 unit: tasks/s 298 chart_type: line 299 dimensions: 300 - name: completed 301 - name: cassandra.compaction_pending_tasks_count 302 availability: [] 303 description: Pending compactions 304 unit: tasks 305 chart_type: line 306 dimensions: 307 - name: pending 308 - name: cassandra.compaction_compacted_rate 309 availability: [] 310 description: Compaction data rate 311 unit: bytes/s 312 chart_type: line 313 dimensions: 314 - name: compacted 315 - name: cassandra.jvm_memory_used 316 availability: [] 317 description: Memory used 318 unit: bytes 319 chart_type: stacked 320 dimensions: 321 - name: heap 322 - name: nonheap 323 - name: cassandra.jvm_gc_rate 324 availability: [] 325 description: Garbage collections rate 326 unit: gc/s 327 chart_type: line 328 dimensions: 329 - name: parnew 330 - name: cms 331 - name: cassandra.jvm_gc_time 332 availability: [] 333 description: Garbage collection time 334 unit: seconds 335 chart_type: line 336 dimensions: 337 - name: parnew 338 - name: cms 339 - name: cassandra.dropped_messages_rate 340 availability: [] 341 description: Dropped messages rate 342 unit: messages/s 343 chart_type: line 344 dimensions: 345 - name: dropped 346 - name: cassandra.client_requests_timeouts_rate 347 availability: [] 348 description: Client requests timeouts rate 349 unit: timeout/s 350 chart_type: line 351 dimensions: 352 - name: read 353 - name: write 354 - name: cassandra.client_requests_unavailables_rate 355 availability: [] 356 description: Client requests unavailable exceptions rate 357 unit: exceptions/s 358 chart_type: line 359 dimensions: 360 - name: read 361 - name: write 362 - name: cassandra.client_requests_failures_rate 363 availability: [] 364 description: Client requests failures rate 365 unit: failures/s 366 chart_type: line 367 dimensions: 368 - name: read 369 - name: write 370 - name: cassandra.storage_exceptions_rate 371 availability: [] 372 description: Storage exceptions rate 373 unit: exceptions/s 374 chart_type: line 375 dimensions: 376 - name: storage 377 - name: thread pool 378 description: Metrics related to Cassandra's thread pools. Each thread pool provides its own set of the following metrics. 379 labels: 380 - name: thread_pool 381 description: thread pool name 382 metrics: 383 - name: cassandra.thread_pool_active_tasks_count 384 availability: [] 385 description: Active tasks 386 unit: tasks 387 chart_type: line 388 dimensions: 389 - name: active 390 - name: cassandra.thread_pool_pending_tasks_count 391 availability: [] 392 description: Pending tasks 393 unit: tasks 394 chart_type: line 395 dimensions: 396 - name: pending 397 - name: cassandra.thread_pool_blocked_tasks_count 398 availability: [] 399 description: Blocked tasks 400 unit: tasks 401 chart_type: line 402 dimensions: 403 - name: blocked 404 - name: cassandra.thread_pool_blocked_tasks_rate 405 availability: [] 406 description: Blocked tasks rate 407 unit: tasks/s 408 chart_type: line 409 dimensions: 410 - name: blocked