forked from open-telemetry/opentelemetry-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(aws-sdk): lambda client instrumentation (open-telemetry#916)
- Loading branch information
1 parent
cc37e3f
commit dc6c2b5
Showing
8 changed files
with
557 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
plugins/node/opentelemetry-instrumentation-aws-sdk/doc/lambda.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Lambda | ||
|
|
||
| Lambda is Amazon's function-as-a-service (FaaS) platform. This instrumentation follows the [OpenTelemetry specification for FaaS systems](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/faas.md). | ||
|
|
||
| ## Specific trace semantics | ||
|
|
||
| The following methods are automatically enhanced: | ||
|
|
||
| ### Invoke | ||
|
|
||
| - Attributes are added by this instrumentation according to the [spec for Outgoing Invocations of a FaaS from a client](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/faas.md#outgoing-invocations) . | ||
| - OpenTelemetry trace context is injected into the `ClientContext` parameter, allowing functions to extract this using the `Custom` property within the function. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
141 changes: 141 additions & 0 deletions
141
plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/lambda.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| import { | ||
| Span, | ||
| SpanKind, | ||
| Tracer, | ||
| diag, | ||
| SpanAttributes, | ||
| } from '@opentelemetry/api'; | ||
| import { SemanticAttributes } from '@opentelemetry/semantic-conventions'; | ||
| import { | ||
| AwsSdkInstrumentationConfig, | ||
| NormalizedRequest, | ||
| NormalizedResponse, | ||
| } from '../types'; | ||
| import { RequestMetadata, ServiceExtension } from './ServiceExtension'; | ||
| import { context, propagation } from '@opentelemetry/api'; | ||
|
|
||
| class LambdaCommands { | ||
| public static readonly Invoke: string = 'Invoke'; | ||
| } | ||
|
|
||
| export class LambdaServiceExtension implements ServiceExtension { | ||
| requestPreSpanHook(request: NormalizedRequest): RequestMetadata { | ||
| const functionName = this.extractFunctionName(request.commandInput); | ||
|
|
||
| let spanAttributes: SpanAttributes = {}; | ||
| let spanName: string | undefined; | ||
|
|
||
| switch (request.commandName) { | ||
| case 'Invoke': | ||
| spanAttributes = { | ||
| [SemanticAttributes.FAAS_INVOKED_NAME]: functionName, | ||
| [SemanticAttributes.FAAS_INVOKED_PROVIDER]: 'aws', | ||
| }; | ||
| if (request.region) { | ||
| spanAttributes[SemanticAttributes.FAAS_INVOKED_REGION] = | ||
| request.region; | ||
| } | ||
| spanName = `${functionName} ${LambdaCommands.Invoke}`; | ||
| break; | ||
| } | ||
| return { | ||
| isIncoming: false, | ||
| spanAttributes, | ||
| spanKind: SpanKind.CLIENT, | ||
| spanName, | ||
| }; | ||
| } | ||
|
|
||
| requestPostSpanHook = (request: NormalizedRequest) => { | ||
| switch (request.commandName) { | ||
| case LambdaCommands.Invoke: | ||
| { | ||
| if (request.commandInput) { | ||
| request.commandInput.ClientContext = injectLambdaPropagationContext( | ||
| request.commandInput.ClientContext | ||
| ); | ||
| } | ||
| } | ||
| break; | ||
| } | ||
| }; | ||
|
|
||
| responseHook( | ||
| response: NormalizedResponse, | ||
| span: Span, | ||
| tracer: Tracer, | ||
| config: AwsSdkInstrumentationConfig | ||
| ) { | ||
| switch (response.request.commandName) { | ||
| case LambdaCommands.Invoke: | ||
| { | ||
| span.setAttribute( | ||
| SemanticAttributes.FAAS_EXECUTION, | ||
| response.requestId | ||
| ); | ||
| } | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| extractFunctionName = (commandInput: Record<string, any>): string => { | ||
| return commandInput?.FunctionName; | ||
| }; | ||
| } | ||
|
|
||
| const injectLambdaPropagationContext = ( | ||
| clientContext: string | undefined | ||
| ): string | undefined => { | ||
| try { | ||
| const propagatedContext = {}; | ||
| propagation.inject(context.active(), propagatedContext); | ||
|
|
||
| const parsedClientContext = clientContext | ||
| ? JSON.parse(Buffer.from(clientContext, 'base64').toString('utf8')) | ||
| : {}; | ||
|
|
||
| const updatedClientContext = { | ||
| ...parsedClientContext, | ||
| Custom: { | ||
| ...parsedClientContext.Custom, | ||
| ...propagatedContext, | ||
| }, | ||
| }; | ||
|
|
||
| const encodedClientContext = Buffer.from( | ||
| JSON.stringify(updatedClientContext) | ||
| ).toString('base64'); | ||
|
|
||
| // The length of client context is capped at 3583 bytes of base64 encoded data | ||
| // (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) | ||
| if (encodedClientContext.length > 3583) { | ||
| diag.warn( | ||
| 'lambda instrumentation: cannot set context propagation on lambda invoke parameters due to ClientContext length limitations.' | ||
| ); | ||
| return clientContext; | ||
| } | ||
|
|
||
| return encodedClientContext; | ||
| } catch (e) { | ||
| diag.debug( | ||
| 'lambda instrumentation: failed to set context propagation on ClientContext', | ||
| e | ||
| ); | ||
| return clientContext; | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.