opentelemetry-instrumentation-aws_lambda 0.1.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -0
- data/README.md +32 -6
- data/lib/opentelemetry/instrumentation/aws_lambda/handler.rb +4 -132
- data/lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb +1 -0
- data/lib/opentelemetry/instrumentation/aws_lambda/version.rb +1 -1
- data/lib/opentelemetry/instrumentation/aws_lambda/wrap.rb +171 -0
- metadata +20 -19
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dc0776c77bfd96bef38c29a85b8e80ac9ab58edf35791e21c65f726637944155
|
4
|
+
data.tar.gz: 644962009b15fa624dc14ce58bad2ba61448a0a538d7d76be6b0900663ab8dac
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d3a6e698fa06ff9bb8af23f95ef1dc17d20f769c2826e2a134a280ebcb9e4958b264e9c4e0bc90b2bb8763df8305f40cb61a102fe1e563e9d85a77b0c29ca710
|
7
|
+
data.tar.gz: fab7d0e891d5d660af842cf76cff130093de8b90cd87c354954306ed6081ba6c77cca32b1e83d23fb655379bc69316c873908c48c3327547000a39171e75e7a4
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,16 @@
|
|
1
1
|
# Release History: opentelemetry-instrumentation-aws_lambda
|
2
2
|
|
3
|
+
### v0.3.0 / 2025-02-04
|
4
|
+
|
5
|
+
* ADDED: AWS Lambda programmatic wrap
|
6
|
+
* FIXED: AWS Lambda test fix
|
7
|
+
|
8
|
+
### v0.2.0 / 2025-01-16
|
9
|
+
|
10
|
+
* BREAKING CHANGE: Set minimum supported version to Ruby 3.1
|
11
|
+
|
12
|
+
* ADDED: Set minimum supported version to Ruby 3.1
|
13
|
+
|
3
14
|
### v0.1.1 / 2024-07-30
|
4
15
|
|
5
16
|
* FIXED: Register lambda span
|
data/README.md
CHANGED
@@ -2,17 +2,18 @@
|
|
2
2
|
|
3
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
4
|
|
5
|
-
## How do I get started?
|
5
|
+
## How do I get started?
|
6
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).
|
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
8
|
|
9
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
10
|
|
11
11
|
## Usage
|
12
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
|
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
14
|
|
15
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
|
+
|
16
17
|
```ruby
|
17
18
|
require 'opentelemetry/sdk'
|
18
19
|
require 'opentelemetry/instrumentation/aws_lambda'
|
@@ -27,6 +28,32 @@ def otel_wrapper(event:, context:)
|
|
27
28
|
end
|
28
29
|
```
|
29
30
|
|
31
|
+
### Alternative Usage
|
32
|
+
|
33
|
+
If using a Lambda Layer is not an option for your given setup, you can programmatically instrument a handler by using the `OpenTelemetry::Instrumentation::AwsLambda::Wrap` module.
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
require 'opentelemetry/sdk'
|
37
|
+
require 'opentelemetry/instrumentation/aws_lambda'
|
38
|
+
|
39
|
+
OpenTelemetry::SDK.configure do |c|
|
40
|
+
c.service_name = '<YOUR_SERVICE_NAME>'
|
41
|
+
c.use 'OpenTelemetry::Instrumentation::AwsLambda'
|
42
|
+
end
|
43
|
+
|
44
|
+
# Lambda Handler
|
45
|
+
module Example
|
46
|
+
class Handler
|
47
|
+
extend OpenTelemetry::Instrumentation::AwsLambda::Wrap
|
48
|
+
|
49
|
+
def self.process(event:, context:)
|
50
|
+
puts event.inspect
|
51
|
+
end
|
52
|
+
instrument_handler :process
|
53
|
+
end
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
30
57
|
## Example
|
31
58
|
|
32
59
|
To run the example:
|
@@ -44,16 +71,15 @@ This will run SNS publish command, printing OpenTelemetry traces to the console
|
|
44
71
|
|
45
72
|
The `opentelemetry-instrumentation-aws_lambda` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
|
46
73
|
|
47
|
-
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry
|
74
|
+
The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] 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].
|
48
75
|
|
49
76
|
## License
|
50
77
|
|
51
78
|
Apache 2.0 license. See [LICENSE][license-github] for more information.
|
52
79
|
|
53
|
-
[aws-sdk-home]: https://github.com/aws/aws-sdk-ruby
|
54
|
-
[bundler-home]: https://bundler.io
|
55
80
|
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
|
56
81
|
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
|
57
82
|
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
|
58
83
|
[community-meetings]: https://github.com/open-telemetry/community#community-meetings
|
84
|
+
[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
|
59
85
|
[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
|
@@ -7,10 +7,10 @@
|
|
7
7
|
module OpenTelemetry
|
8
8
|
module Instrumentation
|
9
9
|
module AwsLambda
|
10
|
-
AWS_TRIGGERS = ['aws:sqs', 'aws:s3', 'aws:sns', 'aws:dynamodb'].freeze
|
11
|
-
|
12
10
|
# Handler class that creates a span around the _HANDLER
|
13
11
|
class Handler
|
12
|
+
extend OpenTelemetry::Instrumentation::AwsLambda::Wrap
|
13
|
+
|
14
14
|
attr_reader :handler_method, :handler_class
|
15
15
|
|
16
16
|
# anytime when the code in a Lambda function is updated or the functional configuration is changed,
|
@@ -28,48 +28,9 @@ module OpenTelemetry
|
|
28
28
|
# Try to record and re-raise any exception from the wrapped function handler
|
29
29
|
# Instrumentation should never raise its own exception
|
30
30
|
def call_wrapped(event:, context:)
|
31
|
-
|
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
|
-
tracer.in_span(@original_handler, attributes: otel_attributes(event, context), kind: span_kind) do |span|
|
44
|
-
begin
|
45
|
-
response = call_original_handler(event: event, context: context)
|
46
|
-
status_code = response['statusCode'] || response[:statusCode] if response.is_a?(Hash)
|
47
|
-
span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, status_code) if status_code
|
48
|
-
rescue StandardError => e
|
49
|
-
original_handler_error = e
|
50
|
-
ensure
|
51
|
-
original_response = response
|
52
|
-
end
|
53
|
-
if original_handler_error
|
54
|
-
span.record_exception(original_handler_error)
|
55
|
-
span.status = OpenTelemetry::Trace::Status.error(original_handler_error.message)
|
56
|
-
end
|
57
|
-
end
|
31
|
+
self.class.wrap_lambda(event: event, context: context, handler: @original_handler, flush_timeout: @flush_timeout) do
|
32
|
+
call_original_handler(event: event, context: context)
|
58
33
|
end
|
59
|
-
|
60
|
-
OpenTelemetry.tracer_provider.force_flush(timeout: @flush_timeout)
|
61
|
-
|
62
|
-
raise original_handler_error if original_handler_error
|
63
|
-
|
64
|
-
original_response
|
65
|
-
end
|
66
|
-
|
67
|
-
def instrumentation_config
|
68
|
-
AwsLambda::Instrumentation.instance.config
|
69
|
-
end
|
70
|
-
|
71
|
-
def tracer
|
72
|
-
AwsLambda::Instrumentation.instance.tracer
|
73
34
|
end
|
74
35
|
|
75
36
|
private
|
@@ -95,95 +56,6 @@ module OpenTelemetry
|
|
95
56
|
__send__(@handler_method, event: event, context: context)
|
96
57
|
end
|
97
58
|
end
|
98
|
-
|
99
|
-
# Extract parent context from request headers
|
100
|
-
# Downcase Traceparent and Tracestate because TraceContext::TextMapPropagator's TRACEPARENT_KEY and TRACESTATE_KEY are all lowercase
|
101
|
-
# If any error occur, rescue and give empty context
|
102
|
-
def extract_parent_context(event)
|
103
|
-
headers = event['headers'] || {}
|
104
|
-
headers.transform_keys! do |key|
|
105
|
-
%w[Traceparent Tracestate].include?(key) ? key.downcase : key
|
106
|
-
end
|
107
|
-
|
108
|
-
OpenTelemetry.propagation.extract(
|
109
|
-
headers,
|
110
|
-
getter: OpenTelemetry::Context::Propagation.text_map_getter
|
111
|
-
)
|
112
|
-
rescue StandardError => e
|
113
|
-
OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while extracting the parent context: #{e.message}")
|
114
|
-
OpenTelemetry::Context.empty
|
115
|
-
end
|
116
|
-
|
117
|
-
# lambda event version 1.0 and version 2.0
|
118
|
-
# https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
|
119
|
-
def v1_proxy_attributes(event)
|
120
|
-
attributes = {
|
121
|
-
OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => event['httpMethod'],
|
122
|
-
OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => event['resource'],
|
123
|
-
OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => event['resource']
|
124
|
-
}
|
125
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['queryStringParameters']}" if event['queryStringParameters']
|
126
|
-
|
127
|
-
headers = event['headers']
|
128
|
-
if headers
|
129
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT] = headers['User-Agent']
|
130
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME] = headers['X-Forwarded-Proto']
|
131
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME] = headers['Host']
|
132
|
-
end
|
133
|
-
attributes
|
134
|
-
end
|
135
|
-
|
136
|
-
def v2_proxy_attributes(event)
|
137
|
-
request_context = event['requestContext']
|
138
|
-
attributes = {
|
139
|
-
OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME => request_context['domainName'],
|
140
|
-
OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => request_context['http']['method'],
|
141
|
-
OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT => request_context['http']['userAgent'],
|
142
|
-
OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => request_context['http']['path'],
|
143
|
-
OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => request_context['http']['path']
|
144
|
-
}
|
145
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['rawQueryString']}" if event['rawQueryString']
|
146
|
-
attributes
|
147
|
-
end
|
148
|
-
|
149
|
-
# fass.trigger set to http: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#api-gateway
|
150
|
-
# TODO: need to update Semantic Conventions for invocation_id, trigger and resource_id
|
151
|
-
def otel_attributes(event, context)
|
152
|
-
span_attributes = {}
|
153
|
-
span_attributes['faas.invocation_id'] = context.aws_request_id
|
154
|
-
span_attributes['cloud.resource_id'] = context.invoked_function_arn
|
155
|
-
span_attributes[OpenTelemetry::SemanticConventions::Trace::AWS_LAMBDA_INVOKED_ARN] = context.invoked_function_arn
|
156
|
-
span_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_ACCOUNT_ID] = context.invoked_function_arn.split(':')[4]
|
157
|
-
|
158
|
-
if event['requestContext']
|
159
|
-
request_attributes = event['version'] == '2.0' ? v2_proxy_attributes(event) : v1_proxy_attributes(event)
|
160
|
-
request_attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'http'
|
161
|
-
span_attributes.merge!(request_attributes)
|
162
|
-
end
|
163
|
-
|
164
|
-
if event['Records']
|
165
|
-
trigger_attributes = trigger_type_attributes(event)
|
166
|
-
span_attributes.merge!(trigger_attributes)
|
167
|
-
end
|
168
|
-
|
169
|
-
span_attributes
|
170
|
-
rescue StandardError => e
|
171
|
-
OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while preparing span attributes: #{e.message}")
|
172
|
-
{}
|
173
|
-
end
|
174
|
-
|
175
|
-
# sqs spec for lambda: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#sqs
|
176
|
-
# current there is no spec for 'aws:sns', 'aws:s3' and 'aws:dynamodb'
|
177
|
-
def trigger_type_attributes(event)
|
178
|
-
attributes = {}
|
179
|
-
case event['Records'].dig(0, 'eventSource')
|
180
|
-
when 'aws:sqs'
|
181
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'pubsub'
|
182
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION] = 'process'
|
183
|
-
attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_SYSTEM] = 'AmazonSQS'
|
184
|
-
end
|
185
|
-
attributes
|
186
|
-
end
|
187
59
|
end
|
188
60
|
end
|
189
61
|
end
|
@@ -0,0 +1,171 @@
|
|
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
|
+
# Helper module that can be used to wrap a lambda handler method
|
11
|
+
module Wrap # rubocop:disable Metrics/ModuleLength
|
12
|
+
AWS_TRIGGERS = ['aws:sqs', 'aws:s3', 'aws:sns', 'aws:dynamodb'].freeze
|
13
|
+
DEFAULT_FLUSH_TIMEOUT = ENV.fetch('OTEL_INSTRUMENTATION_AWS_LAMBDA_FLUSH_TIMEOUT', '30000').to_i
|
14
|
+
|
15
|
+
def instrument_handler(method, flush_timeout: DEFAULT_FLUSH_TIMEOUT)
|
16
|
+
raise ArgumentError, "#{method} is not a method of #{name}" unless respond_to?(method)
|
17
|
+
|
18
|
+
uninstrumented_method = "#{method}_without_instrumentation"
|
19
|
+
singleton_class.alias_method uninstrumented_method, method
|
20
|
+
|
21
|
+
handler = "#{name}.#{method}"
|
22
|
+
|
23
|
+
define_singleton_method(method) do |event:, context:|
|
24
|
+
wrap_lambda(event: event, context: context, handler: handler, flush_timeout: flush_timeout) { public_send(uninstrumented_method, event: event, context: context) }
|
25
|
+
end
|
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 wrap_lambda(event:, context:, handler:, flush_timeout: DEFAULT_FLUSH_TIMEOUT)
|
31
|
+
parent_context = extract_parent_context(event)
|
32
|
+
|
33
|
+
span_kind = if event['Records'] && AWS_TRIGGERS.include?(event['Records'].dig(0, 'eventSource'))
|
34
|
+
:consumer
|
35
|
+
else
|
36
|
+
:server
|
37
|
+
end
|
38
|
+
|
39
|
+
original_handler_error = nil
|
40
|
+
original_response = nil
|
41
|
+
OpenTelemetry::Context.with_current(parent_context) do
|
42
|
+
tracer.in_span(handler, attributes: otel_attributes(event, context), kind: span_kind) do |span|
|
43
|
+
begin
|
44
|
+
response = yield
|
45
|
+
|
46
|
+
unless span.attributes.key?(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE)
|
47
|
+
status_code = response['statusCode'] || response[:statusCode] if response.is_a?(Hash)
|
48
|
+
span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, status_code) if status_code
|
49
|
+
end
|
50
|
+
rescue StandardError => e
|
51
|
+
original_handler_error = e
|
52
|
+
ensure
|
53
|
+
original_response = response
|
54
|
+
end
|
55
|
+
if original_handler_error
|
56
|
+
span.record_exception(original_handler_error)
|
57
|
+
span.status = OpenTelemetry::Trace::Status.error(original_handler_error.message)
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
OpenTelemetry.tracer_provider.force_flush(timeout: flush_timeout)
|
63
|
+
OpenTelemetry.meter_provider.force_flush(timeout: flush_timeout) if OpenTelemetry.respond_to?(:meter_provider)
|
64
|
+
|
65
|
+
raise original_handler_error if original_handler_error
|
66
|
+
|
67
|
+
original_response
|
68
|
+
end
|
69
|
+
|
70
|
+
def instrumentation_config
|
71
|
+
AwsLambda::Instrumentation.instance.config
|
72
|
+
end
|
73
|
+
|
74
|
+
def tracer
|
75
|
+
AwsLambda::Instrumentation.instance.tracer
|
76
|
+
end
|
77
|
+
|
78
|
+
private
|
79
|
+
|
80
|
+
# Extract parent context from request headers
|
81
|
+
# Downcase Traceparent and Tracestate because TraceContext::TextMapPropagator's TRACEPARENT_KEY and TRACESTATE_KEY are all lowercase
|
82
|
+
# If any error occur, rescue and give empty context
|
83
|
+
def extract_parent_context(event)
|
84
|
+
headers = event['headers'] || {}
|
85
|
+
headers.transform_keys! do |key|
|
86
|
+
%w[Traceparent Tracestate].include?(key) ? key.downcase : key
|
87
|
+
end
|
88
|
+
|
89
|
+
OpenTelemetry.propagation.extract(
|
90
|
+
headers,
|
91
|
+
getter: OpenTelemetry::Context::Propagation.text_map_getter
|
92
|
+
)
|
93
|
+
rescue StandardError => e
|
94
|
+
OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while extracting the parent context: #{e.message}")
|
95
|
+
OpenTelemetry::Context.empty
|
96
|
+
end
|
97
|
+
|
98
|
+
# lambda event version 1.0 and version 2.0
|
99
|
+
# https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
|
100
|
+
def v1_proxy_attributes(event)
|
101
|
+
attributes = {
|
102
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => event['httpMethod'],
|
103
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => event['resource'],
|
104
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => event['resource']
|
105
|
+
}
|
106
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['queryStringParameters']}" if event['queryStringParameters']
|
107
|
+
|
108
|
+
headers = event['headers']
|
109
|
+
if headers
|
110
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT] = headers['User-Agent']
|
111
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME] = headers['X-Forwarded-Proto']
|
112
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME] = headers['Host']
|
113
|
+
end
|
114
|
+
attributes
|
115
|
+
end
|
116
|
+
|
117
|
+
def v2_proxy_attributes(event)
|
118
|
+
request_context = event['requestContext']
|
119
|
+
attributes = {
|
120
|
+
OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME => request_context['domainName'],
|
121
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => request_context['http']['method'],
|
122
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT => request_context['http']['userAgent'],
|
123
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => request_context['http']['path'],
|
124
|
+
OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => request_context['http']['path']
|
125
|
+
}
|
126
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['rawQueryString']}" if event['rawQueryString']
|
127
|
+
attributes
|
128
|
+
end
|
129
|
+
|
130
|
+
# fass.trigger set to http: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#api-gateway
|
131
|
+
# TODO: need to update Semantic Conventions for invocation_id, trigger and resource_id
|
132
|
+
def otel_attributes(event, context)
|
133
|
+
span_attributes = {}
|
134
|
+
span_attributes['faas.invocation_id'] = context.aws_request_id
|
135
|
+
span_attributes['cloud.resource_id'] = context.invoked_function_arn
|
136
|
+
span_attributes[OpenTelemetry::SemanticConventions::Trace::AWS_LAMBDA_INVOKED_ARN] = context.invoked_function_arn
|
137
|
+
span_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_ACCOUNT_ID] = context.invoked_function_arn.split(':')[4]
|
138
|
+
|
139
|
+
if event['requestContext']
|
140
|
+
request_attributes = event['version'] == '2.0' ? v2_proxy_attributes(event) : v1_proxy_attributes(event)
|
141
|
+
request_attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'http'
|
142
|
+
span_attributes.merge!(request_attributes)
|
143
|
+
end
|
144
|
+
|
145
|
+
if event['Records']
|
146
|
+
trigger_attributes = trigger_type_attributes(event)
|
147
|
+
span_attributes.merge!(trigger_attributes)
|
148
|
+
end
|
149
|
+
|
150
|
+
span_attributes
|
151
|
+
rescue StandardError => e
|
152
|
+
OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while preparing span attributes: #{e.message}")
|
153
|
+
{}
|
154
|
+
end
|
155
|
+
|
156
|
+
# sqs spec for lambda: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#sqs
|
157
|
+
# current there is no spec for 'aws:sns', 'aws:s3' and 'aws:dynamodb'
|
158
|
+
def trigger_type_attributes(event)
|
159
|
+
attributes = {}
|
160
|
+
case event['Records'].dig(0, 'eventSource')
|
161
|
+
when 'aws:sqs'
|
162
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'pubsub'
|
163
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION] = 'process'
|
164
|
+
attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_SYSTEM] = 'AmazonSQS'
|
165
|
+
end
|
166
|
+
attributes
|
167
|
+
end
|
168
|
+
end
|
169
|
+
end
|
170
|
+
end
|
171
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: opentelemetry-instrumentation-aws_lambda
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- OpenTelemetry Authors
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2025-02-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: opentelemetry-api
|
@@ -30,14 +30,14 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 0.
|
33
|
+
version: 0.23.0
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 0.
|
40
|
+
version: 0.23.0
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: appraisal
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -156,56 +156,56 @@ dependencies:
|
|
156
156
|
requirements:
|
157
157
|
- - "~>"
|
158
158
|
- !ruby/object:Gem::Version
|
159
|
-
version: 1.
|
159
|
+
version: 1.71.0
|
160
160
|
type: :development
|
161
161
|
prerelease: false
|
162
162
|
version_requirements: !ruby/object:Gem::Requirement
|
163
163
|
requirements:
|
164
164
|
- - "~>"
|
165
165
|
- !ruby/object:Gem::Version
|
166
|
-
version: 1.
|
166
|
+
version: 1.71.0
|
167
167
|
- !ruby/object:Gem::Dependency
|
168
168
|
name: rubocop-performance
|
169
169
|
requirement: !ruby/object:Gem::Requirement
|
170
170
|
requirements:
|
171
171
|
- - "~>"
|
172
172
|
- !ruby/object:Gem::Version
|
173
|
-
version: 1.
|
173
|
+
version: 1.23.0
|
174
174
|
type: :development
|
175
175
|
prerelease: false
|
176
176
|
version_requirements: !ruby/object:Gem::Requirement
|
177
177
|
requirements:
|
178
178
|
- - "~>"
|
179
179
|
- !ruby/object:Gem::Version
|
180
|
-
version: 1.
|
180
|
+
version: 1.23.0
|
181
181
|
- !ruby/object:Gem::Dependency
|
182
182
|
name: simplecov
|
183
183
|
requirement: !ruby/object:Gem::Requirement
|
184
184
|
requirements:
|
185
185
|
- - "~>"
|
186
186
|
- !ruby/object:Gem::Version
|
187
|
-
version: 0.
|
187
|
+
version: 0.22.0
|
188
188
|
type: :development
|
189
189
|
prerelease: false
|
190
190
|
version_requirements: !ruby/object:Gem::Requirement
|
191
191
|
requirements:
|
192
192
|
- - "~>"
|
193
193
|
- !ruby/object:Gem::Version
|
194
|
-
version: 0.
|
194
|
+
version: 0.22.0
|
195
195
|
- !ruby/object:Gem::Dependency
|
196
196
|
name: webmock
|
197
197
|
requirement: !ruby/object:Gem::Requirement
|
198
198
|
requirements:
|
199
199
|
- - "~>"
|
200
200
|
- !ruby/object:Gem::Version
|
201
|
-
version:
|
201
|
+
version: 3.24.0
|
202
202
|
type: :development
|
203
203
|
prerelease: false
|
204
204
|
version_requirements: !ruby/object:Gem::Requirement
|
205
205
|
requirements:
|
206
206
|
- - "~>"
|
207
207
|
- !ruby/object:Gem::Version
|
208
|
-
version:
|
208
|
+
version: 3.24.0
|
209
209
|
- !ruby/object:Gem::Dependency
|
210
210
|
name: yard
|
211
211
|
requirement: !ruby/object:Gem::Requirement
|
@@ -237,15 +237,16 @@ files:
|
|
237
237
|
- lib/opentelemetry/instrumentation/aws_lambda/handler.rb
|
238
238
|
- lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb
|
239
239
|
- lib/opentelemetry/instrumentation/aws_lambda/version.rb
|
240
|
+
- lib/opentelemetry/instrumentation/aws_lambda/wrap.rb
|
240
241
|
homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
|
241
242
|
licenses:
|
242
243
|
- Apache-2.0
|
243
244
|
metadata:
|
244
|
-
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.
|
245
|
+
changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.3.0/file/CHANGELOG.md
|
245
246
|
source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/aws_lambda
|
246
247
|
bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
|
247
|
-
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.
|
248
|
-
post_install_message:
|
248
|
+
documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.3.0
|
249
|
+
post_install_message:
|
249
250
|
rdoc_options: []
|
250
251
|
require_paths:
|
251
252
|
- lib
|
@@ -253,15 +254,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
253
254
|
requirements:
|
254
255
|
- - ">="
|
255
256
|
- !ruby/object:Gem::Version
|
256
|
-
version: '3.
|
257
|
+
version: '3.1'
|
257
258
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
258
259
|
requirements:
|
259
260
|
- - ">="
|
260
261
|
- !ruby/object:Gem::Version
|
261
262
|
version: '0'
|
262
263
|
requirements: []
|
263
|
-
rubygems_version: 3.
|
264
|
-
signing_key:
|
264
|
+
rubygems_version: 3.3.27
|
265
|
+
signing_key:
|
265
266
|
specification_version: 4
|
266
267
|
summary: AWS Lambda instrumentation for the OpenTelemetry framework
|
267
268
|
test_files: []
|