Skip to content

Commit 939a86e

Browse files
committed
Create package for UDP Exporter
1 parent fa269d0 commit 939a86e

File tree

12 files changed

+695
-5
lines changed

12 files changed

+695
-5
lines changed

.github/workflows/release-build.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,12 @@ jobs:
105105
aws-distro-opentelemetry-node-autoinstrumentation/${{ env.ARTIFACT_NAME }} \
106106
${{ env.ARTIFACT_NAME }}.sha256
107107
108-
# Publish to npm
109-
- name: Publish to npm
108+
# Publish '@aws/aws-distro-opentelemetry-node-autoinstrumentation' to npm
109+
- name: Publish autoinstrumentation to npm
110+
working-directory: aws-distro-opentelemetry-node-autoinstrumentation
110111
env:
111112
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
112113
NPM_CONFIG_PROVENANCE: true
113-
run: npx lerna publish from-package --no-push --no-private --no-git-tag-version --no-verify-access --yes
114+
run: npm publish
114115

115116

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
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+
}
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.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# AWS Distro for OpenTelemetry (ADOT) OTLP UDP Exporter
2+
3+
Install this package into your NodeJS project with:
4+
5+
```shell
6+
npm install --save @aws/aws-otel-otlp-udp-exporter
7+
```
8+
9+
## Usage
10+
11+
```js
12+
import { OTLPUdpSpanExporter } from './otlp-udp-exporter';
13+
import { SpanExporter } from '@opentelemetry/sdk-trace-base';
14+
15+
// ...
16+
17+
let otlpUdpSpanExporter: SpanExporter = new OTLPUdpSpanExporter('127.0.0.1:2000');
18+
```
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
{
2+
"name": "@aws/aws-otel-otlp-udp-exporter",
3+
"version": "0.0.1",
4+
"description": "This package provides an OTLP UDP Exporter for OpenTelemetry.",
5+
"author": {
6+
"name": "Amazon Web Services",
7+
"url": "http://aws.amazon.com"
8+
},
9+
"homepage": "https://github.com/aws-observability/aws-otel-js-instrumentation/tree/main/exporters/aws-otel-otlp-udp-exporter#readme",
10+
"license": "Apache-2.0",
11+
"engines": {
12+
"node": ">=14"
13+
},
14+
"publishConfig": {
15+
"access": "public"
16+
},
17+
"main": "build/src/index.js",
18+
"types": "build/src/index.d.ts",
19+
"repository": "aws-observability/aws-otel-js-instrumentation",
20+
"scripts": {
21+
"clean": "rimraf build/*",
22+
"compile": "tsc -p .",
23+
"lint": "eslint . --ext .ts",
24+
"lint:fix": "eslint . --ext .ts --fix",
25+
"precompile": "tsc --version && lerna run version:update --scope @aws/aws-otel-otlp-udp-exporter --include-dependencies",
26+
"prewatch": "npm run precompile",
27+
"prepublishOnly": "npm run compile",
28+
"tdd": "yarn test -- --watch-extensions ts --watch",
29+
"test": "nyc ts-mocha --timeout 10000 -p tsconfig.json --require '@opentelemetry/contrib-test-utils' 'test/**/*.ts'",
30+
"test:coverage": "nyc --check-coverage --functions 95 --lines 95 ts-mocha --timeout 10000 -p tsconfig.json --require '@opentelemetry/contrib-test-utils' 'test/**/*.ts'",
31+
"watch": "tsc -w"
32+
},
33+
"nyc": {
34+
"all": true,
35+
"include": [
36+
"src/**/*.ts"
37+
],
38+
"exclude": [
39+
"src/third-party/**/*.ts"
40+
]
41+
},
42+
"bugs": {
43+
"url": "https://github.com/aws-observability/aws-otel-js-instrumentation/issues"
44+
},
45+
"keywords": [
46+
"aws",
47+
"amazon",
48+
"adot",
49+
"adotjs",
50+
"adot-js",
51+
"adot js",
52+
"xray",
53+
"x-ray",
54+
"x ray",
55+
"awsxray",
56+
"awsdistroopentelemetry",
57+
"opentelemetry",
58+
"otel",
59+
"awslambda",
60+
"nodejs",
61+
"trace",
62+
"tracing",
63+
"profiling",
64+
"instrumentation"
65+
],
66+
"devDependencies": {
67+
"@opentelemetry/resources": "1.26.0",
68+
"@opentelemetry/contrib-test-utils": "0.41.0",
69+
"@types/mocha": "7.0.2",
70+
"@types/node": "18.6.5",
71+
"@types/sinon": "10.0.18",
72+
"expect": "29.2.0",
73+
"mocha": "7.2.0",
74+
"nyc": "15.1.0",
75+
"rimraf": "5.0.5",
76+
"sinon": "15.2.0",
77+
"ts-mocha": "10.0.0",
78+
"typescript": "4.4.4"
79+
},
80+
"dependencies": {
81+
"@opentelemetry/api": "1.9.0",
82+
"@opentelemetry/core": "1.26.0",
83+
"@opentelemetry/otlp-transformer": "0.53.0",
84+
"@opentelemetry/sdk-trace-base": "1.26.0"
85+
},
86+
"files": [
87+
"build/src/**/*.js",
88+
"build/src/**/*.js.map",
89+
"build/src/**/*.d.ts",
90+
"build/src/**/*.json"
91+
]
92+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
export {
3+
OTLPUdpSpanExporter
4+
} from './otlp-udp-exporter';

0 commit comments

Comments
 (0)