[trace_event] tracking issue

Open
#84 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
cpp, javascript, node.js

Research direction

This is a broad tracking issue for graduating Trace Events from experimental status. Start by reading the initial Trace PR and the linked issues #81, #82, and #83, then choose one unchecked item with a defined scope. Done is completing that selected task and updating its checklist status.

Written by the indexing model from the issue text.

Description

never stale triaging-requested

This issue is to track ongoing work to refine Trace Events in Node and graduate it from experimental state.

It builds on and replaces

Initial Trace PR including discussion: node#9304

todo:

  • configurable output destinations
    • support targeting lttng, etw, dtrace, etc...
  • add a listener system (#81)
  • C/C++ API (#83)
  • JavaScript API (node-eps#48)
    • needs to be as fast as possible, probably a VM intrinsic.
  • add trace points to nodejs/node (#82)
  • move existing dtrace/lttng trace writes to trace_event
  • add trace points: async hooks (PR: https://github.com/nodejs/node/pull/15538)
  • relationship to upstream trace_event_common.h (see https://github.com/nodejs/node/pull/10628)
  • recommendations for naming categories for ecosystem
  • need approach on how to collect "context"
    • e.g., for capturing http connection info, currently connection object is passed through DTrace APIs, and some handler/provider, and then the handler/provider will navigate connection object to pull out interesting data to trace. This approach is brittle (dependent on structure of connection object), and puts burden on provider (ie., won't easily allow using different event tracing systems like lttng, dtrace,...).
  • standardize on output format for trace event data
  • command-line options to support tracing features.
Dominant language
No language data
Stars
550
Forks
69
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nodejs/diagnostics

All issues in nodejs/diagnostics

Similar issues

More Observability & SRE issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.