Skip to content

Commit f5b9618

Browse files
theletterfxrmx
theletterf
and
xrmx
authored
Add release notes structure (#318)
* Add release notes structure * Add docs codeowners * Add 1.3.0 * Edits * Update docs/release-notes/index.md * Fix anchors --------- Co-authored-by: Riccardo Magliocchetti <[email protected]>
1 parent 213b2a9 commit f5b9618

File tree

7 files changed

+219
-0
lines changed

7 files changed

+219
-0
lines changed

‎.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
* @elastic/apm-agent-python
22
/.github/actions/ @elastic/apm-agent-python @elastic/observablt-ci
33
/.github/workflows/ @elastic/apm-agent-python @elastic/observablt-ci
4+
*.md @elastic/ingest-docs
5+
/docs/ @elastic/ingest-docs

‎docs/docset.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
project: 'EDOT Python release notes'
2+
cross_links:
3+
- docs-content
4+
- opentelemetry
5+
toc:
6+
- toc: release-notes
7+
subs:
8+
agent: "Elastic Agent"
9+
agents: "Elastic Agents"
10+
edot: "Elastic Distribution of OpenTelemetry"

‎docs/release-notes/breaking-changes.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
navigation_title: Breaking changes
3+
description: Breaking changes for Elastic Distribution of OpenTelemetry .
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
products:
9+
- id: cloud-serverless
10+
- id: observability
11+
- id: edot-sdk
12+
---
13+
14+
# Elastic Distribution of OpenTelemetry Python breaking changes [edot-python-breaking-changes]
15+
16+
Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elastic Distribution of OpenTelemetry Python breaking changes and take the necessary steps to mitigate any issues.
17+
18+
% ## Next version [edot-python-X.X.X-breaking-changes]
19+
20+
% Use the following template to add entries to this document.
21+
22+
% TEMPLATE START
23+
% ::::{dropdown} Title of breaking change
24+
% Description of the breaking change.
25+
% **Impact**<br> Impact of the breaking change.
26+
% **Action**<br> Steps for mitigating impact.
27+
% View [PR #](PR link).
28+
% ::::
29+
% TEMPLATE END
30+
31+
% 1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section.
32+
% 2. Edit the anchor ID of the template with the correct PR number to give the entry a unique URL.
33+
% 3. Don't hardcode the link to the new entry. Instead, make it available through the doc link service files:
34+
35+
No breaking changes.

‎docs/release-notes/deprecations.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
navigation_title: Deprecations
3+
description: Deprecations for Elastic Distribution of OpenTelemetry Python.
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
products:
9+
- id: cloud-serverless
10+
- id: observability
11+
- id: edot-sdk
12+
---
13+
14+
# Elastic Distribution of OpenTelemetry Python deprecations [edot-python-deprecations]
15+
16+
Over time, certain Elastic functionality becomes outdated and is replaced or removed. To help with the transition, Elastic deprecates functionality for a period before removal, giving you time to update your applications.
17+
18+
Review the deprecated functionality for Elastic Distribution of OpenTelemetry Python. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md).
19+
20+
% ## Next version [edot-python-X.X.X-deprecations]
21+
22+
% Use the following template to add entries to this document.
23+
24+
% TEMPLATE START
25+
% ::::{dropdown} Deprecation title
26+
% Description of the deprecation.
27+
% **Impact**<br> Impact of the deprecation.
28+
% **Action**<br> Steps for mitigating impact.
29+
% View [PR #](PR link).
30+
% ::::
31+
% TEMPLATE END
32+
33+
No deprecations.

‎docs/release-notes/index.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
navigation_title: EDOT Python
3+
description: Release notes for Elastic Distribution of OpenTelemetry Python.
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
products:
9+
- id: cloud-serverless
10+
- id: observability
11+
- id: edot-sdk
12+
---
13+
14+
# Elastic Distribution of OpenTelemetry Python release notes [edot-python-release-notes]
15+
16+
Review the changes, fixes, and more in each version of Elastic Distribution of OpenTelemetry Python.
17+
18+
To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).
19+
20+
% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes files.
21+
22+
% ## version.next [edot-python-X.X.X-release-notes]
23+
24+
% ### Features and enhancements [edot-python-X.X.X-features-enhancements]
25+
% *
26+
27+
% ### Fixes [edot-python-X.X.X-fixes]
28+
% *
29+
30+
## 1.3.0 [edot-python-1.3.0-release-notes]
31+
32+
- Bump to OTel 1.34.1: dropped support for Python 3.8 (#321)
33+
34+
Upstream changes:
35+
* https://github.com/open-telemetry/opentelemetry-python/discussions/4613
36+
* https://github.com/open-telemetry/opentelemetry-python-contrib/discussions/3558
37+
38+
## 1.2.0 [edot-python-1.2.0-release-notes]
39+
40+
- Bump to OTel 1.33.1: logs OTLP serialization improvements, stable `code` attributes used in logs (#307).
41+
42+
Upstream changes:
43+
* https://github.com/open-telemetry/opentelemetry-python/discussions/4574
44+
* https://github.com/open-telemetry/opentelemetry-python-contrib/discussions/3487
45+
- Bump openai instrumentation to 1.1.1 in docker image (#308).
46+
47+
## 1.1.0 [edot-python-1.1.0-release-notes]
48+
49+
- Bump to OTel 1.32.1: logging module autoinstrumentation improvements, explicit bucket advisory fixes, asyncclick instrumentation (#293).
50+
- Bump openai instrumentation to 1.1.0 in docker image (#297).
51+
52+
## 1.0.0 [edot-python-1.0.0-release-notes]
53+
54+
- Enabled opentelemetry-instrumentation-vertexai in edot-bootstrap (#283).
55+
- Bump openai instrumentation to 1.0.0 in docker image (#275).
56+
- Moved docs to https://elastic.github.io/opentelemetry/ (#282).
57+
58+
## 0.8.1 [edot-python-0.8.1-release-notes]
59+
60+
- Bump to OTel 1.31.1 (#270).
61+
62+
## 0.8.0 [edot-python-0.8.0-release-notes]
63+
64+
- Removed some custom code in ElasticOpenTelemetryConfigurator (#250).
65+
- Introduced a resource detector sending server.instance.id (#259).
66+
- Bump to OTel 1.31.0: programmatic auto-instrumentation, added metrics and events for AWS Bedrock instrumentation (#263).
67+
- Bump elastic-opentelemetry-instrumentation-openai to 0.6.1 in Docker image and relax version dependency to (#264).
68+
69+
## 0.7.0 [edot-python-0.7.0-release-notes]
70+
71+
- Bump to OTel 1.30.0: Python 3.13 support, pymssql instrumentation, basic GenAI tracing with AWS Bedrock (#241).
72+
73+
## 0.6.1 [edot-python-0.6.1-release-notes]
74+
75+
- Bump opentelemetry-sdk-extension-aws to 2.1.0 (#222).
76+
- Bump opentelemetry-resourcedetector-gcp to 1.8.0a0 (#229).
77+
- Added OpenAI examples (#226).
78+
79+
## 0.6.0 [edot-python-0.6.0-release-notes]
80+
81+
- Bump to OTel 1.29.0 (#211).
82+
- Bump elastic-opentelemetry-instrumentation-openai dependency to 0.6.0 (#210).
83+
84+
## 0.5.0 [edot-python-0.5.0-release-notes]
85+
86+
- Enabled by default cloud resource detectors for AWS, Azure and GCP (#198).
87+
- Introduced edot-bootstrap, like opentelemetry-bootstrap but with EDOT Openai instrumentation (#196).
88+
- Added docs for tracing with manual spans and metrics (#189).
89+
- Set OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE to DELTA (#197).
90+
- Bump elastic-opentelemetry-instrumentation-openai dependency to 0.5.0 (#204).
91+
92+
## 0.4.1 [edot-python-0.4.1-release-notes]
93+
94+
- Bump to OTel 1.28.2 (#185).
95+
96+
## 0.4.0 [edot-python-0.4.0-release-notes]
97+
98+
- Bump to OTel 1.28.1 (#169).
99+
- Enabled log events by default (#154).
100+
- Added musl autoinstrumentation to Docker image for OTel Kubernetes operator (#162).
101+
- Added documentation for logging enablement (#153).
102+
- Added flask autoinstrumentation example (#168).
103+
104+
## 0.3.0 [edot-python-0.3.0-release-notes]
105+
106+
- Built Python 3.12 Docker image for OTel Kubernetes operator (#132, #136. #137).
107+
- Made the distro loading more robust against ImportError.Exception when loading instrumentations (#132).
108+
- Added some types in resource detectors (#133).
109+
110+
## 0.2.0 [edot-python-0.2.0-release-notes]
111+
112+
- Added some documentation (#110).
113+
- Bump to OTel 1.27.0 (#117).
114+
- Enabled `os` resource detector by default (#117).
115+
116+
## 0.1.0 [edot-python-0.1.0-release-notes]
117+
118+
First release.

‎docs/release-notes/known-issues.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
navigation_title: Known issues
3+
description: Known issues for Elastic Distribution of OpenTelemetry Python.
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
products:
9+
- id: cloud-serverless
10+
- id: observability
11+
- id: edot-sdk
12+
---
13+
14+
# Elastic Distribution of OpenTelemetry Python known issues
15+
16+
No known issues.

‎docs/release-notes/toc.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
toc:
2+
- file: index.md
3+
# - file: known-issues.md
4+
# - file: breaking-changes.md
5+
# - file: deprecations.md

0 commit comments

Comments
 (0)