From 1b663cae959e581f2c88e2d9356a7e92f70b8435 Mon Sep 17 00:00:00 2001 From: Huy Vo Date: Fri, 28 Apr 2023 10:25:20 -0700 Subject: [PATCH] Add deprecation notice to README (#83) --- README.md | 8 ++++++-- .../auto-instrumentation/flask/README.md | 4 +++- .../manual-instrumentation/flask/README.md | 4 +++- .../none-instrumentation/flask/README.md | 4 +++- 4 files changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3a296313..e77e6c33 100644 --- a/README.md +++ b/README.md @@ -23,12 +23,16 @@ Check out the links below for information on getting started with ADOT in Python -### Applications for integration testing - Auto-instrumentation +### Applications for integration testing - Auto-instrumentation (DEPRECATED) + +**WARNING:** This sample app is deprecated and is no longer maintained. Please use the [new standardized sample apps](https://github.com/aws-observability/aws-otel-community/tree/master/sample-apps). See an app used for [integration testing with automatic instrumentation README.md](integration-test-apps/auto-instrumentation/flask/README.md) for setup instructions. -### Applications for integration testing - Manual instrumentation +### Applications for integration testing - Manual instrumentation (DEPRECATED) + +**WARNING:** This sample app is deprecated and is no longer maintained. Please use the [new standardized sample apps](https://github.com/aws-observability/aws-otel-community/tree/master/sample-apps). See an app used for [integration testing with manual instrumentation README.md](integration-test-apps/manual-instrumentation/flask/README.md) for setup instructions. diff --git a/integration-test-apps/auto-instrumentation/flask/README.md b/integration-test-apps/auto-instrumentation/flask/README.md index 961aa303..c1e1b07b 100644 --- a/integration-test-apps/auto-instrumentation/flask/README.md +++ b/integration-test-apps/auto-instrumentation/flask/README.md @@ -1,4 +1,6 @@ -# AWS Distro for OpenTelemetry Python - Integration Testing App - Auto-instrumentation - Flask +# AWS Distro for OpenTelemetry Python - Integration Testing App - Auto-instrumentation - Flask (DEPRECATED) + +**WARNING:** This sample app is deprecated and is no longer maintained. Please use the [new standardized sample apps](https://github.com/aws-observability/aws-otel-community/tree/master/sample-apps). This application validates the continual integration of automatic instrumentation with the AWS Distro for OpenTelemetry Python and the AWS X-Ray back-end service. Validation is done using the [AWS Test Framework for OpenTelemetry](https://github.com/aws-observability/aws-otel-test-framework). diff --git a/integration-test-apps/manual-instrumentation/flask/README.md b/integration-test-apps/manual-instrumentation/flask/README.md index 0406e093..cc95303b 100644 --- a/integration-test-apps/manual-instrumentation/flask/README.md +++ b/integration-test-apps/manual-instrumentation/flask/README.md @@ -1,4 +1,6 @@ -# AWS Distro for OpenTelemetry Python - Integration Testing App - Manual instrumentation - Flask +# AWS Distro for OpenTelemetry Python - Integration Testing App - Manual instrumentation - Flask (DEPRECATED) + +**WARNING:** This sample app is deprecated and is no longer maintained. Please use the [new standardized sample apps](https://github.com/aws-observability/aws-otel-community/tree/master/sample-apps). This application validates the continual integration of manual instrumentation with the AWS Distro for OpenTelemetry Python and the AWS X-Ray back-end service. Validation is done using the [AWS Test Framework for OpenTelemetry](https://github.com/aws-observability/aws-otel-test-framework). diff --git a/integration-test-apps/none-instrumentation/flask/README.md b/integration-test-apps/none-instrumentation/flask/README.md index 32a40b2d..19c7befe 100644 --- a/integration-test-apps/none-instrumentation/flask/README.md +++ b/integration-test-apps/none-instrumentation/flask/README.md @@ -1,4 +1,6 @@ -# AWS Distro for OpenTelemetry Python - Integration Testing App - None-instrumentation - Flask +# AWS Distro for OpenTelemetry Python - Integration Testing App - None-instrumentation - Flask (DEPRECATED) + +**WARNING:** This sample app is deprecated and is no longer maintained. Please use the [new standardized sample apps](https://github.com/aws-observability/aws-otel-community/tree/master/sample-apps). This application provides a baseline for performance testing. It has no instrumentation and so when compared against apps that do have instrumentation, it helps reveal the overhead that comes with instrumentation.