Skip to content

Add doc blurb about using fan_out for more summary statistics - #452

Draft
afcollins wants to merge 1 commit into
cloud-bulldozer:mainfrom
afcollins:docs-fan-out-aggs
Draft

Add doc blurb about using fan_out for more summary statistics#452
afcollins wants to merge 1 commit into
cloud-bulldozer:mainfrom
afcollins:docs-fan-out-aggs

Conversation

@afcollins

Copy link
Copy Markdown
Member

Type of change

  • Documentation Update

Description

Adds a note about how to use fan_out to collect more stats on a metric.

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.

@openshift-ci

openshift-ci Bot commented Aug 3, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign mukrishn for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 83f3e60b-81bb-4d06-b423-708fcad7c7ea

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@afcollins
afcollins marked this pull request as draft August 3, 2026 19:17
@afcollins

Copy link
Copy Markdown
Member Author

I noticed this actually uncovered a bug or unexpected behavior, so I will update or raise a new PR with the fix.

Comment thread docs/configuration.md

This will return data that looks like the following table output:
```
time uuid ocpVersion nodeMajorFaults-avg_avg nodeMajorFaults-min_min nodeMajorFaults-max_max

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The duplication is ugly, but required or else we only get the last result metric.

I have a plan for a fix, but haven't prepared the fix yet, since this is a simple workaround.

Comment thread docs/configuration.md
agg:
agg_type: ${ag}
fan_out:
- ag: avg

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

If the key is agg or agg_type it can cause unexpected errors. Maybe we could validate the fan_out block for known keywords?

@afcollins
afcollins force-pushed the docs-fan-out-aggs branch 2 times, most recently from d522972 to 860edeb Compare August 12, 2026 17:01
Signed-off-by: Andrew Collins <ancollin@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant