opentelemetry-instrumentation-aws_lambda 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +9 -0
- data/CHANGELOG.md +5 -0
- data/LICENSE +201 -0
- data/README.md +58 -0
- data/lib/opentelemetry/instrumentation/aws_lambda/handler.rb +198 -0
- data/lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb +29 -0
- data/lib/opentelemetry/instrumentation/aws_lambda/version.rb +13 -0
- data/lib/opentelemetry/instrumentation/aws_lambda.rb +19 -0
- data/lib/opentelemetry/instrumentation.rb +22 -0
- data/lib/opentelemetry-instrumentation-aws_lambda.rb +7 -0
- metadata +267 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 478a1378e713439847ad37af7d626fa51ca417b80f3bf7aa517a03fb99205015
|
4
|
+
data.tar.gz: 407cce283d1266bbb5566b25b98f65a51159111554dfea27118e2c89f11e4bb3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d959a0614ce836cb6d8579d0e5966a9b9a81982a7d05b5d28a2586d1e097c7cab7161d31fc93cfa8c19ea0e0a51f830fd78f3f90fa6de6844bc144399454e504
|
7
|
+
data.tar.gz: 352b3bc74695b9aa54f3eef67274a0a7ff549444020afe17a19439255ad4f33768630b9391c8c29977b8503c41ff5f07b867d3eefa6598dba135fc07c9afa73b
|
data/.yardopts
ADDED
data/CHANGELOG.md
ADDED
data/LICENSE
ADDED
@@ -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 The OpenTelemetry Authors
|
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.
|
data/README.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# OpenTelemetry AWS-Lambda Instrumentation
|
2
|
+
|
3
|
+
The OpenTelemetry `aws-lambda` gem is a community-maintained instrumentation for [AWS Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/ruby-handler.html).
|
4
|
+
|
5
|
+
## How do I get started?
|
6
|
+
|
7
|
+
Installation of the `opentelemetry-instrumentation-aws_lambda` gem is handled by the [OpenTelemetry Lambda Layer for Ruby](https://github.com/open-telemetry/opentelemetry-lambda/tree/main/ruby).
|
8
|
+
|
9
|
+
We do not advise installing the `opentelemetry-instrumentation-aws_lambda` gem directly into your Ruby lambda. Instead, clone the [OpenTelemetry Lambda Layer for Ruby](https://github.com/open-telemetry/opentelemetry-lambda/tree/main/ruby) and build the layer locally. Then, save it in your AWS account.
|
10
|
+
|
11
|
+
## Usage
|
12
|
+
|
13
|
+
From the Lambda Layer side, create the wrapper. More information can be found at https://github.com/open-telemetry/opentelemetry-lambda/tree/main/ruby
|
14
|
+
|
15
|
+
Below is an example of `ruby/src/layer/wrapper.rb`, where you can configure the layer to suit your needs before building it:
|
16
|
+
```ruby
|
17
|
+
require 'opentelemetry/sdk'
|
18
|
+
require 'opentelemetry/instrumentation/aws_lambda'
|
19
|
+
OpenTelemetry::SDK.configure do |c|
|
20
|
+
c.service_name = '<YOUR_SERVICE_NAME>'
|
21
|
+
c.use 'OpenTelemetry::Instrumentation::AwsLambda'
|
22
|
+
end
|
23
|
+
|
24
|
+
def otel_wrapper(event:, context:)
|
25
|
+
otel_wrapper = OpenTelemetry::Instrumentation::AwsLambda::Handler.new()
|
26
|
+
otel_wrapper.call_wrapped(event: event, context: context)
|
27
|
+
end
|
28
|
+
```
|
29
|
+
|
30
|
+
## Example
|
31
|
+
|
32
|
+
To run the example:
|
33
|
+
|
34
|
+
1. `cd` to the examples directory and install gems
|
35
|
+
* `cd example`
|
36
|
+
* `bundle install`
|
37
|
+
2. Run the sample client script
|
38
|
+
* `ruby trace_demonstration.rb`
|
39
|
+
|
40
|
+
This will run SNS publish command, printing OpenTelemetry traces to the console as it goes.
|
41
|
+
|
42
|
+
## How can I get involved?
|
43
|
+
|
44
|
+
The `opentelemetry-instrumentation-aws_lambda` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
|
45
|
+
|
46
|
+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
|
47
|
+
|
48
|
+
## License
|
49
|
+
|
50
|
+
Apache 2.0 license. See [LICENSE][license-github] for more information.
|
51
|
+
|
52
|
+
[aws-sdk-home]: https://github.com/aws/aws-sdk-ruby
|
53
|
+
[bundler-home]: https://bundler.io
|
54
|
+
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
|
55
|
+
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
|
56
|
+
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
|
57
|
+
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
|
58
|
+
[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
|
@@ -0,0 +1,198 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
module OpenTelemetry
|
8
|
+
module Instrumentation
|
9
|
+
module AwsLambda
|
10
|
+
AWS_TRIGGERS = ['aws:sqs', 'aws:s3', 'aws:sns', 'aws:dynamodb'].freeze
|
11
|
+
|
12
|
+
# Handler class that creates a span around the _HANDLER
|
13
|
+
class Handler
|
14
|
+
attr_reader :handler_method, :handler_class
|
15
|
+
|
16
|
+
# anytime when the code in a Lambda function is updated or the functional configuration is changed,
|
17
|
+
# the next invocation results in a cold start; therefore these instance variables will be up-to-date
|
18
|
+
def initialize
|
19
|
+
@flush_timeout = ENV.fetch('OTEL_INSTRUMENTATION_AWS_LAMBDA_FLUSH_TIMEOUT', '30000').to_i
|
20
|
+
@original_handler = ENV['ORIG_HANDLER'] || ENV['_HANDLER'] || ''
|
21
|
+
@handler_class = nil
|
22
|
+
@handler_method = nil
|
23
|
+
@handler_file = nil
|
24
|
+
|
25
|
+
resolve_original_handler
|
26
|
+
end
|
27
|
+
|
28
|
+
# Try to record and re-raise any exception from the wrapped function handler
|
29
|
+
# Instrumentation should never raise its own exception
|
30
|
+
def call_wrapped(event:, context:)
|
31
|
+
parent_context = extract_parent_context(event)
|
32
|
+
|
33
|
+
span_kind = nil
|
34
|
+
span_kind = if event['Records'] && AWS_TRIGGERS.include?(event['Records'].dig(0, 'eventSource'))
|
35
|
+
:consumer
|
36
|
+
else
|
37
|
+
:server
|
38
|
+
end
|
39
|
+
|
40
|
+
original_handler_error = nil
|
41
|
+
original_response = nil
|
42
|
+
OpenTelemetry::Context.with_current(parent_context) do
|
43
|
+
span_attributes = otel_attributes(event, context)
|
44
|
+
span = tracer.start_span(
|
45
|
+
@original_handler,
|
46
|
+
attributes: span_attributes,
|
47
|
+
kind: span_kind
|
48
|
+
)
|
49
|
+
|
50
|
+
begin
|
51
|
+
response = call_original_handler(event: event, context: context)
|
52
|
+
status_code = response['statusCode'] || response[:statusCode] if response.is_a?(Hash)
|
53
|
+
span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, status_code) if status_code
|
54
|
+
rescue StandardError => e
|
55
|
+
original_handler_error = e
|
56
|
+
ensure
|
57
|
+
original_response = response
|
58
|
+
end
|
59
|
+
rescue StandardError => e
|
60
|
+
OpenTelemetry.logger.error("aws-lambda instrumentation #{e.class}: #{e.message}")
|
61
|
+
ensure
|
62
|
+
if original_handler_error
|
63
|
+
span&.record_exception(original_handler_error)
|
64
|
+
span&.status = OpenTelemetry::Trace::Status.error(original_handler_error.message)
|
65
|
+
end
|
66
|
+
span&.finish
|
67
|
+
OpenTelemetry.tracer_provider.force_flush(timeout: @flush_timeout)
|
68
|
+
end
|
69
|
+
|
70
|
+
raise original_handler_error if original_handler_error
|
71
|
+
|
72
|
+
original_response
|
73
|
+
end
|
74
|
+
|
75
|
+
def instrumentation_config
|
76
|
+
AwsLambda::Instrumentation.instance.config
|
77
|
+
end
|
78
|
+
|
79
|
+
def tracer
|
80
|
+
AwsLambda::Instrumentation.instance.tracer
|
81
|
+
end
|
82
|
+
|
83
|
+
private
|
84
|
+
|
85
|
+
# we don't expose error if our code cause issue that block user's code
|
86
|
+
def resolve_original_handler
|
87
|
+
original_handler_parts = @original_handler.split('.')
|
88
|
+
if original_handler_parts.size == 2
|
89
|
+
@handler_file, @handler_method = original_handler_parts
|
90
|
+
elsif original_handler_parts.size == 3
|
91
|
+
@handler_file, @handler_class, @handler_method = original_handler_parts
|
92
|
+
else
|
93
|
+
OpenTelemetry.logger.error("aws-lambda instrumentation: Invalid handler #{original_handler}, must be of form FILENAME.METHOD or FILENAME.CLASS.METHOD.")
|
94
|
+
end
|
95
|
+
|
96
|
+
require @handler_file if @handler_file
|
97
|
+
end
|
98
|
+
|
99
|
+
def call_original_handler(event:, context:)
|
100
|
+
if @handler_class
|
101
|
+
Kernel.const_get(@handler_class).send(@handler_method, event: event, context: context)
|
102
|
+
else
|
103
|
+
__send__(@handler_method, event: event, context: context)
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
# Extract parent context from request headers
|
108
|
+
# Downcase Traceparent and Tracestate because TraceContext::TextMapPropagator's TRACEPARENT_KEY and TRACESTATE_KEY are all lowercase
|
109
|
+
# If any error occur, rescue and give empty context
|
110
|
+
def extract_parent_context(event)
|
111
|
+
headers = event['headers'] || {}
|
112
|
+
headers.transform_keys! do |key|
|
113
|
+
%w[Traceparent Tracestate].include?(key) ? key.downcase : key
|
114
|
+
end
|
115
|
+
|
116
|
+
OpenTelemetry.propagation.extract(
|
117
|
+
headers,
|
118
|
+
getter: OpenTelemetry::Context::Propagation.text_map_getter
|
119
|
+
)
|
120
|
+
rescue StandardError => e
|
121
|
+
OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while extracting the parent context: #{e.message}")
|
122
|
+
OpenTelemetry::Context.empty
|
123
|
+
end
|
124
|
+
|
125
|
+
# lambda event version 1.0 and version 2.0
|
126
|
+
# https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
|
127
|
+
def v1_proxy_attributes(event)
|
128
|
+
attributes = {
|
129
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => event['httpMethod'],
|
130
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => event['resource'],
|
131
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => event['resource']
|
132
|
+
}
|
133
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['queryStringParameters']}" if event['queryStringParameters']
|
134
|
+
|
135
|
+
headers = event['headers']
|
136
|
+
if headers
|
137
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT] = headers['User-Agent']
|
138
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME] = headers['X-Forwarded-Proto']
|
139
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME] = headers['Host']
|
140
|
+
end
|
141
|
+
attributes
|
142
|
+
end
|
143
|
+
|
144
|
+
def v2_proxy_attributes(event)
|
145
|
+
request_context = event['requestContext']
|
146
|
+
attributes = {
|
147
|
+
OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME => request_context['domainName'],
|
148
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => request_context['http']['method'],
|
149
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT => request_context['http']['userAgent'],
|
150
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => request_context['http']['path'],
|
151
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => request_context['http']['path']
|
152
|
+
}
|
153
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['rawQueryString']}" if event['rawQueryString']
|
154
|
+
attributes
|
155
|
+
end
|
156
|
+
|
157
|
+
# fass.trigger set to http: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#api-gateway
|
158
|
+
# TODO: need to update Semantic Conventions for invocation_id, trigger and resource_id
|
159
|
+
def otel_attributes(event, context)
|
160
|
+
span_attributes = {}
|
161
|
+
span_attributes['faas.invocation_id'] = context.aws_request_id
|
162
|
+
span_attributes['cloud.resource_id'] = context.invoked_function_arn
|
163
|
+
span_attributes[OpenTelemetry::SemanticConventions::Trace::AWS_LAMBDA_INVOKED_ARN] = context.invoked_function_arn
|
164
|
+
span_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_ACCOUNT_ID] = context.invoked_function_arn.split(':')[4]
|
165
|
+
|
166
|
+
if event['requestContext']
|
167
|
+
request_attributes = event['version'] == '2.0' ? v2_proxy_attributes(event) : v1_proxy_attributes(event)
|
168
|
+
request_attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'http'
|
169
|
+
span_attributes.merge!(request_attributes)
|
170
|
+
end
|
171
|
+
|
172
|
+
if event['Records']
|
173
|
+
trigger_attributes = trigger_type_attributes(event)
|
174
|
+
span_attributes.merge!(trigger_attributes)
|
175
|
+
end
|
176
|
+
|
177
|
+
span_attributes
|
178
|
+
rescue StandardError => e
|
179
|
+
OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while preparing span attributes: #{e.message}")
|
180
|
+
{}
|
181
|
+
end
|
182
|
+
|
183
|
+
# sqs spec for lambda: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#sqs
|
184
|
+
# current there is no spec for 'aws:sns', 'aws:s3' and 'aws:dynamodb'
|
185
|
+
def trigger_type_attributes(event)
|
186
|
+
attributes = {}
|
187
|
+
case event['Records'].dig(0, 'eventSource')
|
188
|
+
when 'aws:sqs'
|
189
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'pubsub'
|
190
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION] = 'process'
|
191
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_SYSTEM] = 'AmazonSQS'
|
192
|
+
end
|
193
|
+
attributes
|
194
|
+
end
|
195
|
+
end
|
196
|
+
end
|
197
|
+
end
|
198
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
module OpenTelemetry
|
8
|
+
module Instrumentation
|
9
|
+
module AwsLambda
|
10
|
+
# Instrumentation class that detects and installs the AwsLambda instrumentation
|
11
|
+
class Instrumentation < OpenTelemetry::Instrumentation::Base
|
12
|
+
install do |_config|
|
13
|
+
require_dependencies
|
14
|
+
end
|
15
|
+
|
16
|
+
# determine if current environment is lambda by checking _HANLDER or ORIG_HANDLER
|
17
|
+
present do
|
18
|
+
(ENV.key?('_HANDLER') || ENV.key?('ORIG_HANDLER'))
|
19
|
+
end
|
20
|
+
|
21
|
+
private
|
22
|
+
|
23
|
+
def require_dependencies
|
24
|
+
require_relative 'handler'
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
require 'opentelemetry'
|
8
|
+
require 'opentelemetry-instrumentation-base'
|
9
|
+
|
10
|
+
module OpenTelemetry
|
11
|
+
module Instrumentation
|
12
|
+
# Contains the OpenTelemetry instrumentation for the aws_lambda gem
|
13
|
+
module AwsLambda
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
require_relative 'aws_lambda/instrumentation'
|
19
|
+
require_relative 'aws_lambda/version'
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright The OpenTelemetry Authors
|
4
|
+
#
|
5
|
+
# SPDX-License-Identifier: Apache-2.0
|
6
|
+
|
7
|
+
# OpenTelemetry is an open source observability framework, providing a
|
8
|
+
# general-purpose API, SDK, and related tools required for the instrumentation
|
9
|
+
# of cloud-native software, frameworks, and libraries.
|
10
|
+
#
|
11
|
+
# The OpenTelemetry module provides global accessors for telemetry objects.
|
12
|
+
# See the documentation for the `opentelemetry-api` gem for details.
|
13
|
+
module OpenTelemetry
|
14
|
+
# "Instrumentation" are specified by
|
15
|
+
# https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library
|
16
|
+
#
|
17
|
+
# Instrumentation should be able to handle the case when the library is not installed on a user's system.
|
18
|
+
module Instrumentation
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
require_relative 'instrumentation/aws_lambda'
|
metadata
ADDED
@@ -0,0 +1,267 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: opentelemetry-instrumentation-aws_lambda
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- OpenTelemetry Authors
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2024-05-11 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: opentelemetry-api
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: opentelemetry-instrumentation-base
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 0.22.1
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 0.22.1
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: appraisal
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '2.5'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '2.5'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: bundler
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '2.4'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '2.4'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: minitest
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '5.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '5.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: opentelemetry-sdk
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '1.1'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '1.1'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: opentelemetry-test-helpers
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0.3'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0.3'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: pry
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: pry-byebug
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
- !ruby/object:Gem::Dependency
|
140
|
+
name: rspec-mocks
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - ">="
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0'
|
146
|
+
type: :development
|
147
|
+
prerelease: false
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
149
|
+
requirements:
|
150
|
+
- - ">="
|
151
|
+
- !ruby/object:Gem::Version
|
152
|
+
version: '0'
|
153
|
+
- !ruby/object:Gem::Dependency
|
154
|
+
name: rubocop
|
155
|
+
requirement: !ruby/object:Gem::Requirement
|
156
|
+
requirements:
|
157
|
+
- - "~>"
|
158
|
+
- !ruby/object:Gem::Version
|
159
|
+
version: 1.56.1
|
160
|
+
type: :development
|
161
|
+
prerelease: false
|
162
|
+
version_requirements: !ruby/object:Gem::Requirement
|
163
|
+
requirements:
|
164
|
+
- - "~>"
|
165
|
+
- !ruby/object:Gem::Version
|
166
|
+
version: 1.56.1
|
167
|
+
- !ruby/object:Gem::Dependency
|
168
|
+
name: rubocop-performance
|
169
|
+
requirement: !ruby/object:Gem::Requirement
|
170
|
+
requirements:
|
171
|
+
- - "~>"
|
172
|
+
- !ruby/object:Gem::Version
|
173
|
+
version: 1.19.1
|
174
|
+
type: :development
|
175
|
+
prerelease: false
|
176
|
+
version_requirements: !ruby/object:Gem::Requirement
|
177
|
+
requirements:
|
178
|
+
- - "~>"
|
179
|
+
- !ruby/object:Gem::Version
|
180
|
+
version: 1.19.1
|
181
|
+
- !ruby/object:Gem::Dependency
|
182
|
+
name: simplecov
|
183
|
+
requirement: !ruby/object:Gem::Requirement
|
184
|
+
requirements:
|
185
|
+
- - "~>"
|
186
|
+
- !ruby/object:Gem::Version
|
187
|
+
version: 0.17.1
|
188
|
+
type: :development
|
189
|
+
prerelease: false
|
190
|
+
version_requirements: !ruby/object:Gem::Requirement
|
191
|
+
requirements:
|
192
|
+
- - "~>"
|
193
|
+
- !ruby/object:Gem::Version
|
194
|
+
version: 0.17.1
|
195
|
+
- !ruby/object:Gem::Dependency
|
196
|
+
name: webmock
|
197
|
+
requirement: !ruby/object:Gem::Requirement
|
198
|
+
requirements:
|
199
|
+
- - "~>"
|
200
|
+
- !ruby/object:Gem::Version
|
201
|
+
version: '3.19'
|
202
|
+
type: :development
|
203
|
+
prerelease: false
|
204
|
+
version_requirements: !ruby/object:Gem::Requirement
|
205
|
+
requirements:
|
206
|
+
- - "~>"
|
207
|
+
- !ruby/object:Gem::Version
|
208
|
+
version: '3.19'
|
209
|
+
- !ruby/object:Gem::Dependency
|
210
|
+
name: yard
|
211
|
+
requirement: !ruby/object:Gem::Requirement
|
212
|
+
requirements:
|
213
|
+
- - "~>"
|
214
|
+
- !ruby/object:Gem::Version
|
215
|
+
version: '0.9'
|
216
|
+
type: :development
|
217
|
+
prerelease: false
|
218
|
+
version_requirements: !ruby/object:Gem::Requirement
|
219
|
+
requirements:
|
220
|
+
- - "~>"
|
221
|
+
- !ruby/object:Gem::Version
|
222
|
+
version: '0.9'
|
223
|
+
description: AWS Lambda instrumentation for the OpenTelemetry framework
|
224
|
+
email:
|
225
|
+
- cncf-opentelemetry-contributors@lists.cncf.io
|
226
|
+
executables: []
|
227
|
+
extensions: []
|
228
|
+
extra_rdoc_files: []
|
229
|
+
files:
|
230
|
+
- ".yardopts"
|
231
|
+
- CHANGELOG.md
|
232
|
+
- LICENSE
|
233
|
+
- README.md
|
234
|
+
- lib/opentelemetry-instrumentation-aws_lambda.rb
|
235
|
+
- lib/opentelemetry/instrumentation.rb
|
236
|
+
- lib/opentelemetry/instrumentation/aws_lambda.rb
|
237
|
+
- lib/opentelemetry/instrumentation/aws_lambda/handler.rb
|
238
|
+
- lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb
|
239
|
+
- lib/opentelemetry/instrumentation/aws_lambda/version.rb
|
240
|
+
homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
|
241
|
+
licenses:
|
242
|
+
- Apache-2.0
|
243
|
+
metadata:
|
244
|
+
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.1.0/file/CHANGELOG.md
|
245
|
+
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/aws_lambda
|
246
|
+
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
|
247
|
+
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.1.0
|
248
|
+
post_install_message:
|
249
|
+
rdoc_options: []
|
250
|
+
require_paths:
|
251
|
+
- lib
|
252
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
253
|
+
requirements:
|
254
|
+
- - ">="
|
255
|
+
- !ruby/object:Gem::Version
|
256
|
+
version: '3.0'
|
257
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
258
|
+
requirements:
|
259
|
+
- - ">="
|
260
|
+
- !ruby/object:Gem::Version
|
261
|
+
version: '0'
|
262
|
+
requirements: []
|
263
|
+
rubygems_version: 3.2.33
|
264
|
+
signing_key:
|
265
|
+
specification_version: 4
|
266
|
+
summary: AWS Lambda instrumentation for the OpenTelemetry framework
|
267
|
+
test_files: []
|