feat(blooms): Add bloom planner and bloom builder to `backend` target #13997

chaudum · 2024-08-29T12:05:04Z

What this PR does / why we need it:

Previously, the bloom compactor component was part of the backend target in the Simple Scalable Deployment (SSD) mode. However, the bloom compactor was removed (#13969) in favour of planner and builder, and therefore also removed from the backend target.

This PR adds the planner and builder components to the backend target so it can continue building blooms if enabled.

Special notes for your reviewer:

The planner needs to be run as singleton, therefore there must only be one instance that creates tasks for the builders, even if multiple replicas of the backend target are deployed.
This is achieved by leader election through the already existing index gateway ring in the backend target. The planner leader is determined by the ownership of the leader key. Builders connect to the planner leader to pull tasks.

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
For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
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

paul1r · 2024-08-30T16:08:31Z

docs/sources/operations/query-acceleration-blooms.md

@@ -43,8 +43,8 @@ and querying the bloom filters that only pays off at large scale deployments.
 {{< /admonition >}}

 To start building and using blooms you need to:
- Deploy the [Bloom Planner and Builder](#bloom-planner-and-builder) components and enable the component in the [Bloom Build config][bloom-build-cfg].
- Deploy the [Bloom Gateway](#bloom-gateway) component (as a [microservice][microservices] or via the [SSD][ssd] Backend target) and enable the component in the [Bloom Gateway config][bloom-gateway-cfg].
+- Deploy the [Bloom Planner and Builder](#bloom-planner-and-builder) components (as a [microservic][microservices] or via the [SSD][ssd] `backend` target) and enable the components in the [Bloom Build config][bloom-build-cfg].


Nit: microservice

paul1r · 2024-08-30T16:11:06Z

pkg/bloombuild/planner/planner.go

-	if err := p.runOne(ctx); err != nil {
-		level.Error(p.logger).Log("msg", "bloom build iteration failed for the first time", "err", err)
-	}
+	// run once at beginning, but deplay by 1m to allow ring consolidation when running in SSD mode


nit: deplay -> delay

paul1r · 2024-08-30T16:14:03Z

pkg/bloombuild/planner/planner.go

@@ -901,6 +934,11 @@ func (p *Planner) BuilderLoop(builder protos.PlannerForBuilder_BuilderLoopServer

 	builderID := resp.GetBuilderID()
 	logger := log.With(p.logger, "builder", builderID)
+
+	if !p.isLeader() {
+		return fmt.Errorf("planner is not leader")


Should this be errPlannerIsNotLeader?

salvacorts · 2024-09-02T07:12:51Z

pkg/bloombuild/planner/planner.go

-	if err := p.runOne(ctx); err != nil {
-		level.Error(p.logger).Log("msg", "bloom build iteration failed for the first time", "err", err)
-	}
+	// run once at beginning, but delay by 1m to allow ring consolidation when running in SSD mode


I think this ticker could be replaced with a simpler time.Sleep at the beginning of the function if the ringWatcher is not null.

time.Sleep, time.After, and time.NewTimer do essentially the same, but since we already have a select loop, I think it's cleaner to avoid time.Sleep.

To me, a sleep is easier to understand as I don't need to think about which select will trigger earlier. But I don't have a strong opinion on this. Approved.

in simple scalable deployment Signed-off-by: Christian Haudum <christian.haudum@gmail.com>

…#13997) Previously, the bloom compactor component was part of the `backend` target in the Simple Scalable Deployment (SSD) mode. However, the bloom compactor was removed (#13969) in favour of planner and builder, and therefore also removed from the backend target. This PR adds the planner and builder components to the backend target so it can continue building blooms if enabled. The planner needs to be run as singleton, therefore there must only be one instance that creates tasks for the builders, even if multiple replicas of the backend target are deployed. This is achieved by leader election through the already existing index gateway ring in the backend target. The planner leader is determined by the ownership of the leader key. Builders connect to the planner leader to pull tasks. ---- Signed-off-by: Christian Haudum <christian.haudum@gmail.com> (cherry picked from commit bf60455)

pull-request-size bot added the size/L label Aug 29, 2024

github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Aug 29, 2024

chaudum marked this pull request as ready for review August 29, 2024 12:08

chaudum requested a review from a team as a code owner August 29, 2024 12:08

chaudum added the feature/blooms label Aug 29, 2024

paul1r reviewed Aug 30, 2024

View reviewed changes

salvacorts reviewed Sep 2, 2024

View reviewed changes

salvacorts approved these changes Sep 2, 2024

View reviewed changes

Add bloom planner and bloom builder to backend target

be9eb50

in simple scalable deployment Signed-off-by: Christian Haudum <christian.haudum@gmail.com>

chaudum force-pushed the chaudum/bloom-planner-builder-simple-scalable-deployment branch from 6ab3715 to be9eb50 Compare September 2, 2024 07:52

chaudum merged commit bf60455 into main Sep 2, 2024
61 checks passed

chaudum deleted the chaudum/bloom-planner-builder-simple-scalable-deployment branch September 2, 2024 08:02

chaudum added the backport k218 label Sep 10, 2024

grafanabot mentioned this pull request Sep 10, 2024

chore: [k218] feat(blooms): Add bloom planner and bloom builder to backend target #14092

Merged

7 tasks

loki-gh-app bot mentioned this pull request Sep 23, 2024

chore(k221): release 3.2.0 #14214

Open

loki-gh-app bot mentioned this pull request Sep 30, 2024

chore(k222): release 3.2.0 #14305

Open

loki-gh-app bot mentioned this pull request Oct 7, 2024

chore(k223): release 3.2.0 #14402

Open

This was referenced Oct 14, 2024

chore(k224): release 3.2.0 #14486

Open

chore(k225): release 3.2.0 #14543

Closed

loki-gh-app bot mentioned this pull request Oct 21, 2024

chore(k225): release 3.2.0 #14548

Open

JStickler mentioned this pull request Oct 21, 2024

docs: Update docs for structured metadata blooms #14555

Merged

6 tasks

loki-gh-app bot mentioned this pull request Oct 28, 2024

chore(k226): release 3.2.0 #14625

Open

loki-gh-app bot mentioned this pull request Nov 4, 2024

chore(k227): release 3.3.0 #14750

Merged

loki-gh-app bot mentioned this pull request Nov 11, 2024

chore(k228): release 3.2.0 #14855

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(blooms): Add bloom planner and bloom builder to `backend` target #13997

feat(blooms): Add bloom planner and bloom builder to `backend` target #13997

chaudum commented Aug 29, 2024 •

edited

Loading

paul1r Aug 30, 2024

paul1r Aug 30, 2024

paul1r Aug 30, 2024

salvacorts Sep 2, 2024

chaudum Sep 2, 2024

salvacorts Sep 2, 2024

feat(blooms): Add bloom planner and bloom builder to backend target #13997

feat(blooms): Add bloom planner and bloom builder to backend target #13997

Conversation

chaudum commented Aug 29, 2024 • edited Loading

paul1r Aug 30, 2024

Choose a reason for hiding this comment

paul1r Aug 30, 2024

Choose a reason for hiding this comment

paul1r Aug 30, 2024

Choose a reason for hiding this comment

salvacorts Sep 2, 2024

Choose a reason for hiding this comment

chaudum Sep 2, 2024

Choose a reason for hiding this comment

salvacorts Sep 2, 2024

Choose a reason for hiding this comment

feat(blooms): Add bloom planner and bloom builder to `backend` target #13997

feat(blooms): Add bloom planner and bloom builder to `backend` target #13997

chaudum commented Aug 29, 2024 •

edited

Loading