Class TelemetryServiceImpl`Experimental`

Implements

Index

Constructors

constructor

new TelemetryServiceImpl(): TelemetryServiceImpl
Returns TelemetryServiceImpl

Properties

`Protected` `Readonly`consentProvider

consentProvider: TelemetryConsentProvider

`Protected`filters

filters: undefined | ReadonlyMap<string, readonly string[]>

`Protected` `Readonly`logger

logger: ILogger

`Protected`pendingEvents

pendingEvents: TelemetryEvent<Record<string, TelemetryValue>>[] = []

`Protected`pendingQueueOverflowWarned

pendingQueueOverflowWarned: boolean = false

`Protected` `Readonly`preferences

preferences: TelemetryPreferences

`Protected`readinessState

readinessState: "pending" | "ready" | "failed" = 'pending'

`Protected` `Readonly`sinkProvider

sinkProvider: ContributionProvider<TelemetrySink>

`Protected`sinks

sinks: undefined | readonly ValidatedTelemetrySink[]

Methods

`Protected`dispatch

dispatch(event: unknown, rpcOrigin?: boolean): void
Parameters
- event: unknown
- rpcOrigin: boolean = false
Returns void
- Defined in node/telemetry-service-impl.ts:110

`Protected`doDispatch

doDispatch(event: TelemetryEvent): void
Parameters
- event: TelemetryEvent
Returns void
- Defined in node/telemetry-service-impl.ts:130

`Protected`getFilters

getFilters(): ReadonlyMap<string, readonly string[]>
Returns ReadonlyMap<string, readonly string[]>
- Defined in node/telemetry-service-impl.ts:187

getLocalSinkInterests

getLocalSinkInterests(): Promise<string[]>
Experimental
Returns Promise<string[]>
Implementation of TelemetryRpc.getLocalSinkInterests
- Defined in node/telemetry-service-impl.ts:94

`Protected`getSinks

getSinks(): readonly ValidatedTelemetrySink[]
Returns readonly ValidatedTelemetrySink[]
- Defined in node/telemetry-service-impl.ts:150

`Protected`init

init(): void
Returns void
- Defined in node/telemetry-service-impl.ts:61

`Protected`logSinkFailure

logSinkFailure(sinkId: string, topic: string): void
Parameters
- sinkId: string
- topic: string
Returns void
- Defined in node/telemetry-service-impl.ts:211

notifyEvent

notifyEvent(event: unknown): void
Experimental
Parameters
- event: unknown
Returns void
Implementation of TelemetryRpc.notifyEvent
- Defined in node/telemetry-service-impl.ts:90

onStop

onStop(): Promise<void>
Called when the backend application shuts down.

When shutdown is initiated via SIGINT/SIGTERM, contributions are dispatched in parallel and any returned promise is awaited up to SHUTDOWN_TIMEOUT_MS milliseconds while injected services from the root container are still resolvable.

On synchronous-exit fallback paths (uncaught exceptions, server bind failures, or normal process exit), the hook is invoked synchronously and any returned promise is discarded. Implementations should be resilient to either path.

Contributions must be independent of one another during stop because they are dispatched in parallel.

Returns Promise<void>
Implementation of BackendApplicationContribution.onStop
- Defined in node/telemetry-service-impl.ts:100

report

report<T extends object>(
    topic: string,
    data?: TelemetryData<T>,
    options?: TelemetryReportOptions,
): void
Experimental
Type Parameters
- T extends object
Parameters
- topic: string
- Optionaldata: TelemetryData<T>
- Optionaloptions: TelemetryReportOptions
Returns void
Implementation of TelemetryService.report
- Defined in node/telemetry-service-impl.ts:86