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

chore(docs): Rewrite query acceleration docs #13965

Merged
merged 4 commits into from
Aug 27, 2024
Merged

Conversation

chaudum
Copy link
Contributor

@chaudum chaudum commented Aug 26, 2024

What this PR does / why we need it:

The bloom compactor is going to be removed in favour or the bloom planner and bloom builder components.

This commit updates the documentation accordingly and removes outdated references to the bloom compactor.

Special notes for your reviewer:

Part of #13957

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

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Aug 26, 2024
The bloom compactor is going to be removed in favour or the bloom
planner and bloom builder components.

This commit updates the documentation accordingly and removes outdated
references to the bloom compactor.

Signed-off-by: Christian Haudum <[email protected]>
@chaudum chaudum force-pushed the chaudum/bloom-build-docs branch from fad8527 to 4753bce Compare August 27, 2024 06:13
@pull-request-size pull-request-size bot added size/L and removed size/M labels Aug 27, 2024
@chaudum chaudum marked this pull request as ready for review August 27, 2024 06:14
@chaudum chaudum requested a review from a team as a code owner August 27, 2024 06:14
chaudum and others added 3 commits August 27, 2024 09:43
@chaudum chaudum requested a review from JStickler August 27, 2024 08:33
chaudum added a commit that referenced this pull request Aug 27, 2024
This commit removes the code related to the bloom compactor which is
superseded by the bloom planner and builders.

A handful of CLI arguments changed their prefixes from
`-bloom-compactor.*` to `-bloom-build.*`.

Part of #13957

Documentation update #13965

Signed-off-by: Christian Haudum <[email protected]>
@chaudum chaudum merged commit b773896 into main Aug 27, 2024
63 checks passed
@chaudum chaudum deleted the chaudum/bloom-build-docs branch August 27, 2024 14:40
chaudum added a commit that referenced this pull request Aug 27, 2024
This commit removes the code related to the bloom compactor which is
superseded by the bloom planner and builders.

A handful of CLI arguments changed their prefixes from
`-bloom-compactor.*` to `-bloom-build.*`.

Part of #13957

Documentation update #13965

Signed-off-by: Christian Haudum <[email protected]>
chaudum added a commit that referenced this pull request Aug 29, 2024
This commit removes the code related to the bloom compactor which is
superseded by the bloom planner and builders.

A handful of CLI arguments changed their prefixes from
`-bloom-compactor.*` to `-bloom-build.*`.

Part of #13957

Documentation update #13965

Signed-off-by: Christian Haudum <[email protected]>
chaudum added a commit that referenced this pull request Aug 29, 2024
**What this PR does / why we need it**:

This commit removes the code related to the bloom compactor which is superseded by the bloom planner and builders.

A handful of CLI arguments of per-tenant settings changed their prefix from `-bloom-compactor.*` to `-bloom-build.*`. Other settings for the compactor component itself, also prefixed with `-bloom-compactor.*` were removed. See upgrade docs for further information.

**Special notes for your reviewer**:

:heavy_check_mark: Part of #13957

📔 Documentation update #13965

⚠️ Integrating the bloom planner and builder into the `backend` target is done in a follow-up PR.

---

Signed-off-by: Christian Haudum <[email protected]>
pascal-sochacki pushed a commit to pascal-sochacki/loki that referenced this pull request Aug 29, 2024
**What this PR does / why we need it**:

This commit removes the code related to the bloom compactor which is superseded by the bloom planner and builders.

A handful of CLI arguments of per-tenant settings changed their prefix from `-bloom-compactor.*` to `-bloom-build.*`. Other settings for the compactor component itself, also prefixed with `-bloom-compactor.*` were removed. See upgrade docs for further information.

**Special notes for your reviewer**:

:heavy_check_mark: Part of grafana#13957

📔 Documentation update grafana#13965

⚠️ Integrating the bloom planner and builder into the `backend` target is done in a follow-up PR.

---

Signed-off-by: Christian Haudum <[email protected]>
pascal-sochacki pushed a commit to pascal-sochacki/loki that referenced this pull request Aug 29, 2024
The bloom compactor is going to be removed in favour or the bloom planner and bloom builder components.
This commit updates the documentation accordingly and removes outdated references to the bloom compactor.

Signed-off-by: Christian Haudum <[email protected]>
Co-authored-by: Salva Corts <[email protected]>
pascal-sochacki pushed a commit to pascal-sochacki/loki that referenced this pull request Aug 29, 2024
**What this PR does / why we need it**:

This commit removes the code related to the bloom compactor which is superseded by the bloom planner and builders.

A handful of CLI arguments of per-tenant settings changed their prefix from `-bloom-compactor.*` to `-bloom-build.*`. Other settings for the compactor component itself, also prefixed with `-bloom-compactor.*` were removed. See upgrade docs for further information.

**Special notes for your reviewer**:

:heavy_check_mark: Part of grafana#13957

📔 Documentation update grafana#13965

⚠️ Integrating the bloom planner and builder into the `backend` target is done in a follow-up PR.

---

Signed-off-by: Christian Haudum <[email protected]>
pascal-sochacki pushed a commit to pascal-sochacki/loki that referenced this pull request Aug 29, 2024
The bloom compactor is going to be removed in favour or the bloom planner and bloom builder components.
This commit updates the documentation accordingly and removes outdated references to the bloom compactor.

Signed-off-by: Christian Haudum <[email protected]>
Co-authored-by: Salva Corts <[email protected]>
pascal-sochacki pushed a commit to pascal-sochacki/loki that referenced this pull request Aug 29, 2024
**What this PR does / why we need it**:

This commit removes the code related to the bloom compactor which is superseded by the bloom planner and builders.

A handful of CLI arguments of per-tenant settings changed their prefix from `-bloom-compactor.*` to `-bloom-build.*`. Other settings for the compactor component itself, also prefixed with `-bloom-compactor.*` were removed. See upgrade docs for further information.

**Special notes for your reviewer**:

:heavy_check_mark: Part of grafana#13957

📔 Documentation update grafana#13965

⚠️ Integrating the bloom planner and builder into the `backend` target is done in a follow-up PR.

---

Signed-off-by: Christian Haudum <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/blooms size/L 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.

2 participants