fix(telemetry): improve error logging for custom trace_id generation #8149

[juancarlosjr97]

This pull request improves logging in the CustomTraceIdPropagator implementation by enhancing the error message with additional context about the trace_id and the error.

First MR #7910 closed by GitHub

Logging enhancement:

• apollo-router/src/plugins/telemetry/mod.rs: Updated the error logging statement to include the trace_id and the error details as structured fields, providing more context for debugging.

---

Checklist

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

• PR description explains the motivation for the change and relevant context for reviewing
• PR description links appropriate GitHub/Jira tickets (creating when necessary)
• Changeset is included for user-facing changes
• Changes are compatible¹
• Documentation² completed
• Performance impact assessed and acceptable
• Metrics and logs are added³ and documented
• Tests added and passing⁴
  • Unit tests
  • Integration tests
  • Manual tests, as necessary

Exceptions

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. A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices. ↩

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

[juancarlosjr97]

Thanks for the update @bnjjj. I realised it is wrong PR number, but I have updated it :)

[goto-bus-stop]

What does "format conversion options" refer to here? i'm not really familiar with this aspect of router telemetry but I don't understand what this means

[juancarlosjr97]

I was referring to this section - https://www.apollographql.com/docs/graphos/routing/observability/telemetry/trace-exporters/overview#request-configuration-reference.

The addition to the documentation is to make sure it is clear what the expectation for the trace ID

[goto-bus-stop]

Ahh perfect thank you!

[abernix]

@mergify copy dev

@juancarlosjr97 Thanks so much for opening this! Now that it looks like approval is on the horizon, we're going to move this PR over to a direct branch on the repository so the full CI run can happen, including having access to our GITHUB_TOKEN which allows us to go over the GitHub anonymous download rate-limits which aren't currently being permitted on your PR.

You will briefly see a new PR show up in the metadata here, and it will preserve your contribution credit!

[mergify]

copy dev

✅ Pull request copies have been created

Details

• #8246 fix(telemetry): improve error logging for custom trace_id generation #8149 (copy #8149) has been created for branch dev but encountered conflicts

[juancarlosjr97]

Are we happy to close this MR as the #8246 has been merged @bnjjj / @abernix?

[abernix]

Yup! thank you so much for the contribution! Closing in favor of the now merged #8246.