[Node] Custom Metrics E2E Test #481
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+190
to
+191
|
|
||
|
|
Contributor
There was a problem hiding this comment.
nit: Remove whitespace changes
majanjua-amzn
approved these changes
Nov 13, 2025
thpierce
reviewed
Nov 15, 2025
Contributor
thpierce
left a comment
thpierce
left a comment
There was a problem hiding this comment.
Pretty high level review, didn't go into great detail, but a few comments nonetheless
| tmux send-keys -t frontend 'export AWS_REGION="$${AWS_REGION}"' C-m | ||
| tmux send-keys -t frontend 'export TESTING_ID="$${TESTING_ID}"' C-m | ||
| tmux send-keys -t frontend 'export OTEL_NODE_DISABLED_INSTRUMENTATIONS=fs,dns,express' C-m | ||
| tmux send-keys -t frontend 'export OTEL_SERVICE_NAME=node-sample-application-${var.test_id}' C-m |
Contributor
There was a problem hiding this comment.
Nit: Should use SERVICE_NAME
| "dependencies": { | ||
| "@aws-sdk/client-s3": "3.621.0", | ||
| "@aws-sdk/client-s3": "^3.621.0", | ||
| "@aws/aws-distro-opentelemetry-node-autoinstrumentation": "^0.8.0", |
Contributor
There was a problem hiding this comment.
Why is @aws/aws-distro-opentelemetry-node-autoinstrumentation needed?
| "express": "^4.21.2", | ||
| "mysql2": "^3.11.0", | ||
| "bunyan": "^1.8.15" | ||
| "mysql2": "^3.15.3" |
Contributor
There was a problem hiding this comment.
Why is an update to mysql2 needed?
Comment on lines
117
to
191
|
|
||
| try { | ||
| await s3Client.send( | ||
| new GetBucketLocationCommand({ | ||
| Bucket: bucketName, | ||
| }), | ||
| ).then((data) => { | ||
| const msg = '/aws-sdk-call called successfully; UNEXPECTEDLY RETURNED DATA: ' + data; | ||
| logger.info(msg); | ||
| res.send(msg); | ||
| }); | ||
| } catch (e) { | ||
| if (e instanceof Error) { | ||
| const msg = '/aws-sdk-call called successfully'; | ||
| logger.info(msg); | ||
| res.send(msg); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| app.get('/remote-service', (req, res) => { | ||
| const endpoint = req.query.ip || 'localhost'; | ||
| const options = { | ||
| hostname: endpoint, | ||
| port: 8001, | ||
| method: 'GET', | ||
| path: '/healthcheck' | ||
| }; | ||
|
|
||
| const request = http.request(options, (rs) => { | ||
| rs.setEncoding('utf8'); | ||
| rs.on('data', (result) => { | ||
| const msg = `/remote-service called successfully: ${result}`; | ||
| logger.info(msg); | ||
| res.send(msg); | ||
| }); | ||
| }); | ||
| request.on('error', (err) => { | ||
| const msg = '/remote-service called with errors: ' + err.errors; | ||
| logger.error(msg); | ||
| res.send(msg); | ||
| }); | ||
| request.end(); | ||
| }); | ||
|
|
||
| // The following logic serves as the async call made by the /client-call API | ||
| let makeAsyncCall = false; | ||
| setInterval(() => { | ||
| if (makeAsyncCall) { | ||
| makeAsyncCall = false; | ||
| logger.info('Async call triggered by /client-call API'); | ||
|
|
||
| const request = http.get('http://local-root-client-call', (rs) => { | ||
| rs.setEncoding('utf8'); | ||
| rs.on('data', (result) => { | ||
| const msg = `GET local-root-client-call response: ${result}`; | ||
| logger.info(msg); | ||
| res.send(msg); | ||
| }); | ||
| }); | ||
| request.on('error', (err) => {}); // Expected | ||
| request.end(); | ||
| } | ||
| }, 5000); // Check every 5 seconds | ||
|
|
||
| app.get('/client-call', (req, res) => { | ||
| const msg = '/client-call called successfully'; | ||
| logger.info(msg); | ||
| res.send(msg); | ||
| // Trigger async call to generate telemetry for InternalOperation use case | ||
| makeAsyncCall = true; | ||
| }); | ||
|
|
||
|
|
||
|
|
Contributor
There was a problem hiding this comment.
Try to avoid unrelated changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds custom metrics to the existing sample app to verify public documentation is correct and functionality continues to work as changes happen in the future (Regression testing). Specifically for OpenTelemetry metrics using the CloudWatch Agent.
The changes made in this PR are:
New imports to index.js and dependencies to package.json (sample app's frontend service for the 'main' instance and the dependency installer)
Global meter, and gauge/histogram/counter added to FrontendServiceController.java from OTEL SDK Metrics page
Update to environment variables in main.tf
Update to jobs & env sections in node-ec2-default-test
Update to Cloudwatch agent config to include otlp ports
New Validator file to call updated predefined template file
Update to PredefinedExpectedTemplate to include new mustache file
New mustache file for validation of custom metrics
Git revert back to last passing CSHA: af399c7
Rollback procedure:
<Can we safely revert this commit if needed? If not, detail what must be done to safely revert and why it is needed.>
Ensure you've run the following tests on your changes and include the link below:
To do so, create a
test.ymlfile withname: Testand workflow description to test your changes, then remove the file for your PR. Link your test run in your PR description. This process is a short term solution while we work on creating a staging environment for testing.ADOT-SIGV4
EC2-DEFAULT
ASG
ECS
EKS
K8s
NOTE: TESTS RUNNING ON A SINGLE EKS CLUSTER CANNOT BE RUN IN PARALLEL. See the needs keyword to run tests in succession.
e2e-playgroundin us-east-1 and eu-central-2e2e-playgroundin us-east-1 and eu-central-2e2e-playgroundin us-east-1 and eu-central-2By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.