Skip to content

docs: processors: cumulative-to-delta: add new processor documentation#2479

Merged
eschabell merged 2 commits intofluent:masterfrom
eschabell:erics_processors_cumulative_to_delta_new
Mar 20, 2026
Merged

docs: processors: cumulative-to-delta: add new processor documentation#2479
eschabell merged 2 commits intofluent:masterfrom
eschabell:erics_processors_cumulative_to_delta_new

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 19, 2026

  - Add pipeline/processors/cumulative-to-delta.md for the new
    processor_cumulative_to_delta plugin
  - Document all five config options: initial_value, drop_first,
    drop_on_reset, max_staleness, max_series
  - Explain what gets converted (monotonic sums, histograms, exp
    histograms) and what passes through (non-monotonic sums, gauges)
  - Document reset detection, out-of-order sample dropping, and
    staleness/memory eviction behavior
  - Add configuration examples for auto, keep, and drop_first modes
  - Add SUMMARY.md entry alphabetically within the Processors section

  Fixes #2478

Summary by CodeRabbit

  • Documentation
    • Added documentation for the Cumulative to Delta processor, including configuration options, metric conversion behavior, reset detection handling, sample management, state eviction controls, and usage examples.

  - Add SUMMARY.md entry alphabetically within the Processors section
    for Cumulative to delta doc

  Applies to fluent#2478

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 19, 2026
@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Mar 19, 2026
@eschabell eschabell requested a review from a team as a code owner March 19, 2026 17:45
@eschabell eschabell added the 5.0 label Mar 19, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 2026

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minutes and 34 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b3cc5171-8567-496c-92e6-62462b19f8b8

📥 Commits

Reviewing files that changed from the base of the PR and between 6b22239 and 352d80f.

📒 Files selected for processing (1)
  • pipeline/processors/cumulative-to-delta.md
📝 Walkthrough

Walkthrough

This PR adds documentation for a new "cumulative to delta" metrics processor that converts cumulative monotonic metric types into delta-style values. The addition includes updating the table of contents and providing a comprehensive reference document with configuration parameters and examples.

Changes

Cohort / File(s) Summary
Documentation & Navigation
SUMMARY.md, pipeline/processors/cumulative-to-delta.md
Added new processor documentation file describing cumulative-to-delta conversion functionality, including configuration parameters (initial_value, drop_first, drop_on_reset, max_staleness, max_series), reset detection behavior, and two YAML configuration examples. Updated SUMMARY.md to link the new documentation entry under Processors.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Metrics that climb now dance and leap,
From cumulative heights to deltas deep,
With config in hand and examples so clear,
The processor's story now shines bright here!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for a new processor (cumulative-to-delta) with appropriate scope prefix (docs: processors:).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@pipeline/processors/cumulative-to-delta.md`:
- Around line 91-107: The YAML examples for the cumulative_to_delta processor
are partial fragments and may be mistaken for full configs; update the
documentation around the two snippets to say they are fragment overrides to be
placed inside an input's processors.metrics block (or expand each into a minimal
surrounding context showing an input -> processors -> metrics -> - name:
cumulative_to_delta block), and mention the relevant keys (cumulative_to_delta,
processors.metrics, initial_value, drop_first) so readers know where to insert
them.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f7d5dd05-9c22-4ab2-ac0f-7038d6392bb3

📥 Commits

Reviewing files that changed from the base of the PR and between 21b6f3c and 6b22239.

📒 Files selected for processing (2)
  • SUMMARY.md
  • pipeline/processors/cumulative-to-delta.md

@eschabell eschabell force-pushed the erics_processors_cumulative_to_delta_new branch 2 times, most recently from a9f05d4 to 1daea67 Compare March 19, 2026 17:51
  - Add pipeline/processors/cumulative-to-delta.md for the new
    processor_cumulative_to_delta plugin
  - Document all five config options: initial_value, drop_first,
    drop_on_reset, max_staleness, max_series
  - Explain what gets converted (monotonic sums, histograms, exp
    histograms) and what passes through (non-monotonic sums, gauges)
  - Document reset detection, out-of-order sample dropping, and
    staleness/memory eviction behavior
  - Add configuration examples for auto, keep, and drop_first modes
  - Expand partial YAML examples into full configs

  Applies to fluent#2487

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_processors_cumulative_to_delta_new branch from 1daea67 to 352d80f Compare March 19, 2026 17:54
@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@eschabell
Copy link
Collaborator Author

@patrick-stephens and @lecaros and @cosmo0920 This is a new plugin we are adding for processing, could use a review to make sure I did not miss anything?

@eschabell eschabell merged commit b215c0c into fluent:master Mar 20, 2026
8 checks passed
@eschabell eschabell deleted the erics_processors_cumulative_to_delta_new branch March 20, 2026 18:27
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants