Associate a workflow run with a user (or other context) in telemetry without passing it to every step
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 42/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- typescript
- Lĩnh vực
- backend-api-design, observability
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- TypeScript
- Star
- 2.5k
- Fork
- 401
- Merge trung bình
- 1 ngày 21 giờ
- Pull request đã merge (30 ngày)
- 201
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Không có hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của vercel/workflow
-
getPortLazy re-runs OS port discovery on every call when it finds no portCó thể đã có người làm Có pull request liên kết đang mở hoặc đã được merge. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 1 ngày
-
node-module-esbuild-plugin: getImportedIdentifier only checks the first named import when locating a violationCó thể đã có người làm @div-cowboy đã nhận 6 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
vercel/workflow#5057 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
Maintainer thường phản hồi trong vòng 1 ngày
-
code-transform.mdx §ID Generation omits the package-shipped `name@version` ID formCó thể đã có người làm @Mohith26 đã nhận 113 ngày trước. Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của vercel/workflow
Issue tương tự
-
type: bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 67/100
db-ux-design-system/core-web#8856 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
'!' breaking change is lost when the commit also has an empty BREAKING CHANGE footerCó thể đã có người làm @wittdennis đã nhận hôm nay. Đang mởpriority: p3 type: bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
googleapis/release-please#2971 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 87/100
Maintainer thường phản hồi trong vòng 1 ngày
-
🛠️ dette technique
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 61/100
betagouv/mon-entreprise#4752 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 5 ngày