Associate a workflow run with a user (or other context) in telemetry without passing it to every step

オープン
#5,264 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
42/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript

調査の方向性

Read the related issues #1933, #132, and #3456, then trace how run attributes, invocation baggage, and runContext move through start(), step dispatch, and child runs. The issue offers multiple possible designs, so first determine which approach fits the existing runtime and telemetry APIs. Done means run context is available synchronously to spans across queued steps and child runs without adding user IDs to outgoing HTTP baggage headers.

索引モデルが issue の本文から書いたものです。

説明

Problem

We want every span a run produces to carry who it's for, such as user.id or a tenant ID. Most telemetry backends attribute data per span, so the value has to be available synchronously wherever a span starts, which includes every step. Today the only way is to pass it as an argument to every step, which is tedious and easy to get wrong, because nested steps that don't receive it lose attribution silently.

Nothing in the SDK carries it for us:

  • Attributes are write-only inside a run. start({ attributes }) works, but there's no read API. getWorkflowMetadata() doesn't include them.
  • Queued steps don't load the run. Since #3456, the dispatch message's runContext doesn't carry attributes.
  • Baggage is replaced. withWorkflowBaggage replaces any application baggage with just workflow.run_id and workflow.name.
  • Linked mode restores nothing from start(). The start() context is only a span link.
  • Child runs don't inherit attributes. They get only $parentRunId and $rootRunId.
  • Our workaround: a span processor stamps workflow.run_id from the baggage onto spans, and an exporter wrapper calls world.runs.get() (cached, following $rootRunId for child runs) to add the user at export time. It costs a network call per run per instance and only works for exporters we wrap.

Proposal (either one)

A. Read a run's own attributes synchronously in steps, as #1933 already plans:

const { attributes } = getWorkflowMetadata();

Carry them on the step dispatch runContext next to rootRunId so queued steps still don't fetch the run. They're bounded at 64 × 256 bytes.

B. Propagated telemetry context, settable at start() or from "use workflow" / "use step":

await start(wf, args, { telemetry: { baggage: { "user.id": userId } } });
await setTelemetryBaggage({ "user.id": userId }); // recorded in the event log, like setAttributes

The runtime would merge these into the invocation baggage instead of replacing it, carry them on dispatch messages, and pass them to child runs. It should keep them off outgoing HTTP baggage headers so user IDs don't leak to third parties.

Both could also share one mechanism: attributes marked for propagation (start(wf, args, { attributes, propagateAttributes: ["userId"] })).

Related: #1933, #132, #3456. Versions: workflow 5.2.0, @vercel/otel, default linked trace mode.

主要言語
TypeScript
スター
2.5k
フォーク
401
平均マージ
1日 21時間
マージ済み PR(30日)
201

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

vercel/workflow のほかの issue

vercel/workflow の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。