AWS AmazonCloudWatch documentation change
Summary
Added OpenTelemetry compatibility section, updated documentation structure, fixed broken links, and modified known issues content regarding Java SDK version recommendations
Security assessment
The changes primarily add OpenTelemetry compatibility documentation and restructure content. The known issues modification addresses a compatibility problem with JBoss Wildfly but does not explicitly reference a security vulnerability. The environment variable mentioned (OTEL_AWS_APPLICATION_SIGNALS_RUNTIME_ENABLED) is a workaround for functionality issues rather than a security control.
Diff
diff --git a/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Signals-supportmatrix.md b/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Signals-supportmatrix.md index 270b391b6..adc318dc0 100644 --- a//AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Signals-supportmatrix.md +++ b//AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Signals-supportmatrix.md @@ -5 +5 @@ -Java compatibilityPython compatibility.NET compatibilityNode.js compatibilityKnown issues +Java compatibilityPython compatibility.NET compatibilityNode.js compatibilityOpenTelemetry compatibilityKnown issues @@ -7 +7 @@ Java compatibilityPython compatibility.NET compatibilityNode.js compatibilityKno -# Application Signals supported systems +# Supported systems @@ -10,0 +11,17 @@ Application Signals is supported and tested on Amazon EKS, native Kubernetes, Am +###### Topics + + * Java compatibility + + * Python compatibility + + * .NET compatibility + + * Node.js compatibility + + * OpenTelemetry compatibility + + * Known issues + + + + @@ -73 +90 @@ To enable Application Signals with Node.js ESM module format, we provide the dif - * **Amazon EKS** – [Setting up a Node.js application with the ESM module format](./CloudWatch-Application-Signals-Enable-EKS-Console.html#EKS-NodeJs-ESM) + * **Amazon EKS** – [Setting up a Node.js application with the ESM module format](./CloudWatch-Application-Signals-Enable-EKS.html#EKS-NodeJs-ESM) @@ -79 +96 @@ To enable Application Signals with Node.js ESM module format, we provide the dif - * **Amazon ECS with AWS CDK** – + * **Amazon ECS with AWS CDK** @@ -81 +98 @@ To enable Application Signals with Node.js ESM module format, we provide the dif - * **Amazon EC2** – [Setting up a Node.js application with the ESM module format](./CloudWatch-Application-Signals-Enable-EC2.html#EC2-NodeJs-ESM) + * **Amazon EC2** – [Setting up a Node.js application with the ESM module format](./CloudWatch-Application-Signals-Enable-EC2Main.html#EC2-NodeJs-ESM) @@ -83 +100 @@ To enable Application Signals with Node.js ESM module format, we provide the dif - * **Kubernetes** – [Setting up a Node.js application with the ESM module format](./CloudWatch-Application-Signals-Enable-Kubernetes.html#Kubernetes-NodeJs-ESM) + * **Kubernetes** – [Setting up a Node.js application with the ESM module format](./CloudWatch-Application-Signals-Enable-KubernetesMain.html#Kubernetes-NodeJs-ESM) @@ -88 +105,3 @@ To enable Application Signals with Node.js ESM module format, we provide the dif -## Known issues +## OpenTelemetry compatibility + +CloudWatch Application Signals is fully compatible with OpenTelemetry. For information about how to get started, see [OpenTelemetry with CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-OpenTelemetry-Sections.html). If you want a more integrated experience, such as using the CloudWatch Agent with AWS Distro for OpenTelemetry (ADOT) SDKs, see [Getting started with Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Getting-Started-App-Signals.html) to find your preferred configuration method. @@ -90 +109 @@ To enable Application Signals with Node.js ESM module format, we provide the dif -**Known issues** +## Known issues @@ -92 +111 @@ To enable Application Signals with Node.js ESM module format, we provide the dif -The runtime metrics collection in the Java SDK release v1.32.5 is known to not work with applications using JBoss Wildfly. This issue extends to the Amazon CloudWatch Observability EKS add-on, affecting versions `2.3.0-eksbuild.1` through `2.6.0-eksbuild.1`. The issue is fixed in Java SDK release `v1.32.6` and the Amazon CloudWatch Observability EKS add-on version `v3.0.0-eksbuild.1`. +The runtime metrics collection in the Java SDK release v1.32.5 is known to not work with applications using JBoss Wildfly. This issue extends to the Amazon CloudWatch Observability EKS add-on, affecting versions `2.3.0-eksbuild.1` through `2.5.0-eksbuild.1`. @@ -94 +113 @@ The runtime metrics collection in the Java SDK release v1.32.5 is known to not w -If you are impacted, either upgrade the Java SDK version or disable your runtime metrics collection by adding the environment variable `OTEL_AWS_APPLICATION_SIGNALS_RUNTIME_ENABLED=false` to your application. +If you are impacted, either downgrade the version or disable your runtime metrics collection by adding the environment variable `OTEL_AWS_APPLICATION_SIGNALS_RUNTIME_ENABLED=false` to your application. @@ -102 +121 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Getting started +Permissions required for Application Signals @@ -104 +123 @@ Getting started -OpenTelemetry compatibility +Supported instrumentation setups