Add unbounded-collector warning to the resource collectors page#390
Merged
Conversation
tuxmea
reviewed
Jul 3, 2026
|
|
||
| {% include alert.html type="warning" content="Do not use unbounded resource collectors without search expressions to limit which resources match. | ||
| They have a side effect of _realizing_ any matching virtual resources whether declared in your own code or in third party modules. | ||
| Using unbounded collectors may result in many unexpected resources being managed and may have catastrophic consequences." %} |
Contributor
There was a problem hiding this comment.
Instead of "and may have catastrophic consequences" maybe use "and may have unforeseeable consequences like undesired configuration changes"?
Contributor
Author
There was a problem hiding this comment.
yeah, I was thinking the same, "catastrophic consequences" is vague but ominous :)
The warning added to lang_relationships.markdown in OpenVoxProject#334 also belongs on the dedicated collectors page, which states that an empty search expression matches every resource of the type but never cautions against relying on it. Closes OpenVoxProject#389 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
Replace "catastrophic consequences" with "unforeseeable consequences like undesired configuration changes" as suggested by tuxmea, and apply the same wording to the original warning in lang_relationships.markdown so the two copies stay identical. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
miharp
force-pushed
the
docs/collector-warning-389
branch
from
9e37bf6 to
caa7b64
Compare
tuxmea
approved these changes
Jul 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the unbounded-resource-collector warning from
lang_relationships.markdown(added in #334) to the dedicated collectors page,lang_collectors.markdown.The collectors page already states that "A collector with an empty search expression will match every resource of the specified resource type," but only as a neutral fact. Since that page is the natural landing spot for someone looking up collector syntax, it should carry the same caution: unbounded collectors realize every matching virtual resource, including ones declared in third-party modules, which can have unforeseeable consequences like undesired configuration changes.
The warning text is identical to the one on the relationships page, placed directly after the empty-search-expression statement in the Search expressions section. Per review feedback, the closing phrase was reworded from "catastrophic consequences" to "unforeseeable consequences like undesired configuration changes" — applied to the original warning in
lang_relationships.markdownas well, so the two copies stay identical.Verified with a local
jekyll build: the alert renders as a standard warning block onopenvox/latest/lang_collectors.html.Closes #389