From 5b85f23be13d8c0811cb4135f048cbc4ebd258aa Mon Sep 17 00:00:00 2001 From: wangzlei Date: Fri, 21 Nov 2025 14:58:03 -0800 Subject: [PATCH 1/3] add code attributes experimental feature in README --- README.md | 5 +++++ aws-opentelemetry-distro/README.md | 34 ++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 aws-opentelemetry-distro/README.md diff --git a/README.md b/README.md index a5741d39c..798395504 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,11 @@ Check out the [getting started documentation](https://aws-otel.github.io/docs/ge ## Supported Python libraries and frameworks For the complete list of supported frameworks, please refer to the [OpenTelemetry for Python documentation](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/README.md). +## Experimental Features + +This distribution includes experimental features that are under active development. For detailed information about experimental features including code attributes, please refer to the [aws-opentelemetry-distro README](aws-opentelemetry-distro/README.md). + + ## Support Please note that as per policy, we're providing support via GitHub on a best effort basis. However, if you have AWS Enterprise Support you can create a ticket and we will provide direct support within the respective SLAs. diff --git a/aws-opentelemetry-distro/README.md b/aws-opentelemetry-distro/README.md new file mode 100644 index 000000000..0f4fd397d --- /dev/null +++ b/aws-opentelemetry-distro/README.md @@ -0,0 +1,34 @@ +# AWS Distro For OpenTelemetry Python Distro + +## Installation + +``` +pip install aws-opentelemetry-distro +``` + +This package provides Amazon Web Services distribution of the OpenTelemetry Python Instrumentation, which allows for auto-instrumentation of Python applications. + +## Experimental Features + +**⚠️ Note: Experimental features and their behavior may change in future versions.** + +### Code Attributes + +Code attributes is an experimental feature that automatically captures source code context information when trace data is generated. This feature enhances observability by providing precise code-level details that help developers quickly identify and debug issues. + +**What Code Attributes Capture:** +* **Source file path** - The exact file where the telemetry originated +* **Function name** - The method or function fully-qualified name, including class/namespace context when applicable (e.g., `com.example.MyService.processRequest`, `MyClass.my_method`) +* **Line numbers** - Precise code location for pinpoint debugging + +**How to Enable:** +To enable code attributes, set the following environment variable: +```bash +export OTEL_AWS_EXPERIMENTAL_CODE_ATTRIBUTES=true +``` + + +## References + +* [OpenTelemetry Project](https://opentelemetry.io/) +* [Example using opentelemetry-distro](https://opentelemetry.io/docs/instrumentation/python/distro/) From ba2a2d638fe0a798babb40e520e68b117e627c6b Mon Sep 17 00:00:00 2001 From: wangzlei Date: Fri, 21 Nov 2025 15:01:18 -0800 Subject: [PATCH 2/3] add code attributes experimental feature in README --- aws-opentelemetry-distro/README.rst | 18 ------------------ 1 file changed, 18 deletions(-) delete mode 100644 aws-opentelemetry-distro/README.rst diff --git a/aws-opentelemetry-distro/README.rst b/aws-opentelemetry-distro/README.rst deleted file mode 100644 index 8da063b4e..000000000 --- a/aws-opentelemetry-distro/README.rst +++ /dev/null @@ -1,18 +0,0 @@ -AWS Distro For OpenTelemetry Python Distro -============================================ - -Installation ------------- - -:: - - pip install aws-opentelemetry-distro - - -This package provides Amazon Web Services distribution of the OpenTelemetry Python Instrumentation, which allows for auto-instrumentation of Python applications. - -References ----------- - -* `OpenTelemetry Project `_ -* `Example using opentelemetry-distro `_ From 9cecd20460898069595d88d6f491f28340005ec7 Mon Sep 17 00:00:00 2001 From: wangzlei Date: Fri, 21 Nov 2025 20:25:54 -0800 Subject: [PATCH 3/3] revert aws-opentelemetry-distro/README.rst --- README.md | 16 +++++++++++++- aws-opentelemetry-distro/README.md | 34 ----------------------------- aws-opentelemetry-distro/README.rst | 18 +++++++++++++++ 3 files changed, 33 insertions(+), 35 deletions(-) delete mode 100644 aws-opentelemetry-distro/README.md create mode 100644 aws-opentelemetry-distro/README.rst diff --git a/README.md b/README.md index 798395504..d2b3e1430 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,21 @@ For the complete list of supported frameworks, please refer to the [OpenTelemetr ## Experimental Features -This distribution includes experimental features that are under active development. For detailed information about experimental features including code attributes, please refer to the [aws-opentelemetry-distro README](aws-opentelemetry-distro/README.md). +**⚠️ Note: Experimental features and their behavior may change in future versions.** + +### Code Attributes + +Code attributes is an experimental feature that automatically captures source code context information when trace data is generated. This feature enhances observability by providing precise code-level details that help developers quickly identify and debug issues. + +Code attributes capture: +* **Source file path** - The exact file where the telemetry originated +* **Function name** - The method or function fully-qualified name, including class/namespace context when applicable (e.g., `com.example.MyService.processRequest`, `MyClass.my_method`) +* **Line numbers** - Precise code location for pinpoint debugging + +To enable code attributes, set the following environment variable: +```bash +export OTEL_AWS_EXPERIMENTAL_CODE_ATTRIBUTES=true +``` ## Support diff --git a/aws-opentelemetry-distro/README.md b/aws-opentelemetry-distro/README.md deleted file mode 100644 index 0f4fd397d..000000000 --- a/aws-opentelemetry-distro/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# AWS Distro For OpenTelemetry Python Distro - -## Installation - -``` -pip install aws-opentelemetry-distro -``` - -This package provides Amazon Web Services distribution of the OpenTelemetry Python Instrumentation, which allows for auto-instrumentation of Python applications. - -## Experimental Features - -**⚠️ Note: Experimental features and their behavior may change in future versions.** - -### Code Attributes - -Code attributes is an experimental feature that automatically captures source code context information when trace data is generated. This feature enhances observability by providing precise code-level details that help developers quickly identify and debug issues. - -**What Code Attributes Capture:** -* **Source file path** - The exact file where the telemetry originated -* **Function name** - The method or function fully-qualified name, including class/namespace context when applicable (e.g., `com.example.MyService.processRequest`, `MyClass.my_method`) -* **Line numbers** - Precise code location for pinpoint debugging - -**How to Enable:** -To enable code attributes, set the following environment variable: -```bash -export OTEL_AWS_EXPERIMENTAL_CODE_ATTRIBUTES=true -``` - - -## References - -* [OpenTelemetry Project](https://opentelemetry.io/) -* [Example using opentelemetry-distro](https://opentelemetry.io/docs/instrumentation/python/distro/) diff --git a/aws-opentelemetry-distro/README.rst b/aws-opentelemetry-distro/README.rst new file mode 100644 index 000000000..8da063b4e --- /dev/null +++ b/aws-opentelemetry-distro/README.rst @@ -0,0 +1,18 @@ +AWS Distro For OpenTelemetry Python Distro +============================================ + +Installation +------------ + +:: + + pip install aws-opentelemetry-distro + + +This package provides Amazon Web Services distribution of the OpenTelemetry Python Instrumentation, which allows for auto-instrumentation of Python applications. + +References +---------- + +* `OpenTelemetry Project `_ +* `Example using opentelemetry-distro `_