DiagnosticChannel
Defined in: packages/client/src/lib/diagnostic-channel.ts:36
Per-client observation seam shared by optional library integrations.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DiagnosticChannel(
sessionId):DiagnosticChannel
Defined in: packages/client/src/lib/diagnostic-channel.ts:47
Creates an isolated stream for one application session.
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”Returns
Section titled “Returns”DiagnosticChannel
Accessors
Section titled “Accessors”diagnosticsObserved
Section titled “diagnosticsObserved”Get Signature
Section titled “Get Signature”get diagnosticsObserved():
boolean
Defined in: packages/client/src/lib/diagnostic-channel.ts:60
Whether a consumer holds full diagnostics, including optional remote and capture sources.
Returns
Section titled “Returns”boolean
locallyObserved
Section titled “locallyObserved”Get Signature
Section titled “Get Signature”get locallyObserved():
boolean
Defined in: packages/client/src/lib/diagnostic-channel.ts:55
Whether local producer work has a metadata or full diagnostic consumer.
Returns
Section titled “Returns”boolean
observed
Section titled “observed”Get Signature
Section titled “Get Signature”get observed():
boolean
Defined in: packages/client/src/lib/diagnostic-channel.ts:50
Whether a full diagnostic consumer is attached.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”addDiagnosticSource()
Section titled “addDiagnosticSource()”addDiagnosticSource(
start): () =>void
Defined in: packages/client/src/lib/diagnostic-channel.ts:110
Registers remote or content observation work available only to full diagnostic consumers.
Parameters
Section titled “Parameters”() => () => void
Returns
Section titled “Returns”() => void
addLocalSource()
Section titled “addLocalSource()”addLocalSource(
start): () =>void
Defined in: packages/client/src/lib/diagnostic-channel.ts:105
Registers local metadata producer work, started for metadata or full diagnostic consumers.
Parameters
Section titled “Parameters”() => () => void
Returns
Section titled “Returns”() => void
addSource()
Section titled “addSource()”addSource(
start): () =>void
Defined in: packages/client/src/lib/diagnostic-channel.ts:100
Registers full diagnostic observation work.
Parameters
Section titled “Parameters”() => () => void
Returns
Section titled “Returns”() => void
dispose()
Section titled “dispose()”dispose():
void
Defined in: packages/client/src/lib/diagnostic-channel.ts:184
Releases observers and optional sources.
Returns
Section titled “Returns”void
emit()
Section titled “emit()”emit<
Kind>(kind, …args):void
Defined in: packages/client/src/lib/diagnostic-channel.ts:129
Emits an isolated observation. Observer failures never change application behavior.
Type Parameters
Section titled “Type Parameters”Kind extends string
Parameters
Section titled “Parameters”Kind
…[...ObservationArguments<NoInfer<Kind>>[], () => unknown, string]
Returns
Section titled “Returns”void
emitDiagnostic()
Section titled “emitDiagnostic()”emitDiagnostic(
kind,metadata?,readContent?,requestId?):void
Defined in: packages/client/src/lib/diagnostic-channel.ts:153
Emits diagnostic-only evidence without notifying operational metadata observers.
Parameters
Section titled “Parameters”string
metadata?
Section titled “metadata?”DiagnosticMetadata = {}
readContent?
Section titled “readContent?”() => unknown
requestId?
Section titled “requestId?”string
Returns
Section titled “Returns”void
observeControls()
Section titled “observeControls()”observeControls(
listener): () =>void
Defined in: packages/client/src/lib/diagnostic-channel.ts:76
Replays current controls and observes changes without keeping collection sources alive.
Parameters
Section titled “Parameters”listener
Section titled “listener”(event) => void
Returns
Section titled “Returns”() => void
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Defined in: packages/client/src/lib/diagnostic-channel.ts:87
Observes events; unsubscribe releases optional sources after the last observer.
Parameters
Section titled “Parameters”listener
Section titled “listener”(observation) => void
Returns
Section titled “Returns”() => void
subscribeMetadata()
Section titled “subscribeMetadata()”subscribeMetadata(
listener): () =>void
Defined in: packages/client/src/lib/diagnostic-channel.ts:65
Observes local producer metadata; forwarded and diagnostic-only evidence is excluded.
Parameters
Section titled “Parameters”listener
Section titled “listener”TelemetryMetadataObserver
Returns
Section titled “Returns”() => void