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
11 changes: 0 additions & 11 deletions docs/sources/get-started/hash-rings.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ These components need to be connected into a hash ring:
- query schedulers
- compactors
- rulers
- bloom compactors (Experimental)

These components can optionally be connected into a hash ring:
- index gateway
Expand Down Expand Up @@ -104,13 +103,3 @@ The ruler ring is used to determine which rulers evaluate which rule groups.
## About the index gateway ring

The index gateway ring is used to determine which gateway is responsible for which tenant's indexes when queried by rulers or queriers.

## About the Bloom Compactor ring
{{% admonition type="warning" %}}
This feature is an [experimental feature](/docs/release-life-cycle/). Engineering and on-call support is not available. No SLA is provided.
{{% /admonition %}}

The Bloom Compactor ring is used to determine which subset of compactors own a given tenant,
and which series fingerprint ranges each compactor owns.
The ring is also used to determine which compactor owns retention.
Retention will be applied by the compactor owning the smallest token in the ring.
10 changes: 5 additions & 5 deletions docs/sources/get-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The Docker Compose configuration runs the following components, each in its own
- **Gateway** (nginx) which receives requests and redirects them to the appropriate container based on the request's URL.
- **Loki read component**: which runs a Query Frontend and a Querier.
- **Loki write component**: which runs a Distributor and an Ingester.
- **Loki backend component**: which runs an Index Gateway, Compactor, Ruler, Bloom Compactor (experimental), and Bloom Gateway (experimental).
- **Loki backend component**: which runs an Index Gateway, Compactor, Ruler, Bloom Planner (experimental), Bloom Builder (experimental), and Bloom Gateway (experimental).
- **Minio**: which Loki uses to store its index and chunks.
- **Grafana**: which provides visualization of the log lines captured within Loki.

Expand Down Expand Up @@ -141,9 +141,9 @@ This quickstart assumes you are running Linux.
- You can access the Grafana Alloy UI at [http://localhost:12345](http://localhost:12345).

6. (Optional) You can check all the containers are running by running the following command:

```bash
docker ps -a
docker ps -a
```


Expand Down Expand Up @@ -321,7 +321,7 @@ Within the entrypoint section, the Loki data source is configured with the follo
- `URL: http://gateway:3100` (URL of the Loki data source. Loki uses an nginx gateway to direct traffic to the appropriate component)
- `jsonData.httpHeaderName1: "X-Scope-OrgID"` (header name for the organization ID)
- `secureJsonData.httpHeaderValue1: "tenant1"` (header value for the organization ID)

It is important to note when Loki is configured in any other mode other than monolithic deployment, you are required to pass a tenant ID in the header. Without this, queries will return an authorization error.

<!-- INTERACTIVE page step2.md END -->
Expand All @@ -344,4 +344,4 @@ It's a self-contained environment for learning about Mimir, Loki, Tempo, and Gra
The project includes detailed explanations of each component and annotated configurations for a single-instance deployment.
You can also push the data from the environment to [Grafana Cloud](https://grafana.com/cloud/).

<!-- INTERACTIVE page finish.md END -->
<!-- INTERACTIVE page finish.md END -->
Loading
Loading