feat(@temporalio/interceptors-opentelemetry): implement all interceptors #1835
Conversation
chris-olszewski
force-pushed
the
olszewski/feat_implement_all_otel_interceptors
branch
from
dd68680 to
b9e320c
Compare
| /** Default trace header for opentelemetry interceptors */ | ||
| export const TRACE_HEADER = '_tracer-data'; | ||
| /** As in workflow run id */ | ||
| export const RUN_ID_ATTR_KEY = 'run_id'; |
There was a problem hiding this comment.
Ruby OTEL uses temporalRunId
There was a problem hiding this comment.
Oh? Have you compared with other SDKs, beside Ruby? We'd ideally want cross-SDKs compatibility of OTel tracing, as a customer could be operating different languages within a single Temporal application.
Not saying we'll prioritize, of course, but at the very least we should settle on what names we want to normalize to across the board, so that we eventually converge to something consistent.
There was a problem hiding this comment.
- Java:
runId - Python
temporalRunId - Go: Doesn't have these
- PHP: N/A
- .NET:
temporalRunId
There was a problem hiding this comment.
I kept run_id as I wasn't sure if moving to temporalRunId could be considered a breaking change. I could see the case that users have dashboard/queries using run_id that would break if we changed this.
There was a problem hiding this comment.
Fair. We may however consider changing these while transitioning to OTel 2. I would mind being breaking at that point.
| }); | ||
|
|
||
| // Skipped as we only care that it compiles | ||
| test.skip('otel interceptors are complete', async (t) => { |
There was a problem hiding this comment.
I built and checked at the docs and we end up leaking the Required type. Switched to a compile time check that these types satisfy the narrower type, but we only expose implementing the wider interface to users.
What was changed
Add OTEL spans for all interceptors provided by the interface.
Why?
As discovered in #1677 these can end up causing NDE errors if replaying an old history without these interceptors. Adding these all at once makes gating their usage far easier.
Checklist
Closes [Feature Request] Add missing hooks on OTel interceptors #1678
How was this tested:
Doc comments should suffice