feat: AWS xray tracing config

[ReubenRobertsHEE]

TIS21-4226

[Judge40]

No idea how to test this at this point :)

If you run the daemon locally you can see data in the AWS console.
There's some docker compose config floating around on slack, but I'm not sure if the fully fixed config is or not.

[Judge40]

Xray daemon config is now in the handbook

[ReubenRobertsHEE]

Juicy errors now!

2023-03-28T11:12:18.370+01:00  INFO 21764 --- [nio-8210-exec-4] u.n.h.t.t.c.api.VerifyResource           : Received callback for credential verification.
2023-03-28T11:12:18.375+01:00 ERROR 21764 --- [nio-8210-exec-4] c.a.x.s.LogErrorContextMissingStrategy   : Suppressing AWS X-Ray context missing exception (SegmentNotFoundException): Failed to begin subsegment named 'completeCredentialVerification': segment cannot be found.
2023-03-28T11:12:18.394+01:00 ERROR 21764 --- [nio-8210-exec-4] c.a.x.s.LogErrorContextMissingStrategy   : Suppressing AWS X-Ray context missing exception (SegmentNotFoundException): Failed to begin subsegment named 'getTokenClaims': segment cannot be found.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

83.3% Coverage
0.0% Duplication

[ReubenRobertsHEE]

@Judge40 I am at a bit of an impasse here, wondering what you think.

The 'segment cannot be found' errors seem to suggest the servlet filter is not properly configured (as per 1st point on https://docs.aws.amazon.com/xray/latest/devguide/xray-troubleshooting.html).

The latest version of the Xray Recorder SDK still implements a javax.servlet.Filter , whereas Spring 3 works off a jakarta.servlet.Filter afaik. This is the reason for manually including "javax.servlet:javax.servlet-api:4.0.1" in the build file, but I can't get it working correctly with this import. I'm wondering how much manual re-jigging is going to be needed here (or whether we wait to see if another release of the Xray SDK solves all our problems!) Fwiw, it does seem to be a known issue as of a few months ago... https://stackoverflow.com/questions/74616492/cannot-access-javax-servlet-filter-class-file-for-javax-servlet-filter-not-found

[Judge40]

@Judge40 I am at a bit of an impasse here, wondering what you think.

The 'segment cannot be found' errors seem to suggest the servlet filter is not properly configured (as per 1st point on https://docs.aws.amazon.com/xray/latest/devguide/xray-troubleshooting.html).

The latest version of the Xray Recorder SDK still implements a javax.servlet.Filter , whereas Spring 3 works off a jakarta.servlet.Filter afaik. This is the reason for manually including "javax.servlet:javax.servlet-api:4.0.1" in the build file, but I can't get it working correctly with this import. I'm wondering how much manual re-jigging is going to be needed here (or whether we wait to see if another release of the Xray SDK solves all our problems!) Fwiw, it does seem to be a known issue as of a few months ago... https://stackoverflow.com/questions/74616492/cannot-access-javax-servlet-filter-class-file-for-javax-servlet-filter-not-found

Related issue: aws/aws-xray-sdk-java#364
Related PR: aws/aws-xray-sdk-java#372

Looks like it's fix/merged but not yet released.
Without having to duplicate a load of AWS code we might just have to wait for that release.

[ReubenRobertsHEE]

Ok cool, thanks for confirming @Judge40 .

Given we are not going 'live' by any realistic measure for the next couple of months at least, shall we just park this piece of work and pick it up when Xray catches up with us? :)

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

91.7% Coverage
0.0% Duplication