Skip to content

Commit

Permalink
Add migration guide for push_config deprecation (#534)
Browse files Browse the repository at this point in the history
* Add migration guide for push_config deprecation

* Rewording
  • Loading branch information
mapno authored Apr 12, 2021
1 parent d055b19 commit a0aeb6e
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion docs/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ releases and how to migrate to newer versions.

# v0.14.0

v0.14.0 introduces a breaking change to the SigV4 configuration.
v0.14.0 introduces a breaking change to the SigV4 configuration and the deprecation of `push_config` in favor of `remote_write` for Tempo configs.

## SigV4 config change

Expand All @@ -31,6 +31,51 @@ sigv4:
region: us-east-1
```
## Tempo: `push_config` deprecation

`push_config` is now deprecated in favor of a `remote_write` array which allows for sending spans to multiple endpoints.
`push_config` will be removed in a future release, and it is recommended to migrate to `remote_write` as soon as possible.

To migrate, move the batch options outside the `push_config` block.
Then, add a `remote_write` array and move the remaining of your `push_config` block inside it.

Example old config:

```yaml
tempo:
configs:
- name: default
receivers:
otlp:
protocols:
gpc:
push_config:
endpoint: otel-collector:55680
insecure: true
batch:
timeout: 5s
send_batch_size: 100
```

Example migrated config:

```yaml
tempo:
configs:
- name: default
receivers:
otlp:
protocols:
gpc:
remote_write:
- endpoint: otel-collector:55680
insecure: true
batch:
timeout: 5s
send_batch_size: 100
```


# v0.12.0

v0.12.0 had two breaking changes: the `tempo` and `loki` sections have been changed to require a list of `tempo`/`loki` configs rather than just one.
Expand Down

0 comments on commit a0aeb6e

Please sign in to comment.