-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #677 from aws-powertools/develop
chore: Sync main with develop for release 1.17
- Loading branch information
Showing
17 changed files
with
1,951 additions
and
330 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
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
259 changes: 259 additions & 0 deletions
259
libraries/src/AWS.Lambda.Powertools.Tracing/Internal/TracingAspect.cs
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,259 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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. | ||
| */ | ||
|
|
||
| using System; | ||
| using System.Linq; | ||
| using System.Runtime.ExceptionServices; | ||
| using System.Text; | ||
| using System.Threading.Tasks; | ||
| using AspectInjector.Broker; | ||
| using AWS.Lambda.Powertools.Common; | ||
| using AWS.Lambda.Powertools.Common.Utils; | ||
|
|
||
| namespace AWS.Lambda.Powertools.Tracing.Internal; | ||
|
|
||
| /// <summary> | ||
| /// Tracing Aspect | ||
| /// Scope.Global is singleton | ||
| /// </summary> | ||
| [Aspect(Scope.Global, Factory = typeof(TracingAspectFactory))] | ||
| public class TracingAspect | ||
| { | ||
| /// <summary> | ||
| /// The Powertools for AWS Lambda (.NET) configurations | ||
| /// </summary> | ||
| private readonly IPowertoolsConfigurations _powertoolsConfigurations; | ||
|
|
||
| /// <summary> | ||
| /// X-Ray Recorder | ||
| /// </summary> | ||
| private readonly IXRayRecorder _xRayRecorder; | ||
|
|
||
| /// <summary> | ||
| /// If true, then is cold start | ||
| /// </summary> | ||
| private static bool _isColdStart = true; | ||
|
|
||
| /// <summary> | ||
| /// If true, capture annotations | ||
| /// </summary> | ||
| private static bool _captureAnnotations = true; | ||
|
|
||
| /// <summary> | ||
| /// If true, annotations have been captured | ||
| /// </summary> | ||
| private bool _isAnnotationsCaptured; | ||
|
|
||
| /// <summary> | ||
| /// Aspect constructor | ||
| /// </summary> | ||
| /// <param name="powertoolsConfigurations"></param> | ||
| /// <param name="xRayRecorder"></param> | ||
| public TracingAspect(IPowertoolsConfigurations powertoolsConfigurations, IXRayRecorder xRayRecorder) | ||
| { | ||
| _powertoolsConfigurations = powertoolsConfigurations; | ||
| _xRayRecorder = xRayRecorder; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Surrounds the specific method with Tracing aspect | ||
| /// </summary> | ||
| /// <param name="name"></param> | ||
| /// <param name="args"></param> | ||
| /// <param name="target"></param> | ||
| /// <param name="triggers"></param> | ||
| /// <returns></returns> | ||
| [Advice(Kind.Around)] | ||
| public object Around( | ||
| [Argument(Source.Name)] string name, | ||
| [Argument(Source.Arguments)] object[] args, | ||
| [Argument(Source.Target)] Func<object[], object> target, | ||
| [Argument(Source.Triggers)] Attribute[] triggers) | ||
| { | ||
| var trigger = triggers.OfType<TracingAttribute>().First(); | ||
|
|
||
| if (TracingDisabled()) | ||
| return target(args); | ||
|
|
||
| var @namespace = !string.IsNullOrWhiteSpace(trigger.Namespace) | ||
| ? trigger.Namespace | ||
| : _powertoolsConfigurations.Service; | ||
|
|
||
| var (segmentName, metadataName) = string.IsNullOrWhiteSpace(trigger.SegmentName) | ||
| ? ($"## {name}", name) | ||
| : (trigger.SegmentName, trigger.SegmentName); | ||
|
|
||
| BeginSegment(segmentName, @namespace); | ||
|
|
||
| try | ||
| { | ||
| var result = target(args); | ||
|
|
||
| if (result is Task task) | ||
| { | ||
| if (task.IsFaulted) | ||
| { | ||
| // Force the exception to be thrown | ||
| task.Exception?.Handle(ex => false); | ||
| } | ||
|
|
||
| // Only handle response if it's not a void Task | ||
| if (task.GetType().IsGenericType) | ||
| { | ||
| var taskResult = task.GetType().GetProperty("Result")?.GetValue(task); | ||
| HandleResponse(metadataName, taskResult, trigger.CaptureMode, @namespace); | ||
| } | ||
| _xRayRecorder.EndSubsegment(); | ||
| return task; | ||
| } | ||
|
|
||
| HandleResponse(metadataName, result, trigger.CaptureMode, @namespace); | ||
|
|
||
| _xRayRecorder.EndSubsegment(); | ||
| return result; | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| var actualException = ex is AggregateException ae ? ae.InnerException! : ex; | ||
| HandleException(actualException, metadataName, trigger.CaptureMode, @namespace); | ||
| _xRayRecorder.EndSubsegment(); | ||
|
|
||
| // Capture and rethrow the original exception preserving the stack trace | ||
| ExceptionDispatchInfo.Capture(actualException).Throw(); | ||
| throw; | ||
| } | ||
| finally | ||
| { | ||
| if (_isAnnotationsCaptured) | ||
| _captureAnnotations = true; | ||
| } | ||
| } | ||
|
|
||
| private void BeginSegment(string segmentName, string @namespace) | ||
| { | ||
| _xRayRecorder.BeginSubsegment(segmentName); | ||
| _xRayRecorder.SetNamespace(@namespace); | ||
|
|
||
| if (_captureAnnotations) | ||
| { | ||
| _xRayRecorder.AddAnnotation("ColdStart", _isColdStart); | ||
|
|
||
| _captureAnnotations = false; | ||
| _isAnnotationsCaptured = true; | ||
|
|
||
| if (_powertoolsConfigurations.IsServiceDefined) | ||
| _xRayRecorder.AddAnnotation("Service", _powertoolsConfigurations.Service); | ||
| } | ||
|
|
||
| _isColdStart = false; | ||
| } | ||
|
|
||
| private void HandleResponse(string name, object result, TracingCaptureMode captureMode, string @namespace) | ||
| { | ||
| if (!CaptureResponse(captureMode)) return; | ||
| if (result == null) return; // Don't try to serialize null results | ||
|
|
||
| // Skip if the result is VoidTaskResult | ||
| if (result.GetType().Name == "VoidTaskResult") return; | ||
|
|
||
| #if NET8_0_OR_GREATER | ||
| if (!RuntimeFeatureWrapper.IsDynamicCodeSupported) // is AOT | ||
| { | ||
| _xRayRecorder.AddMetadata( | ||
| @namespace, | ||
| $"{name} response", | ||
| Serializers.PowertoolsTracingSerializer.Serialize(result) | ||
| ); | ||
| return; | ||
| } | ||
| #endif | ||
|
|
||
| _xRayRecorder.AddMetadata( | ||
| @namespace, | ||
| $"{name} response", | ||
| result | ||
| ); | ||
| } | ||
|
|
||
| private void HandleException(Exception exception, string name, TracingCaptureMode captureMode, string @namespace) | ||
| { | ||
| if (!CaptureError(captureMode)) return; | ||
|
|
||
| var sb = new StringBuilder(); | ||
| sb.AppendLine($"Exception type: {exception.GetType()}"); | ||
| sb.AppendLine($"Exception message: {exception.Message}"); | ||
| sb.AppendLine($"Stack trace: {exception.StackTrace}"); | ||
|
|
||
| if (exception.InnerException != null) | ||
| { | ||
| sb.AppendLine("---BEGIN InnerException--- "); | ||
| sb.AppendLine($"Exception type {exception.InnerException.GetType()}"); | ||
| sb.AppendLine($"Exception message: {exception.InnerException.Message}"); | ||
| sb.AppendLine($"Stack trace: {exception.InnerException.StackTrace}"); | ||
| sb.AppendLine("---END Inner Exception"); | ||
| } | ||
|
|
||
| _xRayRecorder.AddMetadata( | ||
| @namespace, | ||
| $"{name} error", | ||
| sb.ToString() | ||
| ); | ||
| } | ||
|
|
||
| private bool TracingDisabled() | ||
| { | ||
| if (_powertoolsConfigurations.TracingDisabled) | ||
| { | ||
| Console.WriteLine("Tracing has been disabled via env var POWERTOOLS_TRACE_DISABLED"); | ||
| return true; | ||
| } | ||
|
|
||
| if (!_powertoolsConfigurations.IsLambdaEnvironment) | ||
| { | ||
| Console.WriteLine("Running outside Lambda environment; disabling Tracing"); | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| private bool CaptureResponse(TracingCaptureMode captureMode) | ||
| { | ||
| return captureMode switch | ||
| { | ||
| TracingCaptureMode.EnvironmentVariable => _powertoolsConfigurations.TracerCaptureResponse, | ||
| TracingCaptureMode.Response => true, | ||
| TracingCaptureMode.ResponseAndError => true, | ||
| _ => false | ||
| }; | ||
| } | ||
|
|
||
| private bool CaptureError(TracingCaptureMode captureMode) | ||
| { | ||
| return captureMode switch | ||
| { | ||
| TracingCaptureMode.EnvironmentVariable => _powertoolsConfigurations.TracerCaptureError, | ||
| TracingCaptureMode.Error => true, | ||
| TracingCaptureMode.ResponseAndError => true, | ||
| _ => false | ||
| }; | ||
| } | ||
|
|
||
| internal static void ResetForTest() | ||
| { | ||
| _isColdStart = true; | ||
| _captureAnnotations = true; | ||
| } | ||
| } |
Oops, something went wrong.