-
Notifications
You must be signed in to change notification settings - Fork 118
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 #309 from aws/aws_sdk_v2
aws sdk v2 instrumentation support
- Loading branch information
Showing
10 changed files
with
297 additions
and
12 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // Copyright 2017-2017 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. | ||
|
|
||
| package awsv2 | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| v2Middleware "github.com/aws/aws-sdk-go-v2/aws/middleware" | ||
| "github.com/aws/aws-xray-sdk-go/xray" | ||
| "github.com/aws/smithy-go/middleware" | ||
| smithyhttp "github.com/aws/smithy-go/transport/http" | ||
| ) | ||
|
|
||
| type awsV2SubsegmentKey struct{} | ||
|
|
||
| func initializeMiddlewareAfter(stack *middleware.Stack) error { | ||
| return stack.Initialize.Add(middleware.InitializeMiddlewareFunc("XRayInitializeMiddlewareAfter", func( | ||
| ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) ( | ||
| out middleware.InitializeOutput, metadata middleware.Metadata, err error) { | ||
|
|
||
| serviceName := v2Middleware.GetServiceID(ctx) | ||
| // Start the subsegment | ||
| ctx, subseg := xray.BeginSubsegment(ctx, serviceName) | ||
| if subseg == nil { | ||
| return | ||
| } | ||
| subseg.Namespace = "aws" | ||
| subseg.GetAWS()["region"] = v2Middleware.GetRegion(ctx) | ||
| subseg.GetAWS()["operation"] = v2Middleware.GetOperationName(ctx) | ||
|
|
||
| // set the subsegment in the context | ||
| ctx = context.WithValue(ctx, awsV2SubsegmentKey{}, subseg) | ||
|
|
||
| out, metadata, err = next.HandleInitialize(ctx, in) | ||
|
|
||
| // End the subsegment when the response returns from this middleware | ||
| defer subseg.Close(err) | ||
|
|
||
| return out, metadata, err | ||
| }), | ||
| middleware.After) | ||
| } | ||
|
|
||
| func deserializeMiddleware(stack *middleware.Stack) error { | ||
| return stack.Deserialize.Add(middleware.DeserializeMiddlewareFunc("XRayDeserializeMiddleware", func( | ||
| ctx context.Context, in middleware.DeserializeInput, next middleware.DeserializeHandler) ( | ||
| out middleware.DeserializeOutput, metadata middleware.Metadata, err error) { | ||
|
|
||
| subseg := ctx.Value(awsV2SubsegmentKey{}).(*xray.Segment) | ||
| in.Request.(*smithyhttp.Request).Header.Set(xray.TraceIDHeaderKey, subseg.DownstreamHeader().String()) | ||
|
|
||
| out, metadata, err = next.HandleDeserialize(ctx, in) | ||
|
|
||
| resp, ok := out.RawResponse.(*smithyhttp.Response) | ||
| if !ok { | ||
| // No raw response to wrap with. | ||
| return out, metadata, err | ||
| } | ||
|
|
||
| subseg.GetHTTP().GetResponse().ContentLength = int(resp.ContentLength) | ||
| requestID, ok := v2Middleware.GetRequestIDMetadata(metadata) | ||
|
|
||
| if ok { | ||
| subseg.GetAWS()[xray.RequestIDKey] = requestID | ||
| } | ||
| if extendedRequestID := resp.Header.Get(xray.S3ExtendedRequestIDHeaderKey); extendedRequestID != "" { | ||
| subseg.GetAWS()[xray.ExtendedRequestIDKey] = extendedRequestID | ||
| } | ||
|
|
||
| xray.HttpCaptureResponse(subseg, resp.StatusCode) | ||
| return out, metadata, err | ||
| }), | ||
| middleware.Before) | ||
| } | ||
|
|
||
| func AWSV2Instrumentor(apiOptions *[]func(*middleware.Stack) error) { | ||
| *apiOptions = append(*apiOptions, initializeMiddlewareAfter, deserializeMiddleware) | ||
| } |
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,153 @@ | ||
| // Copyright 2017-2017 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. | ||
|
|
||
| package awsv2 | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/aws/aws-sdk-go-v2/aws" | ||
| "github.com/aws/aws-sdk-go-v2/service/route53" | ||
| "github.com/aws/aws-sdk-go-v2/service/route53/types" | ||
| "github.com/aws/aws-xray-sdk-go/xray" | ||
| ) | ||
|
|
||
| func TestAWSV2(t *testing.T) { | ||
| cases := map[string]struct { | ||
| responseStatus int | ||
| responseBody []byte | ||
| expectedRegion string | ||
| expectedError string | ||
| expectedRequestID string | ||
| expectedStatusCode int | ||
| }{ | ||
| "fault response": { | ||
| responseStatus: 500, | ||
| responseBody: []byte(`<?xml version="1.0" encoding="UTF-8"?> | ||
| <InvalidChangeBatch xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> | ||
| <Messages> | ||
| <Message>Tried to create resource record set duplicate.example.com. type A, but it already exists</Message> | ||
| </Messages> | ||
| <RequestId>b25f48e8-84fd-11e6-80d9-574e0c4664cb</RequestId> | ||
| </InvalidChangeBatch>`), | ||
| expectedRegion: "us-east-1", | ||
| expectedError: "Error", | ||
| expectedRequestID: "b25f48e8-84fd-11e6-80d9-574e0c4664cb", | ||
| expectedStatusCode: 500, | ||
| }, | ||
|
|
||
| "error response": { | ||
| responseStatus: 404, | ||
| responseBody: []byte(`<?xml version="1.0"?> | ||
| <ErrorResponse xmlns="http://route53.amazonaws.com/doc/2016-09-07/"> | ||
| <Error> | ||
| <Type>Sender</Type> | ||
| <Code>MalformedXML</Code> | ||
| <Message>1 validation error detected: Value null at 'route53#ChangeSet' failed to satisfy constraint: Member must not be null</Message> | ||
| </Error> | ||
| <RequestId>1234567890A</RequestId> | ||
| </ErrorResponse> | ||
| `), | ||
| expectedRegion: "us-west-1", | ||
| expectedError: "Error", | ||
| expectedRequestID: "1234567890A", | ||
| expectedStatusCode: 404, | ||
| }, | ||
|
|
||
| "success response": { | ||
| responseStatus: 200, | ||
| responseBody: []byte(`<?xml version="1.0" encoding="UTF-8"?> | ||
| <ChangeResourceRecordSetsResponse> | ||
| <ChangeInfo> | ||
| <Comment>mockComment</Comment> | ||
| <Id>mockID</Id> | ||
| </ChangeInfo> | ||
| </ChangeResourceRecordSetsResponse>`), | ||
| expectedRegion: "us-west-2", | ||
| expectedStatusCode: 200, | ||
| }, | ||
| } | ||
|
|
||
| for name, c := range cases { | ||
| server := httptest.NewServer(http.HandlerFunc( | ||
| func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(c.responseStatus) | ||
| _, err := w.Write(c.responseBody) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| })) | ||
| defer server.Close() | ||
|
|
||
| t.Run(name, func(t *testing.T) { | ||
| ctx, root := xray.BeginSegment(context.Background(), "AWSSDKV2_Route53") | ||
|
|
||
| svc := route53.NewFromConfig(aws.Config{ | ||
| Region: c.expectedRegion, | ||
| EndpointResolver: aws.EndpointResolverFunc(func(service, region string) (aws.Endpoint, error) { | ||
| return aws.Endpoint{ | ||
| URL: server.URL, | ||
| SigningName: "route53", | ||
| }, nil | ||
| }), | ||
| Retryer: func() aws.Retryer { | ||
| return aws.NopRetryer{} | ||
| }, | ||
| }) | ||
|
|
||
| _, _ = svc.ChangeResourceRecordSets(ctx, &route53.ChangeResourceRecordSetsInput{ | ||
| ChangeBatch: &types.ChangeBatch{ | ||
| Changes: []types.Change{}, | ||
| Comment: aws.String("mock"), | ||
| }, | ||
| HostedZoneId: aws.String("zone"), | ||
| }, func(options *route53.Options) { | ||
| AWSV2Instrumentor(&options.APIOptions) | ||
| }) | ||
|
|
||
| root.Close(nil) | ||
| seg := xray.GetSegment(ctx) | ||
| var subseg *xray.Segment | ||
| _ = json.Unmarshal(seg.Subsegments[0], &subseg) | ||
|
|
||
| if e, a := "Route 53", subseg.Name; !strings.EqualFold(e, a) { | ||
| t.Errorf("expected segment name to be %s, got %s", e, a) | ||
| } | ||
|
|
||
| if e, a := c.expectedRegion, fmt.Sprintf("%v", subseg.GetAWS()["region"]); !strings.EqualFold(e, a) { | ||
| t.Errorf("expected subsegment name to be %s, got %s", e, a) | ||
| } | ||
|
|
||
| if e, a := "ChangeResourceRecordSets", fmt.Sprintf("%v", subseg.GetAWS()["operation"]); !strings.EqualFold(e, a) { | ||
| t.Errorf("expected operation to be %s, got %s", e, a) | ||
| } | ||
|
|
||
| if e, a := fmt.Sprint(c.expectedStatusCode), fmt.Sprintf("%v", subseg.GetHTTP().GetResponse().Status); !strings.EqualFold(e, a) { | ||
| t.Errorf("expected status code to be %s, got %s", e, a) | ||
| } | ||
|
|
||
| if e, a := "aws", subseg.Namespace; !strings.EqualFold(e, a) { | ||
| t.Errorf("expected namespace to be %s, got %s", e, a) | ||
| } | ||
|
|
||
| if subseg.GetAWS()[xray.RequestIDKey] != nil { | ||
| if e, a := c.expectedRequestID, fmt.Sprintf("%v", subseg.GetAWS()[xray.RequestIDKey]); !strings.EqualFold(e, a) { | ||
| t.Errorf("expected request id to be %s, got %s", e, a) | ||
| } | ||
| } | ||
| }) | ||
| time.Sleep(1 * time.Second) | ||
| } | ||
| } |
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
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