in_mem_metrics: initial documentation. #1170
Conversation
This adds documentation for the new `in_mem_metrics` plugin: fluent/fluent-bit#7615. Signed-off-by: Phillip Whelan <[email protected]>
|
@patrick-stephens should I add a specific example for using docker to log metrics for kubernetes nodes? |
I don't really understand so probably :) Although why would you use it over node exporter, kubelet metrics, etc. is probably the main question I'd have? Be good to have an example of what it provides in addition. |
The main reason to use it over those options is granularity. This plugin grabs the memory usage of each individual process and various different types, ie: shared, etc... If you want to be able to correctly diagnose which process is actually leaking this would be what you need to be able to discern that correctly. |
|
@esmerel would you give this a docs review please? Still waiting on code merge PR fluent/fluent-bit#7615, but I've given that a nudge. |
eschabell
added
the
waiting-for-user
|
@pwhelan we have some review suggestions for your attention. |
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| The _mem_metrics_, or memory metrics plugin, generates metrics for memory statistics for processes using the `smaps_rollup` file for each process in /proc. This plugin works exclusively on Linux. | ||
|
|
||
| # Configuration parameters |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Configuration parameters"]
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
Co-authored-by: Lynette Miles <[email protected]> Signed-off-by: Phillip Whelan <[email protected]>
|
|
||
| All metrics are logged as gauges since they can both increase and decrease. Supported gauges are: | ||
|
|
||
| - node_smaps_rollup_rss |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
| All metrics are logged as gauges since they can both increase and decrease. Supported gauges are: | ||
|
|
||
| - node_smaps_rollup_rss | ||
| - node_smaps_rollup_pss |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
|
|
||
| - node_smaps_rollup_rss | ||
| - node_smaps_rollup_pss | ||
| - type=clean |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
| - node_smaps_rollup_rss | ||
| - node_smaps_rollup_pss | ||
| - type=clean | ||
| - type=dirty |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
| - node_smaps_rollup_pss | ||
| - type=clean | ||
| - type=dirty | ||
| - type=anon |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4]
| - node_smaps_rollup_anon_huge_pages | ||
| - node_smaps_rollup_shmem_pmd_mapped | ||
| - node_smaps_rollup_file_pmd_mapped | ||
| - node_smaps_rollup_shared_hugetlb |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
| - node_smaps_rollup_shmem_pmd_mapped | ||
| - node_smaps_rollup_file_pmd_mapped | ||
| - node_smaps_rollup_shared_hugetlb | ||
| - node_smaps_rollup_private_hugetlb |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
| - node_smaps_rollup_file_pmd_mapped | ||
| - node_smaps_rollup_shared_hugetlb | ||
| - node_smaps_rollup_private_hugetlb | ||
| - node_smaps_rollup_swap |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
| - node_smaps_rollup_shared_hugetlb | ||
| - node_smaps_rollup_private_hugetlb | ||
| - node_smaps_rollup_swap | ||
| - node_smaps_rollup_swap_pss |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
| - node_smaps_rollup_private_hugetlb | ||
| - node_smaps_rollup_swap | ||
| - node_smaps_rollup_swap_pss | ||
| - node_smaps_rollup_locked |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
| - node_smaps_rollup_rss | ||
| - node_smaps_rollup_pss |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| - node_smaps_rollup_rss | |
| - node_smaps_rollup_pss | |
| - node_smaps_rollup_rss | |
| - node_smaps_rollup_pss | |
| - type=clean | |
| - type=dirty | |
| - type=anon | |
| - type=file | |
| - type=shmem | |
| - node_smaps_rollup_shared |
| - type=anon | ||
| - type=file | ||
| - type=shmem | ||
| - node_smaps_rollup_shared | ||
| - type=clean | ||
| - type=dirty | ||
| - node_smaps_rollup_private |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| - type=anon | |
| - type=file | |
| - type=shmem | |
| - node_smaps_rollup_shared | |
| - type=clean | |
| - type=dirty | |
| - node_smaps_rollup_private | |
| - node_smaps_rollup_private |
| - node_smaps_rollup_referenced | ||
| - node_smaps_rollup_anonymous | ||
| - node_smaps_rollup_lazy_free | ||
| - node_smaps_rollup_anon_huge_pages | ||
| - node_smaps_rollup_shmem_pmd_mapped | ||
| - node_smaps_rollup_file_pmd_mapped | ||
| - node_smaps_rollup_shared_hugetlb | ||
| - node_smaps_rollup_private_hugetlb | ||
| - node_smaps_rollup_swap | ||
| - node_smaps_rollup_swap_pss | ||
| - node_smaps_rollup_locked |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| - node_smaps_rollup_referenced | |
| - node_smaps_rollup_anonymous | |
| - node_smaps_rollup_lazy_free | |
| - node_smaps_rollup_anon_huge_pages | |
| - node_smaps_rollup_shmem_pmd_mapped | |
| - node_smaps_rollup_file_pmd_mapped | |
| - node_smaps_rollup_shared_hugetlb | |
| - node_smaps_rollup_private_hugetlb | |
| - node_smaps_rollup_swap | |
| - node_smaps_rollup_swap_pss | |
| - node_smaps_rollup_locked | |
| - node_smaps_rollup_referenced | |
| - node_smaps_rollup_anonymous | |
| - node_smaps_rollup_lazy_free | |
| - node_smaps_rollup_anon_huge_pages | |
| - node_smaps_rollup_shmem_pmd_mapped | |
| - node_smaps_rollup_file_pmd_mapped | |
| - node_smaps_rollup_shared_hugetlb | |
| - node_smaps_rollup_private_hugetlb | |
| - node_smaps_rollup_swap | |
| - node_smaps_rollup_swap_pss | |
| - node_smaps_rollup_locked |
This adds documentation for the new
in_mem_metricsplugin: fluent/fluent-bit#7615.