From cd852237d0efbd87a038e593ed2a80d5daebb538 Mon Sep 17 00:00:00 2001 From: Leighton Chen Date: Tue, 29 Jul 2025 08:07:04 -0800 Subject: [PATCH 1/5] Add excerpt about logging signal breaking changes --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64f5cd1dea..70d6ea0696 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,14 @@ See the [OpenTelemetry Instrumentation for Python](https://opentelemetry.io/docs | ------- | ------------ | ------- | | Traces | Stable | N/A | | Metrics | Stable | N/A | -| Logs | Experimental | N/A | +| Logs | Experimental* | N/A | Project versioning information and stability guarantees can be found [here](./rationale.md#versioning-and-releasing). +***Breaking Changes** + +We are working on stabilizing the Log signal that would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for sdk developers. + ## Getting started You can find the getting started guide for OpenTelemetry Python [here](https://opentelemetry.io/docs/instrumentation/python/getting-started/). From 17bdb02fbe04aa1edc1c8a0f96e314c44f812e9b Mon Sep 17 00:00:00 2001 From: Leighton Chen Date: Tue, 29 Jul 2025 08:07:49 -0800 Subject: [PATCH 2/5] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index dfc9179da3..8d52f6a89c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +**Breaking changes ongoing** + +We are working on stabilizing the Log signal that would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for sdk developers. + ## Unreleased ## Version 1.36.0/0.57b0 (2025-07-29) From 29a25dcbb040ec64f981ccd2a83024059a43b6d2 Mon Sep 17 00:00:00 2001 From: Riccardo Magliocchetti Date: Mon, 18 Aug 2025 14:43:04 +0200 Subject: [PATCH 3/5] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com> Co-authored-by: Jackson Weber <47067795+JacksonWeber@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 70d6ea0696..094e3c64c5 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@ See the [OpenTelemetry Instrumentation for Python](https://opentelemetry.io/docs | ------- | ------------ | ------- | | Traces | Stable | N/A | | Metrics | Stable | N/A | -| Logs | Experimental* | N/A | +| Logs | Development* | N/A | Project versioning information and stability guarantees can be found [here](./rationale.md#versioning-and-releasing). ***Breaking Changes** -We are working on stabilizing the Log signal that would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for sdk developers. +We are working on stabilizing the Log signal which would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for SDK developers. ## Getting started From dbab309e0a144ccef3efeacdefedf6b64ba948d2 Mon Sep 17 00:00:00 2001 From: Riccardo Magliocchetti Date: Mon, 18 Aug 2025 14:45:18 +0200 Subject: [PATCH 4/5] Apply suggestions from code review --- CHANGELOG.md | 1 + README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d52f6a89c..b98602fe44 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 **Breaking changes ongoing** +[!IMPORTANT] We are working on stabilizing the Log signal that would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for sdk developers. ## Unreleased diff --git a/README.md b/README.md index 094e3c64c5..31855c275b 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Project versioning information and stability guarantees can be found [here](./ra ***Breaking Changes** +[!IMPORTANT] We are working on stabilizing the Log signal which would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for SDK developers. ## Getting started From 2bc308087f053a5b3f717e44b5350c53367f039e Mon Sep 17 00:00:00 2001 From: Riccardo Magliocchetti Date: Mon, 18 Aug 2025 14:47:00 +0200 Subject: [PATCH 5/5] Apply suggestions from code review --- CHANGELOG.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b98602fe44..ad6b1bfe8d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,8 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 **Breaking changes ongoing** -[!IMPORTANT] -We are working on stabilizing the Log signal that would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for sdk developers. +> [!IMPORTANT] +> We are working on stabilizing the Log signal that would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for sdk developers. ## Unreleased diff --git a/README.md b/README.md index 31855c275b..e87b894cd4 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ Project versioning information and stability guarantees can be found [here](./ra ***Breaking Changes** -[!IMPORTANT] -We are working on stabilizing the Log signal which would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for SDK developers. +> [!IMPORTANT] +> We are working on stabilizing the Log signal which would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for SDK developers. ## Getting started