diagnostics_channel: add a channel for filesystem operations
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- javascript, node.js
- Domínio
- api, operating-systems
Direção de pesquisa
Comece pelas APIs públicas node:fs e node:fs/promises e pelas convenções existentes de TracingChannel de node:diagnostics_channel; compare os caminhos síncrono, de callback, de promise, de stream e de filehandle. Resolva a camada de publicação e os nomes dos canais, mantendo o payload independente dos detalhes de FSReqCallback. Considera-se concluído quando as operações públicas de sistema de arquivos compatíveis publicarem os eventos de ciclo de vida e os metadados documentados.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
What is the problem this feature will solve?
node:diagnostics_channel does not currently expose a built-in channel for filesystem operations performed through node:fs and node:fs/promises.
The proposed scope is the public filesystem APIs. Calls made directly by native addons or arbitrary native code do not need to be included in this contract.
What is the feature you are proposing to solve the problem?
Add a built-in tracing channel family for filesystem operations. One possible naming scheme is:
tracing:fs.operation:starttracing:fs.operation:endtracing:fs.operation:asyncStarttracing:fs.operation:asyncEndtracing:fs.operation:error
The shared event object could contain:
operation: a stable operation name such asopen,read,stat,readdir, orrealpath.api:sync,callback,promise,stream, orfilehandle.- Path, source/destination, or file descriptor fields when applicable, preserving the value type passed by the caller.
resultanderrorfollowing the existingTracingChannelconventions.
Large read/write buffers should not be copied into event metadata. The exact publication layer—public API wrappers or the lowest shared internal filesystem layer—can be determined during implementation, but the documented payload should remain independent of internal FSReqCallback details.
Using one operation family with an operation field avoids requiring wildcard channel subscriptions while allowing subscribers to filter individual operations.
What alternatives have you considered?
Wrapping exports from node:fs and node:fs/promises is incomplete when references have already been captured and requires synchronization with named built-in ESM exports. async_hooks exposes asynchronous resource lifecycles rather than stable filesystem operation semantics and does not cover synchronous calls. Trace events use a different consumption API and payload contract.
- Linguagem predominante
- JavaScript
- Estrelas
- 122k
- Forks
- 37.4k
- Merge médio
- 4d 2h
- PRs com merge (30d)
- 277
Guia de contribuição
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 nodejs/node
-
doc
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
-
build
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
-
feature request
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Todas as issues de nodejs/node
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
mksglu/context-mode#1200 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
neondatabase/website#5944 ·
-
module: core
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
bigbluebutton/bigbluebutton#25849 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
jaegertracing/jaeger-ui#4506 ·