Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update docs for structured metadata blooms #14555

Merged
merged 10 commits into from
Oct 24, 2024

Conversation

rfratto
Copy link
Member

@rfratto rfratto commented Oct 21, 2024

What this PR does / why we need it:

  1. Remove remaining references to the removed Bloom Compactor component.
  2. Update Query Acceleration with Blooms topic to describe structured metadata blooms.

Documentation for how to configure the new bloom components has been temporarily removed as we are still actively making changes to the architecture.

Which issue(s) this PR fixes:
Closes #14414

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

The bloom compactor component has been removed in favor of the bloom
planner/builder/gateway, none of which use hash rings.
Replace references to bloom compactor with the new bloom planner and
bloom builder components.
@rfratto rfratto requested a review from a team as a code owner October 21, 2024 13:18
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Oct 21, 2024
Copy link
Contributor

@salvacorts salvacorts left a comment

Choose a reason for hiding this comment

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

👏 LGTM

Update the Query Acceleration with Blooms topic to reference structured
metadata blooms over the removed line blooms.

Documentation on how to configure bloom components has been temporarily
removed while the architecture is still under active changes.
@rfratto rfratto force-pushed the docs-structured-metadata-blooms branch from 6c94ad6 to 0117f2b Compare October 21, 2024 13:24
@rfratto rfratto force-pushed the docs-structured-metadata-blooms branch from a8acc16 to 4561c6f Compare October 22, 2024 14:10
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team]

docs/sources/operations/query-acceleration-blooms.md Outdated Show resolved Hide resolved
docs/sources/operations/query-acceleration-blooms.md Outdated Show resolved Hide resolved
docs/sources/operations/query-acceleration-blooms.md Outdated Show resolved Hide resolved
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] Just a few small tweaks, but otherwise LGTM. Moving the query section should really improve findability for that information. And I like that you linked to the section from the main bloom filters topic. 👍

docs/sources/operations/bloom-filters.md Outdated Show resolved Hide resolved
docs/sources/operations/bloom-filters.md Outdated Show resolved Hide resolved
docs/sources/operations/bloom-filters.md Outdated Show resolved Hide resolved
Co-authored-by: J Stickler <julie.stickler@grafana.com>
@JStickler
Copy link
Contributor

Oh, one last thing, do we need to backport this to any of the branches, for example does this need to be published to 3.2? Or is this just going into the "next" release?

@rfratto
Copy link
Member Author

rfratto commented Oct 24, 2024

Oh, one last thing, do we need to backport this to any of the branches, for example does this need to be published to 3.2? Or is this just going into the "next" release?

Good question, I'm pretty sure that all of our bloom changes weren't backported to 3.2, so I think keeping this in next is the right move.

cc @salvacorts @chaudum for final confirmation (I'll backport after merging if necessary)

@rfratto rfratto force-pushed the docs-structured-metadata-blooms branch from cbb8bc8 to 83d7929 Compare October 24, 2024 17:30
@rfratto rfratto merged commit fd5de10 into grafana:main Oct 24, 2024
61 checks passed
@rfratto rfratto deleted the docs-structured-metadata-blooms branch October 24, 2024 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated Query Acceleration with Blooms Doc
4 participants