Skip to content

Commit

Permalink
[DOC] Update gRPC compressiong admonition (#4644)
Browse files Browse the repository at this point in the history
Co-authored-by: Joe Elliott <[email protected]>
  • Loading branch information
knylander-grafana and joe-elliott authored Jan 30, 2025
1 parent 2532072 commit c7b435d
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/sources/tempo/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ Tempo 2.7 disabled gRPC compression in the querier and distributor for performan
Benchmark testing suggested that without compression, queriers and distributors used less CPU and memory.

However, you may notice an increase in ingester data and network traffic especially for larger clusters.
This increased data can impact billing for Grafana Cloud.

You can configure the gRPC compression in the `querier`, `ingester`, and `metrics_generator` clients of the distributor.
To re-enable the compression, use `snappy` with the following settings:
Expand Down Expand Up @@ -1620,7 +1621,7 @@ overrides:
# Should not be lower than RF.
[tenant_shard_size: <int> | default = 0]
# Maximum bytes any attribute can be for both keys and values.
# Maximum bytes any attribute can be for both keys and values.
[max_attribute_bytes: <int> | default = 0]
# Read related overrides
Expand Down
23 changes: 23 additions & 0 deletions docs/sources/tempo/release-notes/v2-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ For a complete list, refer to the [Tempo changelog](https://github.com/grafana/t

The most important features and enhancements in Tempo 2.7 are highlighted below.

{{< admonition type="note" >}}
This release disables gRPC compression by default to improve performance.
This change will increase data usage and network traffic, which can impact cloud billing depending on your configuration. Refer to [gRPC compression](#grpc-compression-disabled) for more information.
{{< /admonition >}}

### Track ingested traffic and attribute costs

This new feature lets tenants precisely measure and attribute costs for their ingested trace data by leveraging custom labels.
Expand Down Expand Up @@ -209,7 +214,25 @@ max_spans_per_span_set
This release disables gRPC compression in the querier and distributor for performance reasons. ([#4429](https://github.com/grafana/tempo/pull/4429))
Our benchmark suggests that without compression, queriers and distributors use less CPU and memory.

{{< admonition type="note" >}}
While disabling gRPC compression improves performance, it will increase data usage and network traffic, which can impact cloud billing depending on your configuration.
{{< /admonition >}}

If you notice increased network traffic or issues, check the gRPC compression settings.
You can enable gRPC compression using `snappy`:

```yaml
ingester_client:
grpc_client_config:
grpc_compression: "snappy"
metrics_generator_client:
grpc_client_config:
grpc_compression: "snappy"
querier:
frontend_worker:
grpc_client_config:
grpc_compression: "snappy"
```

Refer to [gRPC compression configuration](https://grafana.com/docs/tempo/<TEMPO_VERSION>/configuration/#grpc-compression) for more information.

Expand Down
6 changes: 4 additions & 2 deletions docs/sources/tempo/setup/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,13 @@ For Jaeger exporting, set `OTEL_TRACES_EXPORTER=jaeger`.For more information, re
This release disables gRPC compression in the querier and distributor for performance reasons. ([#4429](https://github.com/grafana/tempo/pull/4429))
Our benchmark suggests that without compression, queriers and distributors use less CPU and memory.
However, you may notice an increase in ingester data and network traffic.
{{< admonition type="note" >}}
This change may increase data usage and network traffic, which can impact cloud billing.
{{< /admonition >}}
If you notice increased network traffic or issues, check the gRPC compression settings.
Refer to [gRPC compression configuration](https://grafana.com/docs/tempo/<TEMPO_VERSION>/configuration/#grpc-compression) for more information.
For instructions how to enable gRPC compression, refer to [gRPC compression configuration](https://grafana.com/docs/tempo/<TEMPO_VERSION>/configuration/#grpc-compression) for more information.
### Added, updated, removed, or renamed configuration parameters
Expand Down

0 comments on commit c7b435d

Please sign in to comment.