Skip to content

Commit 2013c2b

Browse files
jack-bergjack-berg
authored
Prepare 0.4.0 (#190)
* Update file_format to 0.4 * Add script to draft changelog * Add changelog for 0.4.0 * Add additional changelog entry * Add link to future 0.4.0 tag, restore unreleased section * Fix build * Add additional changelog entry * Update 0.4.0 release date
1 parent 2e76e05 commit 2013c2b

File tree

6 files changed

+238
-8
lines changed

6 files changed

+238
-8
lines changed

‎.github/scripts/draft-change-log-entries.sh‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/bin/bash -e
2+
3+
previous_version=$1
4+
5+
range="$previous_version..HEAD"
6+
7+
echo "## Unreleased"
8+
echo
9+
10+
git log --reverse \
11+
--perl-regexp \
12+
--author='^(?!renovate\[bot\] )' \
13+
--pretty=format:"* %s" \
14+
"$range" \
15+
| sed -E 's,\(#([0-9]+)\)$,\n ([#\1](https://github.com/open-telemetry/opentelemetry-configuration/pull/\1)),'

‎CHANGELOG.md‎

Lines changed: 219 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,226 @@
22

33
## Unreleased
44

5-
* Improved file_format documentation. [#137](https://github.com/open-telemetry/opentelemetry-configuration/pull/137)
6-
* Periodic exporter interval default value is inconsistent [#143](https://github.com/open-telemetry/opentelemetry-configuration/pull/143)
7-
* Fix MetricReader invalid configurations [#148](https://github.com/open-telemetry/opentelemetry-configuration/pull/148)
5+
## [v0.4.0] - 2025-03-31
86

9-
## [v0.3.0] - 2024-05-08
7+
This release has a significant number of breaking changes, new additions and
8+
fixes. The breaking changes reflect a higher degree of scrutiny on consistency
9+
and correct data modeling as we approach a stable
10+
release ([#161](https://github.com/open-telemetry/opentelemetry-configuration/issues/161), [#4374](https://github.com/open-telemetry/opentelemetry-specification/issues/4374)).
11+
We anticipate limited churn going forward. Additionally, once we do have a
12+
stable release, users can rely on
13+
the [strong compatibility guarantees](https://github.com/open-telemetry/opentelemetry-configuration?tab=readme-ov-file#stability-definition)
14+
we'll conform to in versions 1.0.0+.
15+
16+
### Schema
17+
18+
* **BREAKING:** Refactor otlp exporter to separate `otlp_http` and `otlp_grpc`
19+
exporters, add `_file` suffix to OTLP exporter certificate properties
20+
([#146](https://github.com/open-telemetry/opentelemetry-configuration/pull/146),
21+
[#166](https://github.com/open-telemetry/opentelemetry-configuration/pull/166))
22+
23+
<details>
24+
25+
<summary>Migration steps</summary>
26+
27+
```yaml
28+
# Before
29+
tracer_provider:
30+
processors:
31+
- batch:
32+
exporter:
33+
otlp:
34+
protocol: http/protobuf
35+
endpoint: http://localhost:4318/v1/traces
36+
certificate: /app/cert.pem
37+
---
38+
# After
39+
tracer_provider:
40+
processors:
41+
- batch:
42+
exporter:
43+
otlp_http:
44+
endpoint: http://localhost:4318/v1/traces
45+
certificate_file: /app/cert.pem
46+
```
47+
</details>
48+
49+
* **BREAKING:** Refactor propagator schema, add `composite_list` for
50+
compatibility with `OTEL_PROPAGATORS`.
51+
([#187](https://github.com/open-telemetry/opentelemetry-configuration/pull/187))
52+
53+
<details>
54+
55+
<summary>Migration steps</summary>
56+
57+
```yaml
58+
# Before
59+
propagator:
60+
composite:
61+
- tracecontext
62+
- baggage
63+
---
64+
# After
65+
propagator:
66+
composite:
67+
- tracecontext:
68+
- baggage:
69+
```
70+
</details>
71+
72+
* **BREAKING:** Refactor resource detection and mark experimental
73+
([#182](https://github.com/open-telemetry/opentelemetry-configuration/pull/182),
74+
[#188](https://github.com/open-telemetry/opentelemetry-configuration/pull/188))
75+
76+
<details>
77+
78+
<summary>Migration steps</summary>
79+
80+
```yaml
81+
# Before
82+
resource:
83+
attributes: # ...omitted for brevity
84+
detectors:
85+
excluded:
86+
- process.command_args
87+
---
88+
# After
89+
resource:
90+
attributes: # ...omitted for brevity
91+
detection/development:
92+
detectors:
93+
- container:
94+
- host:
95+
- os:
96+
- process:
97+
attributes:
98+
excluded:
99+
- process.command_args
100+
```
101+
</details>
102+
103+
* **BREAKING:** Mark prometheus exporter as experimental
104+
([#180](https://github.com/open-telemetry/opentelemetry-configuration/pull/180))
105+
106+
<details>
107+
108+
<summary>Migration steps</summary>
109+
110+
```yaml
111+
# Before
112+
meter_provider:
113+
readers:
114+
- pull:
115+
prometheus: # ...omitted for brevity
116+
---
117+
# After
118+
meter_provider:
119+
readers:
120+
- pull:
121+
prometheus/development: # ...omitted for brevity
122+
```
123+
</details>
124+
125+
* **BREAKING:** Mark `.instrumentation` as experimental
126+
([#179](https://github.com/open-telemetry/opentelemetry-configuration/pull/179))
127+
128+
<details>
129+
130+
<summary>Migration steps</summary>
131+
132+
```yaml
133+
# Before
134+
instrumentation: # ...omitted for brevity
135+
---
136+
# After
137+
instrumentation/development: # ...omitted for brevity
138+
```
139+
</details>
140+
141+
* **BREAKING:** Move metric producers from `MetricReader`
142+
to `PullMetricReader`, `PeriodicMetricReader`
143+
([#148](https://github.com/open-telemetry/opentelemetry-configuration/pull/148))
144+
145+
<details>
146+
147+
<summary>Migration steps</summary>
148+
149+
```yaml
150+
# Before
151+
meter_provider:
152+
readers:
153+
- periodic: # ...omitted for brevity
154+
producers:
155+
- opencensus:
156+
---
157+
# After
158+
meter_provider:
159+
readers:
160+
- periodic: # ...omitted for brevity
161+
producers:
162+
- opencensus:
163+
```
164+
</details>
165+
166+
* **BREAKING:** Change various usages of minimum to exclusiveMinimum
167+
([#151](https://github.com/open-telemetry/opentelemetry-configuration/pull/151))
168+
* Add `.meter_provider.exemplar_filter` property
169+
([#131](https://github.com/open-telemetry/opentelemetry-configuration/pull/131))
170+
* Don't require empty objects
171+
([#134](https://github.com/open-telemetry/opentelemetry-configuration/pull/134))
172+
* Improve `.file_format` documentation
173+
([#137](https://github.com/open-telemetry/opentelemetry-configuration/pull/137))
174+
* Fix periodic exporter interval default value in `kitchen-sink.yaml`
175+
([#143](https://github.com/open-telemetry/opentelemetry-configuration/pull/143))
176+
* Provide guidance on required and null properties. Update schema types to
177+
reflect guidance, including documenting behavior when properties are omitted
178+
or null.
179+
([#141](https://github.com/open-telemetry/opentelemetry-configuration/pull/141)
180+
[#192](https://github.com/open-telemetry/opentelemetry-configuration/pull/192))
181+
* Add guidance around use of polymorphic types
182+
([#147](https://github.com/open-telemetry/opentelemetry-configuration/pull/147))
183+
* Fix MetricProducer type descriptions
184+
([#150](https://github.com/open-telemetry/opentelemetry-configuration/pull/150))
185+
* Add `otlp_file/development` exporter
186+
([#154](https://github.com/open-telemetry/opentelemetry-configuration/pull/154),
187+
[#181](https://github.com/open-telemetry/opentelemetry-configuration/pull/181))
188+
* Object and enum types should be defined in `$defs`
189+
([#155](https://github.com/open-telemetry/opentelemetry-configuration/pull/155))
190+
* Add guidance around use of title and description keywords
191+
([#157](https://github.com/open-telemetry/opentelemetry-configuration/pull/157))
192+
* Add `log_level` configuration
193+
([#121](https://github.com/open-telemetry/opentelemetry-configuration/pull/121))
194+
* Add missing gauge value to InstrumentType enum
195+
([#186](https://github.com/open-telemetry/opentelemetry-configuration/pull/186))
196+
* Add cardinality limits configuration to `PullMetricReader`, `PeriodicMetricReader`
197+
([#185](https://github.com/open-telemetry/opentelemetry-configuration/pull/185))
198+
* Add scope configuration to disable loggers, tracers, meters
199+
([#140](https://github.com/open-telemetry/opentelemetry-configuration/pull/140),
200+
[#191](https://github.com/open-telemetry/opentelemetry-configuration/pull/191))
201+
202+
### Tooling
203+
204+
* chore: add govulncheck check for validator
205+
([#126](https://github.com/open-telemetry/opentelemetry-configuration/pull/126))
206+
* Drop anchors.yaml example
207+
([#130](https://github.com/open-telemetry/opentelemetry-configuration/pull/130))
208+
* Rebrand file configuration to declarative configuration
209+
([#135](https://github.com/open-telemetry/opentelemetry-configuration/pull/135))
210+
* Rework release process
211+
([#149](https://github.com/open-telemetry/opentelemetry-configuration/pull/149),
212+
[#167](https://github.com/open-telemetry/opentelemetry-configuration/pull/167))
213+
* Clarify JSON schema draft 2020-12
214+
([#156](https://github.com/open-telemetry/opentelemetry-configuration/pull/156))
215+
* Move modeling rules to CONTRIBUTING.md
216+
([#170](https://github.com/open-telemetry/opentelemetry-configuration/pull/170))
217+
* Add FOSSA scanning workflow
218+
([#171](https://github.com/open-telemetry/opentelemetry-configuration/pull/171))
219+
* Add a variety of key definitions surrounding stability
220+
([#142](https://github.com/open-telemetry/opentelemetry-configuration/pull/142))
221+
222+
[v0.4.0]: https://github.com/open-telemetry/opentelemetry-configuration/releases/tag/v0.4.0
223+
224+
## [v0.3.0] - 2024-09-20
10225

11226
* Add metric producers to meter_provider configuration. [#90](https://github.com/open-telemetry/opentelemetry-configuration/pull/90)
12227
* Document what configuration options are covered in the schema. [92](https://github.com/open-telemetry/opentelemetry-configuration/pull/92)

‎RELEASING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
should be listed under a heading of the
88
form `## v{Major}.{Minor}.{Patch} - YYYY-MM-DD` under `## Unreleased`.
99
Maintainers should highlight any breaking changes. You can
10-
use `git log upstream/v$MAJOR.$((MINOR-1)).x..upstream/v$MAJOR.$MINOR.x --graph --first-parent`
10+
use `./.github/scripts/draft-change-log-entries.sh <previous_version_tag>`
1111
or the
1212
Github [compare tool](https://github.com/open-telemetry/opentelemetry-configuration/compare/)
1313
to view a summary of all commits since last release as a reference. From

‎examples/kitchen-sink.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# The file format version.
99
# The yaml format is documented at
1010
# https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
11-
file_format: "0.3"
11+
file_format: "0.4"
1212
# Configure if the SDK is disabled or not.
1313
# If omitted or null, false is used.
1414
disabled: false

‎examples/sdk-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# The file format version.
99
# The yaml format is documented at
1010
# https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
11-
file_format: "0.3"
11+
file_format: "0.4"
1212
# Configure if the SDK is disabled or not.
1313
# If omitted or null, false is used.
1414
disabled: false

‎examples/sdk-migration-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
# The file format version.
3636
# The yaml format is documented at
3737
# https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
38-
file_format: "0.3"
38+
file_format: "0.4"
3939
# Configure if the SDK is disabled or not.
4040
# If omitted or null, false is used.
4141
disabled: ${OTEL_SDK_DISABLED:-false}

0 commit comments

Comments
 (0)