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

feat: Extract task computing into a strategy interface #13690

Merged
merged 3 commits into from
Oct 17, 2024

Conversation

salvacorts
Copy link
Contributor

@salvacorts salvacorts commented Jul 29, 2024

What this PR does / why we need it:

We currently plan tasks by dividing the FP keyspace into a configurable number of equally-sized splits (bloom_split_series_keyspace_by per-tenant config).

We want to be able to implement new strategies and make them configurable. In this PR we extract the current planning to a new strategy pkg and create a factory to make the strategy configurable.

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

@salvacorts salvacorts force-pushed the salvacorts/blooms/planning-tsdb branch from 9613863 to 46e36ca Compare July 29, 2024 11:29
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jul 29, 2024
@salvacorts salvacorts force-pushed the salvacorts/blooms/planning-tsdb branch 2 times, most recently from 82bda3c to 55c25a4 Compare July 29, 2024 11:44
@salvacorts salvacorts marked this pull request as ready for review July 29, 2024 13:26
@salvacorts salvacorts requested a review from a team as a code owner July 29, 2024 13:26
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 LGTM

# Conflicts:
#	pkg/bloombuild/planner/planner_test.go
#	pkg/validation/limits.go
@salvacorts salvacorts force-pushed the salvacorts/blooms/planning-tsdb branch from 55c25a4 to 4c7218b Compare October 16, 2024 11:39
# Experimental. Bloom planning strategy to use in bloom creation. Can be one of:
# 'split'
# CLI flag: -bloom-build.planning-strategy
[bloom_planning_strategy: <string> | default = "split"]
Copy link
Contributor

Choose a reason for hiding this comment

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

nit, but IMO "split" is too generic for a planning strategy.

I'd rather call it "split_by_series_count", "split_by_series_keyspace", "split_by_series_volume", etc, or short without the "split_by_" prefix.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Renamed to split_keyspace_by_factor

@@ -0,0 +1,245 @@
package splitkeyspace
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Is is really necessary to make a separate package for each individual strategy?

Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

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

Not much to add, but +1 to everything @chaudum mentioned

ctx context.Context,
table config.DayTable,
tenant string,
tsdbs map[tsdb.SingleTenantTSDBIdentifier]common.ClosableForSeries,
Copy link
Member

Choose a reason for hiding this comment

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

nit: If we create a type alias we could avoid putting each parameter on its own line:

type TSDBSet = map[tsdb.SingleTenantTSDBIdentifier]common.ClosableForSeries

@salvacorts salvacorts merged commit ab5e6ea into main Oct 17, 2024
61 checks passed
@salvacorts salvacorts deleted the salvacorts/blooms/planning-tsdb branch October 17, 2024 11:59
rfratto added a commit to rfratto/loki that referenced this pull request Oct 17, 2024
Use require.ElementsMatch in tests to permit plans having a different
order; this is what the tests did prior to refactoring in grafana#13690.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XXL 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.

4 participants