platform: option to keep request URLs, logs and exceptions out of platform and project Worker telemetry
Mantenedores costumam responder em até 1 dia
Um pull request relacionado já foi integrado.
- #683 de @Brooooooklyn — integrado
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 18/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Stack de tecnologia
- typescript
- Domínio
- backend, cloud, observability
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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)
- Platform Workers (API, proxy, dispatch and others) are always deployed with
observability: { enabled: true }: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/packages/platform/src/worker-config.ts#L82-L88 - Project Workers are always uploaded with Workers Logs and invocation logs at a 100% sampling rate, plus the platform tail consumer: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/deploy/upload-worker.ts#L490-L494
- The tail Worker writes each event's
logs,exceptionsand fullrequest.url(including the query string) into Analytics Engine: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/tail/src/index.ts#L70-L84
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,exceptionsandurl. 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 project logs endpoint: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/routes/projects.ts#L2507-L2525
- the admin deployment-log view, which reads the same columns: https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/operator/deployment-operations.ts#L270-L271 and https://github.com/voidzero-dev/void/blob/afeeff6a4d72682f6cfb6c947e9a2c29393c00a6/platform/packages/api/src/admin/fate/telemetry.ts#L34-L38
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
- 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
- an install/upgrade flag (for example
- Scope: for the URL field, would you prefer dropping it entirely or keeping the path without the query string?
- 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?
- 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.
- Linguagem predominante
- TypeScript
- Estrelas
- 627
- Forks
- 66
- Merge médio
- 14h 38min
- PRs com merge (30d)
- 179
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de voidzero-dev/void
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
voidzero-dev/void#677 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 30/100
voidzero-dev/void#689 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 52/100
voidzero-dev/void#686 ·
Mantenedores costumam responder em até 1 dia
-
`VoidActionError.message` ignores the server's message, though the docs show it to usersTalvez já em andamento Um pull request vinculado a esta issue está aberto ou já foi mesclado. Aberta
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 52/100
voidzero-dev/void#680 ·
Mantenedores costumam responder em até 1 dia
-
`withValidator({ body })` rejects the multipart bodies that `useForm` and `action()` send for filesAberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 35/100
voidzero-dev/void#679 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de voidzero-dev/void
Issues semelhantes
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
-
bug needs triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
DSpace/dspace-angular#6511 ·
Mantenedores costumam responder em até 1 dia
-
area: frontend area:byok bug severity:low
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
Mantenedores costumam responder em até 1 dia
-
Phone app shows Unknown for a remote machine whose key changedTalvez já em andamento @janicduplessis assumiu hoje. Abertaarea: mobile priority: P3 type: bug
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 78/100
appandflow/stim#5006 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Area - Local to Cloud Bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
microsoft/vscode-mssql#23209 ·
Mantenedores costumam responder em até 1 dia