| 1 | plugin_name: debugfs.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: debugfs.plugin |
| 5 | module_name: /sys/kernel/debug/extfrag |
| 6 | monitored_instance: |
| 7 | name: System Memory Fragmentation |
| 8 | link: 'https://www.kernel.org/doc/html/next/admin-guide/sysctl/vm.html' |
| 9 | categories: |
| 10 | - data-collection.operating-systems |
| 11 | icon_filename: 'microchip.svg' |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: '' |
| 17 | keywords: |
| 18 | - extfrag |
| 19 | - extfrag_threshold |
| 20 | - memory fragmentation |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: 'Collects memory fragmentation statistics from the Linux kernel' |
| 24 | method_description: 'Parse data from `debugfs` file' |
| 25 | supported_platforms: |
| 26 | include: |
| 27 | - Linux |
| 28 | exclude: [] |
| 29 | multi_instance: false |
| 30 | additional_permissions: |
| 31 | description: > |
| 32 | This integration requires read access to files under `/sys/kernel/debug/extfrag`, which are accessible |
| 33 | only to the root user by default. Netdata uses Linux Capabilities to give the plugin access to |
| 34 | debugfs. `CAP_DAC_READ_SEARCH` is added automatically during installation. This capability allows bypassing |
| 35 | file read permission checks and directory read and execute permission checks. If file capabilities are not |
| 36 | usable, then the plugin is instead installed with the SUID bit set in permissions so that it runs as root. |
| 37 | default_behavior: |
| 38 | auto_detection: |
| 39 | description: > |
| 40 | Assuming that debugfs is mounted and the required permissions are available, this integration will |
| 41 | automatically run by default. |
| 42 | limits: |
| 43 | description: '' |
| 44 | performance_impact: |
| 45 | description: '' |
| 46 | setup: |
| 47 | prerequisites: |
| 48 | list: |
| 49 | - title: 'filesystem' |
| 50 | description: > |
| 51 | The debugfs filesystem must be mounted on your host for plugin to collect data. |
| 52 | You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally. |
| 53 | It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem |
| 54 | before starting netdata. |
| 55 | configuration: |
| 56 | file: |
| 57 | name: 'netdata.conf' |
| 58 | section_name: '[plugin:debugfs]' |
| 59 | description: 'This is netdata main configuration file.' |
| 60 | options: |
| 61 | description: '' |
| 62 | folding: |
| 63 | title: 'Config options' |
| 64 | enabled: true |
| 65 | list: |
| 66 | - name: update every |
| 67 | description: Data collection frequency. |
| 68 | default_value: 1 |
| 69 | required: false |
| 70 | - name: command options |
| 71 | description: Additinal parameters for collector |
| 72 | default_value: "" |
| 73 | required: false |
| 74 | examples: |
| 75 | folding: |
| 76 | enabled: true |
| 77 | title: '' |
| 78 | list: [] |
| 79 | troubleshooting: |
| 80 | problems: |
| 81 | list: [] |
| 82 | alerts: [] |
| 83 | metrics: |
| 84 | folding: |
| 85 | title: Metrics |
| 86 | enabled: false |
| 87 | description: "Monitor the overall memory fragmentation of the system." |
| 88 | availability: [] |
| 89 | scopes: |
| 90 | - name: node |
| 91 | description: "Memory fragmentation statistics for each NUMA node in the system." |
| 92 | labels: |
| 93 | - name: numa_node |
| 94 | description: The NUMA node the metrics are associated with. |
| 95 | metrics: |
| 96 | - name: mem.fragmentation_index_dma |
| 97 | description: Memory fragmentation index for each order |
| 98 | unit: "index" |
| 99 | chart_type: line |
| 100 | dimensions: |
| 101 | - name: order0 |
| 102 | - name: order1 |
| 103 | - name: order2 |
| 104 | - name: order3 |
| 105 | - name: order4 |
| 106 | - name: order5 |
| 107 | - name: order6 |
| 108 | - name: order7 |
| 109 | - name: order8 |
| 110 | - name: order9 |
| 111 | - name: order10 |
| 112 | - name: mem.fragmentation_index_dma32 |
| 113 | description: Memory fragmentation index for each order |
| 114 | unit: "index" |
| 115 | chart_type: line |
| 116 | dimensions: |
| 117 | - name: order0 |
| 118 | - name: order1 |
| 119 | - name: order2 |
| 120 | - name: order3 |
| 121 | - name: order4 |
| 122 | - name: order5 |
| 123 | - name: order6 |
| 124 | - name: order7 |
| 125 | - name: order8 |
| 126 | - name: order9 |
| 127 | - name: order10 |
| 128 | - name: mem.fragmentation_index_normal |
| 129 | description: Memory fragmentation index for each order |
| 130 | unit: "index" |
| 131 | chart_type: line |
| 132 | dimensions: |
| 133 | - name: order0 |
| 134 | - name: order1 |
| 135 | - name: order2 |
| 136 | - name: order3 |
| 137 | - name: order4 |
| 138 | - name: order5 |
| 139 | - name: order6 |
| 140 | - name: order7 |
| 141 | - name: order8 |
| 142 | - name: order9 |
| 143 | - name: order10 |
| 144 | - meta: |
| 145 | plugin_name: debugfs.plugin |
| 146 | module_name: /sys/kernel/debug/zswap |
| 147 | monitored_instance: |
| 148 | name: Linux ZSwap |
| 149 | link: 'https://www.kernel.org/doc/html/latest/admin-guide/mm/zswap.html' |
| 150 | categories: |
| 151 | - data-collection.operating-systems |
| 152 | icon_filename: 'microchip.svg' |
| 153 | related_resources: |
| 154 | integrations: |
| 155 | list: [] |
| 156 | info_provided_to_referring_integrations: |
| 157 | description: '' |
| 158 | keywords: |
| 159 | - swap |
| 160 | - zswap |
| 161 | - frontswap |
| 162 | - swap cache |
| 163 | overview: |
| 164 | data_collection: |
| 165 | metrics_description: > |
| 166 | Collects zswap performance metrics on Linux systems. |
| 167 | method_description: 'Parse data from `debugfs file.' |
| 168 | supported_platforms: |
| 169 | include: |
| 170 | - Linux |
| 171 | exclude: [] |
| 172 | multi_instance: false |
| 173 | additional_permissions: |
| 174 | description: > |
| 175 | This integration requires read access to files under `/sys/kernel/debug/zswap`, which are accessible |
| 176 | only to the root user by default. Netdata uses Linux Capabilities to give the plugin access to |
| 177 | debugfs. `CAP_DAC_READ_SEARCH` is added automatically during installation. This capability allows bypassing |
| 178 | file read permission checks and directory read and execute permission checks. If file capabilities are not |
| 179 | usable, then the plugin is instead installed with the SUID bit set in permissions so that it runs as root. |
| 180 | default_behavior: |
| 181 | auto_detection: |
| 182 | description: > |
| 183 | Assuming that debugfs is mounted and the required permissions are available, this integration will |
| 184 | automatically detect whether or not the system is using zswap. |
| 185 | limits: |
| 186 | description: '' |
| 187 | performance_impact: |
| 188 | description: '' |
| 189 | setup: |
| 190 | prerequisites: |
| 191 | list: |
| 192 | - title: 'filesystem' |
| 193 | description: > |
| 194 | The debugfs filesystem must be mounted on your host for plugin to collect data. |
| 195 | You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally. |
| 196 | It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem |
| 197 | before starting netdata. |
| 198 | configuration: |
| 199 | file: |
| 200 | name: 'netdata.conf' |
| 201 | section_name: '[plugin:debugfs]' |
| 202 | description: 'This is netdata main configuration file.' |
| 203 | options: |
| 204 | description: '' |
| 205 | folding: |
| 206 | title: 'Config options' |
| 207 | enabled: true |
| 208 | list: |
| 209 | - name: update every |
| 210 | description: Data collection frequency. |
| 211 | default_value: 1 |
| 212 | required: false |
| 213 | - name: command options |
| 214 | description: Additinal parameters for collector |
| 215 | default_value: "" |
| 216 | required: false |
| 217 | examples: |
| 218 | folding: |
| 219 | enabled: true |
| 220 | title: '' |
| 221 | list: [] |
| 222 | troubleshooting: |
| 223 | problems: |
| 224 | list: [] |
| 225 | alerts: [] |
| 226 | metrics: |
| 227 | folding: |
| 228 | title: Metrics |
| 229 | enabled: false |
| 230 | description: "Monitor the performance statistics of zswap." |
| 231 | availability: [] |
| 232 | scopes: |
| 233 | - name: global |
| 234 | description: "Global zswap performance metrics." |
| 235 | labels: [] |
| 236 | metrics: |
| 237 | - name: system.zswap_pool_compression_ratio |
| 238 | description: Zswap compression ratio |
| 239 | unit: "ratio" |
| 240 | chart_type: line |
| 241 | dimensions: |
| 242 | - name: compression_ratio |
| 243 | - name: system.zswap_pool_compressed_size |
| 244 | description: Zswap compressed bytes currently stored |
| 245 | unit: "bytes" |
| 246 | chart_type: area |
| 247 | dimensions: |
| 248 | - name: compressed_size |
| 249 | - name: system.zswap_pool_raw_size |
| 250 | description: Zswap uncompressed bytes currently stored |
| 251 | unit: "bytes" |
| 252 | chart_type: area |
| 253 | dimensions: |
| 254 | - name: uncompressed_size |
| 255 | - name: system.zswap_rejections |
| 256 | description: Zswap rejections |
| 257 | unit: "rejections/s" |
| 258 | chart_type: stacked |
| 259 | dimensions: |
| 260 | - name: compress_poor |
| 261 | - name: kmemcache_fail |
| 262 | - name: alloc_fail |
| 263 | - name: reclaim_fail |
| 264 | - name: system.zswap_pool_limit_hit |
| 265 | description: Zswap pool limit was reached |
| 266 | unit: "events/s" |
| 267 | chart_type: line |
| 268 | dimensions: |
| 269 | - name: limit |
| 270 | - name: system.zswap_written_back_raw_bytes |
| 271 | description: Zswap uncomressed bytes written back when pool limit was reached |
| 272 | unit: "bytes/s" |
| 273 | chart_type: area |
| 274 | dimensions: |
| 275 | - name: written_back |
| 276 | - name: system.zswap_same_filled_raw_size |
| 277 | description: Zswap same-value filled uncompressed bytes currently stored |
| 278 | unit: "bytes" |
| 279 | chart_type: area |
| 280 | dimensions: |
| 281 | - name: same_filled |
| 282 | - name: system.zswap_duplicate_entry |
| 283 | description: Zswap duplicate store was encountered |
| 284 | unit: "entries/s" |
| 285 | chart_type: line |
| 286 | dimensions: |
| 287 | - name: duplicate |
| 288 | - meta: |
| 289 | plugin_name: debugfs.plugin |
| 290 | module_name: intel_rapl |
| 291 | monitored_instance: |
| 292 | name: Power Capping |
| 293 | link: 'https://www.kernel.org/doc/html/next/power/powercap/powercap.html' |
| 294 | categories: |
| 295 | - data-collection.hardware-and-sensors |
| 296 | icon_filename: 'powersupply.svg' |
| 297 | related_resources: |
| 298 | integrations: |
| 299 | list: [] |
| 300 | info_provided_to_referring_integrations: |
| 301 | description: '' |
| 302 | keywords: |
| 303 | - power capping |
| 304 | - energy |
| 305 | overview: |
| 306 | data_collection: |
| 307 | metrics_description: > |
| 308 | Collects power capping performance metrics on Linux systems. |
| 309 | method_description: 'Parse data from `debugfs file.' |
| 310 | supported_platforms: |
| 311 | include: |
| 312 | - Linux |
| 313 | exclude: [] |
| 314 | multi_instance: false |
| 315 | additional_permissions: |
| 316 | description: > |
| 317 | This integration requires read access to files under `/sys/devices/virtual/powercap`, which are accessible |
| 318 | only to the root user by default. Netdata uses Linux Capabilities to give the plugin access to |
| 319 | debugfs. `CAP_DAC_READ_SEARCH` is added automatically during installation. This capability allows bypassing |
| 320 | file read permission checks and directory read and execute permission checks. If file capabilities are not |
| 321 | usable, then the plugin is instead installed with the SUID bit set in permissions so that it runs as root. |
| 322 | default_behavior: |
| 323 | auto_detection: |
| 324 | description: > |
| 325 | Assuming that debugfs is mounted and the required permissions are available, this integration will |
| 326 | automatically detect whether or not the system is using zswap. |
| 327 | limits: |
| 328 | description: '' |
| 329 | performance_impact: |
| 330 | description: '' |
| 331 | setup: |
| 332 | prerequisites: |
| 333 | list: |
| 334 | - title: 'filesystem' |
| 335 | description: > |
| 336 | The debugfs filesystem must be mounted on your host for plugin to collect data. |
| 337 | You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally. |
| 338 | It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem |
| 339 | before starting netdata. |
| 340 | configuration: |
| 341 | file: |
| 342 | name: 'netdata.conf' |
| 343 | section_name: '[plugin:debugfs]' |
| 344 | description: 'This is netdata main configuration file.' |
| 345 | options: |
| 346 | description: '' |
| 347 | folding: |
| 348 | title: 'Config options' |
| 349 | enabled: true |
| 350 | list: |
| 351 | - name: update every |
| 352 | description: Data collection frequency. |
| 353 | default_value: 1 |
| 354 | required: false |
| 355 | - name: command options |
| 356 | description: Additinal parameters for collector |
| 357 | default_value: "" |
| 358 | required: false |
| 359 | examples: |
| 360 | folding: |
| 361 | enabled: true |
| 362 | title: '' |
| 363 | list: [] |
| 364 | troubleshooting: |
| 365 | problems: |
| 366 | list: [] |
| 367 | alerts: [] |
| 368 | metrics: |
| 369 | folding: |
| 370 | title: Metrics |
| 371 | enabled: false |
| 372 | description: "Monitor the Intel RAPL zones Consumption." |
| 373 | availability: [] |
| 374 | scopes: |
| 375 | - name: global |
| 376 | description: "Global Intel RAPL zones." |
| 377 | labels: [] |
| 378 | metrics: |
| 379 | - name: cpu.powercap_intel_rapl_zone |
| 380 | description: Intel RAPL Zone Power Consumption |
| 381 | unit: "Watts" |
| 382 | chart_type: line |
| 383 | dimensions: |
| 384 | - name: Power |
| 385 | - name: cpu.powercap_intel_rapl_subzones |
| 386 | description: Intel RAPL Subzones Power Consumption |
| 387 | unit: "Watts" |
| 388 | chart_type: line |
| 389 | dimensions: |
| 390 | - name: dram |
| 391 | - name: core |
| 392 | - name: uncore |
| 393 | - meta: |
| 394 | plugin_name: debugfs.plugin |
| 395 | module_name: audit |
| 396 | monitored_instance: |
| 397 | name: Linux Audit Subsystem |
| 398 | link: 'https://man7.org/linux/man-pages/man8/auditd.8.html' |
| 399 | categories: |
| 400 | - data-collection.operating-systems |
| 401 | icon_filename: 'linux.svg' |
| 402 | related_resources: |
| 403 | integrations: |
| 404 | list: [] |
| 405 | info_provided_to_referring_integrations: |
| 406 | description: '' |
| 407 | keywords: |
| 408 | - audit |
| 409 | - auditd |
| 410 | - backlog |
| 411 | - security |
| 412 | - kernel panic |
| 413 | - compliance |
| 414 | overview: |
| 415 | data_collection: |
| 416 | metrics_description: > |
| 417 | Monitors Linux kernel audit subsystem status via NETLINK_AUDIT. |
| 418 | Tracks audit backlog depth, backlog utilization, lost events, |
| 419 | and configuration (failure mode, enabled state). |
| 420 | Critical for detecting audit backlog overflow conditions that |
| 421 | cause kernel panics when failure mode is set to 2 (panic). |
| 422 | method_description: 'Query kernel audit status via NETLINK_AUDIT socket (AUDIT_GET)' |
| 423 | supported_platforms: |
| 424 | include: |
| 425 | - Linux |
| 426 | exclude: [] |
| 427 | multi_instance: false |
| 428 | additional_permissions: |
| 429 | description: > |
| 430 | This integration requires root privileges or CAP_AUDIT_CONTROL capability |
| 431 | to query the kernel audit subsystem via netlink. The Netdata installer |
| 432 | grants this capability to debugfs.plugin automatically. The module |
| 433 | detects missing privileges and disables itself gracefully. |
| 434 | default_behavior: |
| 435 | auto_detection: |
| 436 | description: > |
| 437 | Automatically detects and monitors the Linux audit subsystem when |
| 438 | the kernel supports NETLINK_AUDIT. Gracefully disables itself if |
| 439 | audit is not available. |
| 440 | limits: |
| 441 | description: '' |
| 442 | performance_impact: |
| 443 | description: > |
| 444 | Minimal. Performs a single netlink query per collection cycle. |
| 445 | No file I/O, no process forking. |
| 446 | setup: |
| 447 | prerequisites: |
| 448 | list: |
| 449 | - title: 'Linux kernel with audit support' |
| 450 | description: > |
| 451 | The Linux kernel must have audit support enabled (CONFIG_AUDIT=y). |
| 452 | Most distribution kernels include this by default. |
| 453 | configuration: |
| 454 | file: |
| 455 | name: 'netdata.conf' |
| 456 | section_name: '[plugin:debugfs]' |
| 457 | description: 'This is netdata main configuration file.' |
| 458 | options: |
| 459 | description: '' |
| 460 | folding: |
| 461 | title: 'Config options' |
| 462 | enabled: true |
| 463 | list: |
| 464 | - name: update every |
| 465 | description: Data collection frequency. |
| 466 | default_value: 1 |
| 467 | required: false |
| 468 | examples: |
| 469 | folding: |
| 470 | enabled: true |
| 471 | title: '' |
| 472 | list: [] |
| 473 | troubleshooting: |
| 474 | problems: |
| 475 | list: [] |
| 476 | alerts: |
| 477 | - name: audit_backlog_utilization |
| 478 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/audit.conf |
| 479 | metric: audit.backlog_utilization |
| 480 | info: > |
| 481 | Linux audit backlog utilization has exceeded the warning threshold |
| 482 | while failure mode is set to panic. Kernel panic is imminent if |
| 483 | backlog overflows. |
| 484 | - name: audit_lost_events |
| 485 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/audit.conf |
| 486 | metric: audit.lost |
| 487 | info: > |
| 488 | Linux audit subsystem is losing events (backlog overflow, rate |
| 489 | limiting, or memory pressure). |
| 490 | metrics: |
| 491 | folding: |
| 492 | title: Metrics |
| 493 | enabled: false |
| 494 | description: "Monitor the Linux kernel audit subsystem status and backlog health." |
| 495 | availability: [] |
| 496 | scopes: |
| 497 | - name: global |
| 498 | description: "Audit subsystem status for the entire system." |
| 499 | labels: [] |
| 500 | metrics: |
| 501 | - name: audit.backlog |
| 502 | description: Audit Backlog |
| 503 | unit: "events" |
| 504 | chart_type: stacked |
| 505 | dimensions: |
| 506 | - name: used |
| 507 | - name: free |
| 508 | - name: audit.backlog_utilization |
| 509 | description: Audit Backlog Utilization |
| 510 | unit: "%" |
| 511 | chart_type: area |
| 512 | dimensions: |
| 513 | - name: utilization |
| 514 | - name: audit.lost |
| 515 | description: Audit Lost Events |
| 516 | unit: "events/s" |
| 517 | chart_type: area |
| 518 | dimensions: |
| 519 | - name: lost |
| 520 | - name: audit.enabled |
| 521 | description: Audit Enabled State |
| 522 | unit: "state" |
| 523 | chart_type: line |
| 524 | dimensions: |
| 525 | - name: disabled |
| 526 | - name: enabled |
| 527 | - name: immutable |
| 528 | - name: audit.failure |
| 529 | description: Audit Failure Mode |
| 530 | unit: "state" |
| 531 | chart_type: line |
| 532 | dimensions: |
| 533 | - name: silent |
| 534 | - name: printk |
| 535 | - name: panic |