Instrument RPC calls to amazon SQS by stuartnelson3 · Pull Request #933 · elastic/apm-agent-go

stuartnelson3 · 2021-04-14T09:08:31Z

Add instrumentation for SQS methods for sending/receiving/deleting messages.

Note:
Ignoring message queues is part of the messaging spec, but will be included later. This is being tracked in #934.

closes #883

ghost · 2021-04-14T09:17:44Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Build Cause: Pull request #933 updated
Start Time: 2021-04-15T09:36:01.549+0000
Duration: 28 min 30 sec
Commit: 0de1b64

Test stats 🧪

Test	Results
Failed	0
Passed	10173
Skipped	266
Total	10439

Trends 🧪

axw

Looks good, with the caveat that I don't really know SQS. We should be recording trace context (traceparent & tracestate) in message attributes.

module/apmawssdkgo/sqs.go

Add the trace context header to the message attribute metadata when creating messages.

stuartnelson3 · 2021-04-14T17:02:56Z

I added the trace context to the message attributes, but when I was inspecting the body for SendMessage it seems like it's tripled, which is a bit worrisome:

Action=SendMessage
MessageAttribute.1.Name=attr
MessageAttribute.1.Value.DataType=String
MessageAttribute.1.Value.StringValue=string+attr
MessageAttribute.2.Name=traceContext
MessageAttribute.2.Value.DataType=String
MessageAttribute.2.Value.StringValue=00-a766982841306178091fb3f9c0c1e5b5-a49abb74fdf1b46a-01
MessageBody=msg+body
QueueUrl=https%3A%2F%2Fsqs.testing.invalid%2F123456789012%2FOtherQueue
Version=2012-11-05Action=SendMessage
MessageAttribute.1.Name=attr
MessageAttribute.1.Value.DataType=String
MessageAttribute.1.Value.StringValue=string+attr
MessageAttribute.2.Name=traceContext
MessageAttribute.2.Value.DataType=String
MessageAttribute.2.Value.StringValue=00-a766982841306178091fb3f9c0c1e5b5-a49abb74fdf1b46a-01
MessageBody=msg+body
QueueUrl=https%3A%2F%2Fsqs.testing.invalid%2F123456789012%2FOtherQueue
Version=2012-11-05Action=SendMessage
MessageAttribute.1.Name=attr
MessageAttribute.1.Value.DataType=String
MessageAttribute.1.Value.StringValue=string+attr
MessageAttribute.2.Name=traceContext
MessageAttribute.2.Value.DataType=String
MessageAttribute.2.Value.StringValue=00-a766982841306178091fb3f9c0c1e5b5-a49abb74fdf1b46a-01
MessageBody=msg+body
QueueUrl=https%3A%2F%2Fsqs.testing.invalid%2F123456789012%2FOtherQueue
Version=2012-11-05

I removed all the instrumentation we do (don't add build, send, complete to the handlers list), and it's still showing duplicates, so maybe it's a bug..?

Action=SendMessage
MessageAttribute.1.Name=attr
MessageAttribute.1.Value.DataType=String
MessageAttribute.1.Value.StringValue=string+attr
MessageBody=msg+body
QueueUrl=https%3A%2F%2Fsqs.testing.invalid%2F123456789012%2FOtherQueue
Version=2012-11-05Action=SendMessage
MessageAttribute.1.Name=attr
MessageAttribute.1.Value.DataType=String
MessageAttribute.1.Value.StringValue=string+attr
MessageBody=msg+body
QueueUrl=https%3A%2F%2Fsqs.testing.invalid%2F123456789012%2FOtherQueue
Version=2012-11-05Action=SendMessage
MessageAttribute.1.Name=attr
MessageAttribute.1.Value.DataType=String
MessageAttribute.1.Value.StringValue=string+attr
MessageBody=msg+body
QueueUrl=https%3A%2F%2Fsqs.testing.invalid%2F123456789012%2FOtherQueue
Version=2012-11-05Action=SendMessage
MessageAttribute.1.Name=attr
MessageAttribute.1.Value.DataType=String
MessageAttribute.1.Value.StringValue=string+attr
MessageBody=msg+body
QueueUrl=https%3A%2F%2Fsqs.testing.invalid%2F123456789012%2FOtherQueue
Version=2012-11-05

This is not happening in SendMessageBatch. I'm not sure what might be causing this from our end.

module/apmawssdkgo/session.go

module/apmawssdkgo/sqs.go

module/apmawssdkgo/sqs_test.go

stuartnelson3 · 2021-04-15T09:37:11Z

module/apmawssdkgo/sqs_test.go

+		if tc.hasTraceContext {
+			wrapped.Handlers.Build.PushBackNamed(request.NamedHandler{
+				Name: "spy_message_attrs_added",
+				Fn:   testTracingAttributes(t),


Took some inspiration from the ruby client test and added another handler to inspect that the params were correctly modified.

axw

looks good!

Add support for tracing AWS SQS RPCs when using a wrapped `*session.Session` struct

Add instrumentation for amazon SQS

d5b03be

stuartnelson3 requested a review from a team April 14, 2021 09:08

github-actions bot added the agent-go label Apr 14, 2021

update documentation

e13ea24

stuartnelson3 mentioned this pull request Apr 14, 2021

Add Ignore Message Queue Configuration for AWS SQS #934

Open

stuartnelson3 added 2 commits April 14, 2021 11:18

go-lint

5b1003e

simplify test case for ignored method

2e82f93

stuartnelson3 marked this pull request as ready for review April 14, 2021 09:26

axw reviewed Apr 14, 2021

View reviewed changes

module/apmawssdkgo/sqs.go Show resolved Hide resolved

stuartnelson3 added 2 commits April 14, 2021 11:51

add TODO

c59aa3c

add trace context to message attributes

24984a7

Add the trace context header to the message attribute metadata when creating messages.

axw requested changes Apr 15, 2021

View reviewed changes

module/apmawssdkgo/session.go Show resolved Hide resolved

module/apmawssdkgo/sqs.go Outdated Show resolved Hide resolved

module/apmawssdkgo/sqs.go Outdated Show resolved Hide resolved

module/apmawssdkgo/sqs_test.go Outdated Show resolved Hide resolved

add additional tracing info to message attributes

0de1b64

stuartnelson3 commented Apr 15, 2021

View reviewed changes

axw approved these changes Apr 15, 2021

View reviewed changes

stuartnelson3 merged commit 95c2457 into elastic:master Apr 15, 2021

stuartnelson3 deleted the aws-sqs branch April 15, 2021 12:51

stuartnelson3 added a commit that referenced this pull request Jul 30, 2021

Instrument RPC calls to amazon SQS (#933)

88b8829

Add support for tracing AWS SQS RPCs when using a wrapped `*session.Session` struct

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Instrument RPC calls to amazon SQS#933

Instrument RPC calls to amazon SQS#933
stuartnelson3 merged 7 commits intoelastic:masterfrom
stuartnelson3:aws-sqs

stuartnelson3 commented Apr 14, 2021 •

edited

Loading

Uh oh!

ghost commented Apr 14, 2021 •

edited by ghost

Loading

Build stats

Test stats 🧪

Trends 🧪

Uh oh!

axw left a comment

Uh oh!

Uh oh!

stuartnelson3 commented Apr 14, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartnelson3 Apr 15, 2021

Uh oh!

axw Apr 15, 2021

Uh oh!

axw left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

stuartnelson3 commented Apr 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Apr 14, 2021 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Build stats

Test stats 🧪

Trends 🧪

Uh oh!

axw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stuartnelson3 commented Apr 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartnelson3 Apr 15, 2021

Choose a reason for hiding this comment

Uh oh!

axw Apr 15, 2021

Choose a reason for hiding this comment

Uh oh!

axw left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stuartnelson3 commented Apr 14, 2021 •

edited

Loading

ghost commented Apr 14, 2021 •

edited by ghost

Loading

stuartnelson3 commented Apr 14, 2021 •

edited

Loading