Skip to content

Commit 3bf07f1

Browse files
ezhang6811ezhang6811
committed
Merge branch 'main' into merge-releases
2 parents 87faae7 + f7f46b7 commit 3bf07f1

File tree

16 files changed

+946
-2
lines changed

16 files changed

+946
-2
lines changed

‎.github/workflows/release-udp-exporter.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Release ADOT X-Ray UDP Exporter
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
udp-exporter-version:
7+
description: The version to tag the release with, e.g., 1.2.0
8+
required: true
9+
type: string
10+
11+
permissions:
12+
id-token: write
13+
contents: write
14+
15+
jobs:
16+
validate-udp-exporter-e2e-test:
17+
name: "Validate X-Ray UDP Exporter E2E Test Succeeds"
18+
uses: ./.github/workflows/udp-exporter-e2e-test.yml
19+
secrets: inherit
20+
permissions:
21+
id-token: write
22+
23+
build:
24+
environment: Release
25+
runs-on: ubuntu-latest
26+
needs: validate-udp-exporter-e2e-test
27+
steps:
28+
- name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
29+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5.0.0
30+
31+
- name: Set up Node and run Unit Tests
32+
uses: ./.github/actions/set_up
33+
with:
34+
node_version: "20"
35+
package_name: "@aws/aws-distro-opentelemetry-exporter-xray-udp"
36+
os: ubuntu-latest
37+
run_unit_tests: true
38+
39+
# Project dependencies and compilation are already done in the previous step
40+
- name: Install Dependencies, Compile, and Build Tarball
41+
id: staging_tarball_build
42+
shell: bash
43+
run: |
44+
cd exporters/aws-distro-opentelemetry-exporter-xray-udp
45+
npm pack
46+
47+
- name: Validate project version matches workflow input
48+
run: |
49+
xrayUdpSpanExporterVersion=$(node -p "require('./exporters/aws-distro-opentelemetry-exporter-xray-udp/package.json').version")
50+
if [[ ! "$xrayUdpSpanExporterVersion" == "${{ inputs.udp-exporter-version }}" ]]; then
51+
echo "Input version '${{ inputs.udp-exporter-version }}' does not match with the UDP Exporter project version '$xrayUdpSpanExporterVersion'"
52+
exit 1
53+
fi
54+
55+
# Publish X-Ray UDP Exporter to npm
56+
- name: Publish to npm
57+
working-directory: exporters/aws-distro-opentelemetry-exporter-xray-udp
58+
env:
59+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
60+
NPM_CONFIG_PROVENANCE: true
61+
run: npm publish
62+
63+
# Publish to GitHub releases
64+
- name: Create GH release
65+
id: create_release
66+
env:
67+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
68+
run: |
69+
gh release create --target "$GITHUB_REF_NAME" \
70+
--title "Release aws-distro-opentelemetry-exporter-xray-udp v${{ inputs.udp-exporter-version }}" \
71+
--notes "Please refer to the [Changelog](https://github.com/aws-observability/aws-otel-js-instrumentation/blob/main/exporters/aws-distro-opentelemetry-exporter-xray-udp/CHANGELOG.md) for more details" \
72+
--draft \
73+
"aws-distro-opentelemetry-exporter-xray-udp/v${{ inputs.udp-exporter-version }}"

‎.github/workflows/udp-exporter-e2e-test.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Test ADOT X-Ray UDP Exporter
2+
on:
3+
workflow_call:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
id-token: write
10+
11+
jobs:
12+
udp-exporter-e2e-test:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout Repo @ SHA - ${{ github.sha }}
16+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
17+
18+
- name: Set up Node and run Unit Tests
19+
uses: ./.github/actions/set_up
20+
with:
21+
node_version: "20"
22+
package_name: "@aws/aws-distro-opentelemetry-exporter-xray-udp"
23+
os: ubuntu-latest
24+
run_unit_tests: true
25+
26+
# Project dependencies and compilation are already done in the previous step
27+
- name: Install Dependencies, Compile, and Build Tarball
28+
id: staging_tarball_build
29+
run: |
30+
cd exporters/aws-distro-opentelemetry-exporter-xray-udp
31+
npm pack
32+
33+
- name: Configure AWS credentials for Testing Tracing
34+
uses: aws-actions/configure-aws-credentials@a03048d87541d1d9fcf2ecf528a4a65ba9bd7838 # v5.0.0
35+
with:
36+
role-to-assume: ${{ secrets.XRAY_UDP_EXPORTER_TEST_ROLE }}
37+
aws-region: 'us-east-1'
38+
39+
- name: Download and run X-Ray Daemon
40+
run: |
41+
mkdir xray-daemon
42+
cd xray-daemon
43+
wget https://s3.us-east-2.amazonaws.com/aws-xray-assets.us-east-2/xray-daemon/aws-xray-daemon-linux-3.x.zip
44+
unzip aws-xray-daemon-linux-3.x.zip
45+
./xray -o -n us-east-2 -f ./daemon-logs.log --log-level debug &
46+
47+
- name: Setup Sample App
48+
working-directory: sample-applications/udp-exporter-test-app
49+
run: |
50+
npm install ../../exporters/aws-distro-opentelemetry-exporter-xray-udp/aws-aws-distro-opentelemetry-exporter-xray-udp-*.tgz
51+
npm install
52+
node udp-exporter-test-server.js &
53+
# Wait for test server to initialize
54+
sleep 5
55+
56+
- name: Call Sample App Endpoint
57+
id: call-endpoint
58+
run: |
59+
echo "traceId=$(curl localhost:8080/test)" >> $GITHUB_OUTPUT
60+
61+
- name: Check if traces are successfully sent to AWS X-Ray
62+
run: |
63+
sleep 20
64+
# # Print Daemon Logs for debugging
65+
# cat xray-daemon/daemon-logs.log
66+
67+
traceId=${{ steps.call-endpoint.outputs.traceId }}
68+
numTracesFound=$(aws xray batch-get-traces --trace-ids $traceId --region us-east-2 | jq '.Traces' | jq length)
69+
if [[ numTracesFound -ne "1" ]]; then
70+
echo "TraceId $traceId not found in X-Ray."
71+
exit 1
72+
else
73+
echo "TraceId $traceId found in X-Ray."
74+
fi

‎exporters/aws-distro-opentelemetry-exporter-xray-udp/.eslintignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
build
2+
node_modules
3+
.eslintrc.js
4+
version.ts
5+
src/third-party

‎exporters/aws-distro-opentelemetry-exporter-xray-udp/.eslintrc.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
"env": {
3+
"commonjs": true,
4+
"node": true,
5+
"mocha": true,
6+
},
7+
...require('../../eslint.config.js')
8+
}

‎exporters/aws-distro-opentelemetry-exporter-xray-udp/CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Release History: @aws/aws-distro-opentelemetry-exporter-xray-udp
2+
3+
## v0.0.2 / 2025-10-01
4+
5+
* Update OTel dependencies for UDP Exporter ([#277](https://github.com/aws-observability/aws-otel-js-instrumentation/pull/277))
6+
7+
## v0.0.1 / 2025-09-30
8+
9+
* Initial release

‎exporters/aws-distro-opentelemetry-exporter-xray-udp/LICENSE‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.

‎exporters/aws-distro-opentelemetry-exporter-xray-udp/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AWS Distro for OpenTelemetry (ADOT) X-Ray UDP Exporter
2+
3+
The AWS X-Ray UDP Exporter allows you to send OpenTelemetry Spans to the AWS X-Ray Daemon endpoint.
4+
Notably, this will work with the X-Ray Daemon that runs in an AWS Lambda Environment.
5+
6+
## Installation
7+
8+
Install this package into your NodeJS project with:
9+
10+
```shell
11+
npm install --save @aws/aws-distro-opentelemetry-exporter-xray-udp
12+
```
13+
14+
## Usage
15+
16+
```js
17+
const { AwsXrayUdpSpanExporter } = require("@aws/aws-distro-opentelemetry-exporter-xray-udp")
18+
// ...
19+
20+
const _traceExporter = new AwsXrayUdpSpanExporter();
21+
const _spanProcessor = new SimpleSpanProcessor(_traceExporter);
22+
23+
const sdk = new opentelemetry.NodeSDK({
24+
spanProcessor: _spanProcessor,
25+
// ...
26+
});
27+
```

0 commit comments

Comments
 (0)