Skip to content

(bug) Trace propagation via header doesn't work #5802

Merged
BrynCooke merged 7 commits intodevfrom
bryn/remote_spans
Aug 14, 2024
Merged

(bug) Trace propagation via header doesn't work #5802
BrynCooke merged 7 commits intodevfrom
bryn/remote_spans

Conversation

@BrynCooke
Copy link
Contributor

@BrynCooke BrynCooke commented Aug 12, 2024

When propagating trace ID via header:

  exporters:
    tracing:
      propagation:
        request:
          header_name: "id_from_header"

The trace ID was not being correctly transferred to the root span of the request. This resulted in spans being incorrectly attributed to a new trace.

During propagation the trace ID was injected into a remote span with an invalid span ID.
This is then set as the context so that the subsequent root span can pick this up.
However, the root span creation logic checks that the parent span is valid, which it isn't and then created a brand new trace.

The logic is now modified to also check if the trace ID alone is valid.


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

This is covered by integration tests rather than unit tests as it requires a tracing functionality to be fully set up.
No docs updates required
Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@github-actions

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Aug 12, 2024

CI performance tests

  • const - Basic stress test that runs with a constant number of users
  • demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled
  • demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
  • enhanced-signature - Enhanced signature enabled
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • extended-reference-mode - Extended reference mode enabled
  • large-request - Stress test with a 1 MB request payload
  • no-tracing - Basic stress test, no tracing
  • reload - Reload test over a long period of time at a constant rate of users
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • step-local-metrics - Field stats that are generated from the router rather than FTV1
  • step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • xxlarge-request - Stress test with 100 MB request payload

@BrynCooke BrynCooke marked this pull request as ready for review August 12, 2024 15:35
@BrynCooke BrynCooke requested a review from a team August 12, 2024 15:35
@BrynCooke BrynCooke requested a review from a team as a code owner August 12, 2024 15:35
@BrynCooke BrynCooke requested a review from a team as a code owner August 12, 2024 15:43
@BrynCooke BrynCooke requested a review from shorgi August 12, 2024 15:43
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
@BrynCooke BrynCooke requested a review from shorgi August 12, 2024 17:44
@BrynCooke BrynCooke enabled auto-merge (squash) August 14, 2024 14:15
@BrynCooke BrynCooke merged commit 7b8d801 into dev Aug 14, 2024
@BrynCooke BrynCooke deleted the bryn/remote_spans branch August 14, 2024 14:33
Comment on lines +5 to +11
```yaml
exporters:
tracing:
propagation:
request:
header_name: "id_from_header"
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@klippx
Copy link

klippx commented Sep 16, 2024

Just for clarification, when not using propagation then it works correctly?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants