Skip to content

Commit 83e0e34

Browse files
danschultzerdanschultzer
committed
OTel Resource Detector for AWS
1 parent a4ee9fe commit 83e0e34

14 files changed

+752
-0
lines changed

‎.github/hex-packages.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,15 @@
152152
"language": "elixir",
153153
"authorizedUsers": ["bryannaegele", "tsloughter"]
154154
},
155+
"resource_detector_aws": {
156+
"workingDirectory": "detectors/opentelemetry_resource_detector_aws",
157+
"name": "Resource Detector for AWS",
158+
"packageName": "opentelemetry_resource_detector_aws",
159+
"tagPrefix": "opentelemetry-resource-detector-aws-v",
160+
"buildTool": "rebar3",
161+
"language": "erlang",
162+
"authorizedUsers": ["danschultzer"]
163+
},
155164
"tesla": {
156165
"workingDirectory": "instrumentation/opentelemetry_tesla",
157166
"name": "Tesla Instrumentation",

‎.github/labeler.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ erlang:
3333
- utilities/**/*.erl
3434
- utilities/**/*.hrl
3535
- utilities/**/rebar.*
36+
- detectors/**/*.erl
37+
- detectors/**/*.hrl
38+
- detectors/**/rebar.*
3639

3740
instrumentation:
3841
- instrumentation/**/*
@@ -46,6 +49,9 @@ examples:
4649
utilities:
4750
- utilities/**/*
4851

52+
detectors:
53+
- detectors/**/*
54+
4955
scope-ci:
5056
- .github/workflows/**
5157

@@ -97,6 +103,9 @@ opentelemetry_redix:
97103
opentelemetry_req:
98104
- instrumentation/opentelemetry_req/**/*
99105

106+
opentelemetry_resource_detector_aws:
107+
- detectors/opentelemetry_resource_detector_aws/**/*
108+
100109
opentelemetry_telemetry:
101110
- utilities/opentelemetry_telemetry/**/*
102111

‎.github/release-drafter-templates/opentelemetry-resource-detector-aws.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_extends: opentelemetry-erlang-contrib:.github/release-drafter.yml
2+
name-template: 'Opentelemetry Resource Detector for AWS - v$RESOLVED_VERSION'
3+
tag-template: 'opentelemetry-resource-detector-aws-v$RESOLVED_VERSION'
4+
tag-prefix: opentelemetry-resource-detector-aws-v
5+
include-paths:
6+
- detectors/opentelemetry_resource_detector_aws/

‎.github/workflows/erlang.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,38 @@ jobs:
155155
- name: Test
156156
run: rebar3 ct
157157

158+
opentelemetry-reource-detector-aws:
159+
needs: [test-matrix]
160+
if: (contains(github.event.pull_request.labels.*.name, 'erlang') && contains(github.event.pull_request.labels.*.name, 'opentelemetry_resource_detector_aws'))
161+
env:
162+
app: "opentelemetry_resource_detector_aws"
163+
defaults:
164+
run:
165+
working-directory: detectors/${{ env.app }}
166+
runs-on: ${{ matrix.os }}
167+
name: Opentelemetry Resource Detector for AWS test on OTP ${{ matrix.otp_version }} with Rebar3 ${{ matrix.rebar3_version }}
168+
strategy:
169+
fail-fast: false
170+
matrix: ${{ fromJson(needs.test-matrix.outputs.matrix) }}
171+
steps:
172+
- uses: actions/checkout@v4
173+
- uses: erlef/setup-beam@v1
174+
with:
175+
version-type: strict
176+
otp-version: ${{ matrix.otp_version }}
177+
rebar3-version: ${{ matrix.rebar3_version }}
178+
- name: Cache
179+
uses: actions/cache@v4
180+
with:
181+
path: |
182+
~/_build
183+
key: ${{ runner.os }}-build-${{ matrix.otp_version }}-${{ matrix.rebar3_version }}-v3-${{ hashFiles('**/rebar.lock') }}
184+
- name: Fetch deps
185+
if: steps.deps-cache.outputs.cache-hit != 'true'
186+
run: rebar3 get-deps
187+
- name: Test
188+
run: rebar3 ct
189+
158190
opentelemetry-telemetry:
159191
needs: [test-matrix]
160192
if: (contains(github.event.pull_request.labels.*.name, 'erlang') && contains(github.event.pull_request.labels.*.name, 'opentelemetry_telemetry'))

‎.github/workflows/publish-mix-hex-release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ on:
2525
- "process_propagator"
2626
- "redix"
2727
- "req"
28+
- "resource_detector_aws"
2829
- "tesla"
2930
- "xandra"
3031
required: true

‎.github/workflows/release-drafter.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,16 @@ jobs:
157157
env:
158158
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
159159

160+
opentelemetry-resource-detector-aws:
161+
name: '[opentelemetry-resource-detector-aws] Draft release'
162+
runs-on: ubuntu-24.04
163+
steps:
164+
- uses: release-drafter/release-drafter@v6
165+
with:
166+
config-name: release-drafter-templates/opentelemetry-resource-detector-aws.yml
167+
env:
168+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
169+
160170
opentelemetry-req-release:
161171
name: '[opentelemetry-req-release] Draft release'
162172
runs-on: ubuntu-24.04

‎detectors/opentelemetry_resource_detector_aws/LICENSE

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

‎detectors/opentelemetry_resource_detector_aws/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# OpentelemetryResourceDetectorAWS
2+
3+
Implements a Resource Detector for AWS.
4+
5+
## Installation
6+
7+
The package can be installed by adding `opentelemetry_resource_detector_aws` to your list of
8+
dependencies in `mix.exs` for elixir and `rebar.config` for erlang :
9+
10+
```erlang
11+
{deps, [opentelemetry_resource_detector_aws]}.
12+
```
13+
14+
```elixir
15+
def deps do
16+
[
17+
{:opentelemetry_resource_detector_aws, "~> 0.1"}
18+
]
19+
end
20+
```
21+
22+
## Usage
23+
24+
Configure the OpenTelemetry to use the Resource Detector for AWS:
25+
26+
```elixir
27+
config :opentelemetry,
28+
resource_detectors: [:otel_resource_aws_ecs]
29+
```
30+
31+
```erlang
32+
[
33+
{opentelemetry,
34+
[{resource_detectors, otel_resource_aws_ecs}]}
35+
].
36+
```

‎detectors/opentelemetry_resource_detector_aws/rebar.config

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{erl_opts, [debug_info]}.
2+
3+
{deps, [
4+
{opentelemetry, "~> 1.5"},
5+
{opentelemetry_semantic_conventions, "~> 1.27"}
6+
]}.
7+
8+
{profiles, [{test, [{erl_opts, [nowarn_export_all]},
9+
{deps, [{meck, ">= 0.0.0"}]}]}]}.

‎detectors/opentelemetry_resource_detector_aws/rebar.lock

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{"1.2.0",
2+
[{<<"opentelemetry">>,{pkg,<<"opentelemetry">>,<<"1.5.0">>},0},
3+
{<<"opentelemetry_api">>,{pkg,<<"opentelemetry_api">>,<<"1.4.0">>},1},
4+
{<<"opentelemetry_semantic_conventions">>,
5+
{pkg,<<"opentelemetry_semantic_conventions">>,<<"1.27.0">>},
6+
0}]}.
7+
[
8+
{pkg_hash,[
9+
{<<"opentelemetry">>, <<"7DDA6551EDFC3050EA4B0B40C0D2570423D6372B97E9C60793263EF62C53C3C2">>},
10+
{<<"opentelemetry_api">>, <<"63CA1742F92F00059298F478048DFB826F4B20D49534493D6919A0DB39B6DB04">>},
11+
{<<"opentelemetry_semantic_conventions">>, <<"ACD0194A94A1E57D63DA982EE9F4A9F88834AE0B31B0BD850815FE9BE4BBB45F">>}]},
12+
{pkg_hash_ext,[
13+
{<<"opentelemetry">>, <<"CDF4F51D17B592FC592B9A75F86A6F808C23044BA7CF7B9534DEBBCC5C23B0EE">>},
14+
{<<"opentelemetry_api">>, <<"3DFBBFAA2C2ED3121C5C483162836C4F9027DEF469C41578AF5EF32589FCFC58">>},
15+
{<<"opentelemetry_semantic_conventions">>, <<"9681CCAA24FD3D810B4461581717661FD85FF7019B082C2DFF89C7D5B1FC2864">>}]}
16+
].

0 commit comments

Comments
 (0)