Add SQL to trace

[kevinwcyu]

Adds sql information to trace if available.

Changes

• Add SQL data to span
• Added types to the test data and updated the types to conform to the types described here https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html

Fixes: #142

Note to reviewer: we have a test app set up in our AWS dev account that generates SQL traces. You can use this trace id to see an example with SQL data 1-63d96675-436a86c00a3c0c7d1ae4230f.

[github-actions]

Backend code coverage report for PR #173
No changes

[github-actions]

Frontend code coverage report for PR #173

Plugin	Main	PR	Difference
src	87.5%	87.5%	0%

[kevinwcyu]

Trace ID of the subsegment's parent segment. Required only if sending a subsegment separately.
Subsegment fields

[idastambuk]

LGTM!

[fridgepoet]

I couldn't find the data in the AWS console, but I did see it in Grafana! Just like in your screen shot but of course in light mode XD

If you have any tips on seeing it in AWS, that would be welcome! Edit: facepalm, wrong region

[sarahzinger]

Thanks so much for this! a few random thoughts

[sarahzinger]

is this an empty string because it is a subsegment? Or is this just because it's a test and it doesn't really matter?

[kevinwcyu]

Trace ID of the subsegment's parent segment. Required only if sending a subsegment separately.
Subsegment fields

From my understanding of the docs, and from the payload we receive from X-Ray, this can be empty because the trace id is only sent if a subsegment is sent separately, otherwise this field is empty. By sent separately, it's something like this

{
  "ID": "trace-id-1",
  "Segments": [
    {
      "Document": {
        "id": "segment-id-1",
        "trace_id": "trace-id-1"
        "subsegments": [
          // a subsegment of 'segment-id-1'.
          {
            "id": "subsegment-id-1"
            // trace_id is not a part of this subsegment because it doesn't have any subsegments that are sent separately
          }
        ],
      },
    },
    {
      // this is a subsegment of segment-id-1 that is sent separately
      "Document": {
        "id": "subsegment-id-1",
        "trace_id": "trace-id-1",
      }
    }
  ]
}

[sarahzinger]

same as above here

[sarahzinger]

would it break the rendering if we said something like || 'subsegment' or something? It might be easier to understand later if we're logging or something what we're looking at maybe?

[kevinwcyu]

the spanID can be used to identify the span for logging purposes.

i wouldn't feel confident setting this to anything other than what AWS sends us. the improvement now is that it makes it explicit that the trace_id from AWS could possibly be undefined, which the type didn't reflect previously.