| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/integrations/zram.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml" |
| 4 | sidebar_label: "ZRAM" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Operating Systems" |
| 7 | keywords: ['zram'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # ZRAM |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/microchip.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: proc.plugin |
| 18 | Module: /sys/block/zram |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | zRAM, or compressed RAM, is a block device that uses a portion of your system's RAM as a block device. |
| 25 | The data written to this block device is compressed and stored in memory. |
| 26 | |
| 27 | The collectors provides information about the operation and the effectiveness of zRAM on your system. |
| 28 | |
| 29 | |
| 30 | |
| 31 | |
| 32 | This collector is supported on all platforms. |
| 33 | |
| 34 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 35 | |
| 36 | |
| 37 | ### Default Behavior |
| 38 | |
| 39 | #### Auto-Detection |
| 40 | |
| 41 | This integration doesn't support auto-detection. |
| 42 | |
| 43 | #### Limits |
| 44 | |
| 45 | The default configuration for this integration does not impose any limits on data collection. |
| 46 | |
| 47 | #### Performance Impact |
| 48 | |
| 49 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 50 | |
| 51 | ## Setup |
| 52 | |
| 53 | |
| 54 | ### Prerequisites |
| 55 | |
| 56 | No action required. |
| 57 | |
| 58 | ### Configuration |
| 59 | |
| 60 | #### Options |
| 61 | |
| 62 | |
| 63 | |
| 64 | There are no configuration options. |
| 65 | |
| 66 | |
| 67 | |
| 68 | #### via File |
| 69 | |
| 70 | There is no configuration file. |
| 71 | |
| 72 | ##### Examples |
| 73 | There are no configuration examples. |
| 74 | |
| 75 | |
| 76 | |
| 77 | ## Alerts |
| 78 | |
| 79 | There are no alerts configured by default for this integration. |
| 80 | |
| 81 | |
| 82 | ## Metrics |
| 83 | |
| 84 | Metrics grouped by *scope*. |
| 85 | |
| 86 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 87 | |
| 88 | |
| 89 | |
| 90 | ### Per zram device |
| 91 | |
| 92 | |
| 93 | |
| 94 | Labels: |
| 95 | |
| 96 | | Label | Description | |
| 97 | |:-----------|:----------------| |
| 98 | | device | TBD | |
| 99 | |
| 100 | Metrics: |
| 101 | |
| 102 | | Metric | Dimensions | Unit | |
| 103 | |:------|:----------|:----| |
| 104 | | mem.zram_usage | compressed, metadata | MiB | |
| 105 | | mem.zram_savings | savings, original | MiB | |
| 106 | | mem.zram_ratio | ratio | ratio | |
| 107 | | mem.zram_efficiency | percent | percentage | |
| 108 | |
| 109 |