platform: option to keep request URLs, logs and exceptions out of platform and project Worker telemetry

Đang mở
  • Có gì không ổn?
#667 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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
18/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, cloud, observability

Hướng nghiên cứu

The telemetry settings live in packages/platform/src/worker-config.ts (platform Worker observability), platform/packages/api/src/deploy/upload-worker.ts (project Workers logs and tail consumer), and platform/packages/tail/src/index.ts (the Analytics Engine write of logs, exceptions and URL). Read the install/upgrade manifest path before changing anything. Done means the flag shape is agreed first, then a minimal mode drops those fields while keeping outcome, status and deployment id, with tests. The open questions need a maintainer decision before coding.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Motivation

Some operators run a Void platform for apps whose request URLs, console output or exception messages can carry personal data, such as query strings with email addresses or one-time links. Their data-minimisation rules require these values to stay out of Cloudflare Workers Logs and the platform's Analytics Engine datasets. Today every platform and project Worker always records them, and an operator has no setting to turn this off.

Where it is recorded (v1.5.0)

This data stays inside the installation's own Cloudflare account. The project log endpoints are scoped per project. This is a request for a privacy setting, not a report of a leak.

Proposal (opt-in, default unchanged)

Add an installation-level setting that is stored in the deployment manifest and applied on install and upgrade. In its minimal mode it would:

  • disable Workers Logs (or only invocation logs) on platform Workers and on newly uploaded project Workers;
  • keep the tail data point, but write empty values (or a path with the query string removed) in place of logs, exceptions and url. Outcome, method, status and deployment id would still be recorded, so error rates and status filtering keep working.
Trade-off

In minimal mode, project owners and administrators would lose data in these views:

The request-metering dataset that dispatch writes does not store URLs, so usage and quotas would be unaffected. The UI should probably say "not recorded on this platform" rather than show an empty list.

Questions
  1. Flag shape: which would you prefer?
    • an install/upgrade flag (for example --telemetry full|minimal) persisted in the manifest
    • an environment variable read at deploy time
    • separate switches for Workers Logs and for the tail fields
  2. Scope: for the URL field, would you prefer dropping it entirely or keeping the path without the query string?
  3. Per project: should project owners be able to opt in to full logs on a platform that defaults to minimal, or should this stay platform-wide only?
  4. Is this something you would accept as a PR once the shape is agreed?

Prepared with Claude Code on behalf of @iPLAYCAFE-dev; reviewed by the maintainer of this account.

Ngôn ngữ chính
TypeScript
Star
627
Fork
66
Merge trung bình
14 giờ 56 phút
Pull request đã merge (30 ngày)
170

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của voidzero-dev/void

Tất cả issue của voidzero-dev/void

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.