Skip to content

Commit ad78d3e

Browse files
authored
[chore] Update changelog entry for the recent pdata functionality (open-telemetry#8649)
The first iteration doesn't affect the end users. So moving it from user to API changelog
1 parent 9f040a6 commit ad78d3e

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

CHANGELOG-API.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ If you are looking for user-facing changes, check out [CHANGELOG.md](./CHANGELOG
99

1010
## v1.0.0-rcv0016/v0.87.0
1111

12+
### 💡 Enhancements 💡
13+
14+
- `pdata`: Introduce API to control pdata mutability (#6794)
15+
This change introduces new API pdata methods to control the mutability:
16+
- p[metric|trace|log].[Metrics|Traces|Logs].MarkReadOnly() - marks the pdata as read-only. Any subsequent
17+
mutations will result in a panic.
18+
- p[metric|trace|log].[Metrics|Traces|Logs].IsReadOnly() - returns true if the pdata is marked as read-only.
19+
Currently, all the data is kept mutable. This API will be used by fanout consumer in the following releases.
20+
1221
### 🛑 Breaking changes 🛑
1322

1423
- `obsreport`: remove methods/structs deprecated in previous release. (#8492)

CHANGELOG.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,6 @@ If you are looking for developer-facing changes, check out [CHANGELOG-API.md](./
1414
- `service/telemetry exporter/exporterhelper`: Enable sampling logging by default and apply it to all components. (#8134)
1515
The sampled logger configuration can be disabled easily by setting the `service::telemetry::logs::sampling::enabled` to `false`.
1616
- `core`: Adds the ability for components to report status and for extensions to subscribe to status events by implementing an optional StatusWatcher interface. (#7682)
17-
- `pdata`: Introduce runtime assertions to catch incorrect pdata mutations (#6794)
18-
This change introduces an option to enable runtime assertions to catch unintentional pdata mutations in components
19-
that are claimed as non-mutating pdata. Without these assertions, runtime errors may still occur, but thrown by
20-
unrelated components, making it very difficult to troubleshoot.
21-
2217

2318
### 🧰 Bug fixes 🧰
2419

0 commit comments

Comments
 (0)