Skip to content

Commit dca19a0

Browse files
authored
Merge pull request #1752 from fluent/lynettemiles/sc-136185/update-fluent-bit-docs-pipeline-inputs-memory
2 parents 01e4438 + 4f06d4e commit dca19a0

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

pipeline/inputs/memory-metrics.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
1-
# Memory Metrics
1+
# Memory metrics
22

3-
The **mem** input plugin, gathers the information about the memory and swap usage of the running system every certain interval of time and reports the total amount of memory and the amount of free available.
3+
The _Memory_ (`mem`) input plugin gathers information about the memory and swap usage of the running system every certain interval of time and reports the total amount of memory and the amount of free available.
44

5-
## Getting Started
5+
## Get started
66

7-
In order to get memory and swap usage from your system, you can run the plugin from the command line or through the configuration file:
7+
To get memory and swap usage from your system, you can run the plugin from the command line or through the configuration file:
88

9-
### Command Line
9+
### Command line
10+
11+
Run the following command from the command line:
1012

1113
```bash
12-
$ fluent-bit -i mem -t memory -o stdout -m '*'
14+
fluent-bit -i mem -t memory -o stdout -m '*'
15+
```
16+
17+
Which outputs information similar to:
18+
19+
```text
1320
Fluent Bit v1.x.x
1421
* Copyright (C) 2019-2020 The Fluent Bit Authors
1522
* Copyright (C) 2015-2018 Treasure Data
@@ -28,12 +35,13 @@ Fluent Bit v1.x.x
2835
You can enable the `threaded` setting to run this input in its own
2936
[thread](../../administration/multithreading.md#inputs).
3037

31-
### Configuration File
38+
### Configuration file
3239

33-
In your main configuration file append the following _Input_ & _Output_ sections:
40+
In your main configuration file append the following `Input` and `Output` sections:
3441

3542
{% tabs %}
3643
{% tab title="fluent-bit.conf" %}
44+
3745
```python
3846
[INPUT]
3947
Name mem
@@ -43,9 +51,11 @@ In your main configuration file append the following _Input_ & _Output_ sections
4351
Name stdout
4452
Match *
4553
```
54+
4655
{% endtab %}
4756

4857
{% tab title="fluent-bit.yaml" %}
58+
4959
```yaml
5060
pipeline:
5161
inputs:
@@ -55,5 +65,6 @@ pipeline:
5565
- name: stdout
5666
match: '*'
5767
```
68+
5869
{% endtab %}
5970
{% endtabs %}

0 commit comments

Comments
 (0)