• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Please notify @nodejs/v8-inspector and @nodejs/trace-events before modifying this file
2version
3  major 1
4  minor 0
5
6experimental domain NodeTracing
7  type TraceConfig extends object
8    properties
9      # Controls how the trace buffer stores data.
10      optional enum recordMode
11        recordUntilFull
12        recordContinuously
13        recordAsMuchAsPossible
14      # Included category filters.
15      array of string includedCategories
16
17  # Gets supported tracing categories.
18  command getCategories
19    returns
20      # A list of supported tracing categories.
21      array of string categories
22
23  # Start trace events collection.
24  command start
25    parameters
26      TraceConfig traceConfig
27
28  # Stop trace events collection. Remaining collected events will be sent as a sequence of
29  # dataCollected events followed by tracingComplete event.
30  command stop
31
32  # Contains an bucket of collected trace events.
33  event dataCollected
34    parameters
35      array of object value
36
37  # Signals that tracing is stopped and there is no trace buffers pending flush, all data were
38  # delivered via dataCollected events.
39  event tracingComplete
40
41# Support for sending messages to Node worker Inspector instances.
42experimental domain NodeWorker
43
44  type WorkerID extends string
45
46  # Unique identifier of attached debugging session.
47  type SessionID extends string
48
49  type WorkerInfo extends object
50    properties
51      WorkerID workerId
52      string type
53      string title
54      string url
55
56  # Sends protocol message over session with given id.
57  command sendMessageToWorker
58    parameters
59      string message
60      # Identifier of the session.
61      SessionID sessionId
62
63  # Instructs the inspector to attach to running workers. Will also attach to new workers
64  # as they start
65  command enable
66    parameters
67      # Whether to new workers should be paused until the frontend sends `Runtime.runIfWaitingForDebugger`
68      # message to run them.
69      boolean waitForDebuggerOnStart
70
71  # Detaches from all running workers and disables attaching to new workers as they are started.
72  command disable
73
74  # Detached from the worker with given sessionId.
75  command detach
76    parameters
77      SessionID sessionId
78
79  # Issued when attached to a worker.
80  event attachedToWorker
81    parameters
82      # Identifier assigned to the session used to send/receive messages.
83      SessionID sessionId
84      WorkerInfo workerInfo
85      boolean waitingForDebugger
86
87  # Issued when detached from the worker.
88  event detachedFromWorker
89    parameters
90      # Detached session identifier.
91      SessionID sessionId
92
93  # Notifies about a new protocol message received from the session
94  # (session ID is provided in attachedToWorker notification).
95  event receivedMessageFromWorker
96    parameters
97      # Identifier of a session which sends a message.
98      SessionID sessionId
99      string message
100
101# Support for inspecting node process state.
102experimental domain NodeRuntime
103  # Enable the `NodeRuntime.waitingForDisconnect`.
104  command notifyWhenWaitingForDisconnect
105    parameters
106      boolean enabled
107
108  # This event is fired instead of `Runtime.executionContextDestroyed` when
109  # enabled.
110  # It is fired when the Node process finished all code execution and is
111  # waiting for all frontends to disconnect.
112  event waitingForDisconnect
113