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 <phil@calyptia.com>
|
@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. |
esmerel
left a comment
esmerel
left a comment
There was a problem hiding this comment.
Generally stylistic changes. This looks fairly ok otherwise.
eschabell
added
the
waiting-for-user
|
@pwhelan we have some review suggestions for your attention. |
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Phillip Whelan <pwhelan@exis.cl>
eschabell
added
lint-vale-issues
and removed
waiting-for-user
- Fix 'Fluent Bit' casing (was 'fluent-bit') in body text - Sort configuration parameters table alphabetically - Fix classic config block indentation from 4 spaces to 2 spaces Applies to #1170 Signed-off-by: Eric D. Schabell <eric@schabell.org>
|
Warning Review limit reached
More reviews will be available in 10 minutes and 27 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR adds a new documentation file Changesmem_metrics Plugin Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@pwhelan fixed issues and applied a lot of formatting standards (this was a bit of an older one). |
eschabell
removed
waiting-on-review
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
pipeline/inputs/mem-metrics.md (1)
89-112:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix list indentation throughout metrics section.
The metrics list has inconsistent indentation causing multiple markdownlint violations. Top-level items should have no leading spaces, and sub-items should use 2-space indentation. Additionally, lines 96 and 99 have an extra leading space before the dash.
📝 Proposed fix for consistent indentation
- - node_smaps_rollup_rss - - node_smaps_rollup_pss - - type=clean - - type=dirty - - type=anon - - type=file - - type=shmem - - node_smaps_rollup_shared - - type=clean - - type=dirty - - node_smaps_rollup_private - - type=dirty - - type=clean - - 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_rss +- node_smaps_rollup_pss + - type=clean + - type=dirty + - type=anon + - type=file + - type=shmem +- node_smaps_rollup_shared + - type=clean + - type=dirty +- node_smaps_rollup_private + - type=dirty + - type=clean +- 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🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pipeline/inputs/mem-metrics.md` around lines 89 - 112, The metrics list under the mem-metrics section has inconsistent indentation: normalize all top-level metric items (e.g., node_smaps_rollup_rss, node_smaps_rollup_pss, node_smaps_rollup_shared, node_smaps_rollup_private, node_smaps_rollup_referenced, etc.) so they start with no leading spaces before the dash, and indent their sub-items (the type=... lines) with exactly two spaces before the dash; also remove the stray extra space before the dash that appears on the lines for node_smaps_rollup_pss and node_smaps_rollup_private to ensure consistent 0-space top-level and 2-space nested-item indentation throughout.
🧹 Nitpick comments (2)
pipeline/inputs/mem-metrics.md (2)
1-1: ⚡ Quick winRemove trailing space from title.
The title has a trailing space that should be removed.
✨ Proposed fix
-# Memory metrics +# Memory metrics🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pipeline/inputs/mem-metrics.md` at line 1, Remove the trailing space from the Markdown title "# Memory metrics " by editing the header line in the file so it reads "# Memory metrics" (no trailing whitespace); ensure the change is applied to the top-level title string to avoid any leftover trailing characters.
11-11: ⚡ Quick winHyphenate compound adjective.
"Comma delimited" should be hyphenated when used as a compound adjective modifying "list".
✍️ Proposed fix
-| `filter_pid` | Filter by comma delimited list of `PIDs`. | **inactive** | +| `filter_pid` | Filter by comma-delimited list of `PIDs`. | **inactive** |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pipeline/inputs/mem-metrics.md` at line 11, In the table row for the `filter_pid` option (the line containing "| `filter_pid` | Filter by comma delimited list of `PIDs`. | **inactive** |"), change the phrase "comma delimited list" to "comma-delimited list" so the compound adjective is hyphenated correctly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@pipeline/inputs/mem-metrics.md`:
- Line 7: Fix the table header typo by removing the stray asterisk: replace the
header string "**Key***" with "**Key**" (the header in the markdown table row
shown by the diff). Ensure the corrected table header maintains the same
pipe-delimited column formatting and spacing as the other headers.
---
Duplicate comments:
In `@pipeline/inputs/mem-metrics.md`:
- Around line 89-112: The metrics list under the mem-metrics section has
inconsistent indentation: normalize all top-level metric items (e.g.,
node_smaps_rollup_rss, node_smaps_rollup_pss, node_smaps_rollup_shared,
node_smaps_rollup_private, node_smaps_rollup_referenced, etc.) so they start
with no leading spaces before the dash, and indent their sub-items (the type=...
lines) with exactly two spaces before the dash; also remove the stray extra
space before the dash that appears on the lines for node_smaps_rollup_pss and
node_smaps_rollup_private to ensure consistent 0-space top-level and 2-space
nested-item indentation throughout.
---
Nitpick comments:
In `@pipeline/inputs/mem-metrics.md`:
- Line 1: Remove the trailing space from the Markdown title "# Memory metrics "
by editing the header line in the file so it reads "# Memory metrics" (no
trailing whitespace); ensure the change is applied to the top-level title string
to avoid any leftover trailing characters.
- Line 11: In the table row for the `filter_pid` option (the line containing "|
`filter_pid` | Filter by comma delimited list of `PIDs`. |
**inactive** |"), change the phrase "comma delimited list" to "comma-delimited
list" so the compound adjective is hyphenated correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: f4ef7f79-3fd9-47b1-8047-a90b49f1fc03
📒 Files selected for processing (1)
pipeline/inputs/mem-metrics.md
- Fix 'Fluent Bit' casing (was 'fluent-bit') in body text - Sort configuration parameters table alphabetically - Fix classic config block indentation from 4 spaces to 2 spaces - Fixed header for config param table Applies to #1170 Signed-off-by: Eric D. Schabell <eric@schabell.org>
eschabell
force-pushed
the
pwhelan-doc-in_mem_metrics
branch
from
83a12dd to
4dae327
Compare
- Fix 'Fluent Bit' casing (was 'fluent-bit') in body text - Sort configuration parameters table alphabetically - Fix classic config block indentation from 4 spaces to 2 spaces - Fixed header for config param table Applies to #1170 Signed-off-by: Eric D. Schabell <eric@schabell.org>
eschabell
force-pushed
the
pwhelan-doc-in_mem_metrics
branch
from
4dae327 to
68fddc1
Compare
5 participants
This adds documentation for the new
in_mem_metricsplugin: fluent/fluent-bit#7615.Summary by CodeRabbit
/procpath), usage examples for command-line and configuration files with Prometheus remote write support, and complete metrics reference with supported label dimensions.