Skip to content

Commit 6a26bdc

Browse files
authored
document breaking change in metric names for prometheus exporter (#12500)
Fixes #12458 --------- Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com>
1 parent 443e0bc commit 6a26bdc

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ If you are looking for developer-facing changes, check out [CHANGELOG-API.md](./
5151
- `cmd/mdatagen`: Remove `level` field from metrics definition (#12145)
5252
This mechanism will be added back once a new views mechanism is implemented.
5353
- `service`: Value for telemetry exporter `otlp.protocol` updated from `grpc/protobuf` to `grpc`. (#12337)
54+
- `service`: internal metrics exported over Prometheus may differ from previous versions. (#11611)
55+
56+
Users who do not customize the Prometheus reader should not be impacted. The change to update the internal telemetry to use [otel-go config](https://pkg.go.dev/go.opentelemetry.io/contrib/config) can cause unexpected behaviour
57+
for end users. This change is caused by the default values in `config` being different from what the Collector has used in previous versions. The
58+
following changes can occur when users configure their `service::telemetry::metrics::readers`:
59+
- the metric name will append a `_total` suffix if `without_type_suffix` is not configured. Set `without_type_suffix` to `true` to disable this.
60+
- units will be appended to metric name if `without_units` is not configured. Set `without_units` to `true` to disable this.
61+
- a `target_info` metric will be emitted if `without_scope_info` is not configured. Set `without_scope_info` to `true` to disable this.
5462

5563
### 💡 Enhancements 💡
5664

0 commit comments

Comments
 (0)