summaryrefslogtreecommitdiffstats
path: root/collectors/proc.plugin/integrations/zram.md
blob: 0bcda3eaf8c787f2330ea6f27d2be103bb6f54c5 (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
<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/integrations/zram.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/metadata.yaml"
sidebar_label: "ZRAM"
learn_status: "Published"
learn_rel_path: "Data Collection/Linux Systems/Memory"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# ZRAM


<img src="https://netdata.cloud/img/microchip.svg" width="150"/>


Plugin: proc.plugin
Module: /sys/block/zram

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

zRAM, or compressed RAM, is a block device that uses a portion of your system's RAM as a block device.
The data written to this block device is compressed and stored in memory.

The collectors provides information about the operation and the effectiveness of zRAM on your system.




This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.


### Default Behavior

#### Auto-Detection

This integration doesn't support auto-detection.

#### Limits

The default configuration for this integration does not impose any limits on data collection.

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.


## Metrics

Metrics grouped by *scope*.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.



### Per zram device



Labels:

| Label      | Description     |
|:-----------|:----------------|
| device | TBD |

Metrics:

| Metric | Dimensions | Unit |
|:------|:----------|:----|
| mem.zram_usage | compressed, metadata | MiB |
| mem.zram_savings | savings, original | MiB |
| mem.zram_ratio | ratio | ratio |
| mem.zram_efficiency | percent | percentage |



## Alerts

There are no alerts configured by default for this integration.


## Setup

### Prerequisites

No action required.

### Configuration

#### File

There is no configuration file.
#### Options



There are no configuration options.

#### Examples
There are no configuration examples.