Skip to content

Commit 57782a4

Browse files
Add section to README on configuring object storage for Tempo (#62)
1 parent 20bfa6a commit 57782a4

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,16 @@ grafana:
161161
```
162162
> **_NOTE:_** Use a custom storage class with a 'Retain' policy to allow for data retention even after uninstalling the chart.
163163
164+
#### Tempo Storage Configuration
165+
166+
When Tempo is enabled, it's recommended to use object storage instead of in-memory storage for trace persistence. Compatible storage backends for Tempo and CircleCI server include S3, GCS, and MinIO.
167+
168+
Configure object storage using the `tempo.storage` values detailed in the [values](#Values) section below.
169+
170+
> **_NOTE:_** For production deployments, object storage provides better durability and scalability compared to in-memory storage, which loses traces on pod restarts.
171+
172+
For detailed configuration options, consult the [official Tempo documentation](https://grafana.com/docs/tempo/latest/setup/operator/object-storage/).
173+
164174
## Modifying or Adding Grafana Dashboards
165175

166176
The default dashboards are located in the `dashboards` directory of the reference chart. To add new dashboards or modify existing ones, follow these steps.

README.md.gotmpl

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,16 @@ grafana:
155155
```
156156
> **_NOTE:_** Use a custom storage class with a 'Retain' policy to allow for data retention even after uninstalling the chart.
157157

158+
#### Tempo Storage Configuration
159+
160+
When Tempo is enabled, it's recommended to use object storage instead of in-memory storage for trace persistence. Compatible storage backends for Tempo and CircleCI server include S3, GCS, and MinIO.
161+
162+
Configure object storage using the `tempo.storage` values detailed in the [values](#Values) section below.
163+
164+
> **_NOTE:_** For production deployments, object storage provides better durability and scalability compared to in-memory storage, which loses traces on pod restarts.
165+
166+
For detailed configuration options, consult the [official Tempo documentation](https://grafana.com/docs/tempo/latest/setup/operator/object-storage/).
167+
158168
## Modifying or Adding Grafana Dashboards
159169

160170
The default dashboards are located in the `dashboards` directory of the reference chart. To add new dashboards or modify existing ones, follow these steps.

0 commit comments

Comments
 (0)