README.md

Globals / "index"

Module: "index"

Index

Interfaces

• ProcessCommonOptions
• ProcessCpuUsageOptions
• ProcessEventLoopDelayOptions
• ProcessEventLoopUtilizationOptions
• ProcessGcDurationOptions
• ProcessHeapSpaceOptions
• ProcessMemoryUsageOptions
• ProcessOptions
• ProcessStartTimeOptions
• ProcessUptimeOptions
• ProcessVersionOptions

Variables

• isEventLoopDelaySupported
• isEventLoopUtilizationSupported

Functions

• cpuUsage
• eventLoopDelay
• eventLoopUtilization
• gcDuration
• heapSpace
• memoryUsage
• metrics
• startTime
• uptime
• version

Variables

isEventLoopDelaySupported

• Const isEventLoopDelaySupported: boolean = Boolean(monitorEventLoopDelay)

Defined in src/event-loop-delay.ts:10

---

isEventLoopUtilizationSupported

• Const isEventLoopUtilizationSupported: boolean = Boolean(performance.eventLoopUtilization)

Defined in src/event-loop-utilization.ts:7

Functions

cpuUsage

▸ cpuUsage(telemetry: Telemetry, __namedParameters: { description: string = "process CPU time spent in seconds (batch observer)"; labels: undefined | { [key:string]: string; } ; name: string = "cpu"; prefix: string = "process" }, done: () => void): void

Defined in src/cpu-usage.ts:6

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "process CPU time spent in seconds (batch observer)"; labels: undefined | { [key:string]: string; } ; name: string = "cpu"; prefix: string = "process" }
done	() => void

Returns: void

---

eventLoopDelay

▸ eventLoopDelay(telemetry: Telemetry, __namedParameters: { description: string = "Approximate mean event loop delay in seconds."; labels: undefined | { [key:string]: string; } ; name: string = "event_loop_delay"; percentiles: number[] = [50, 75, 90, 95, 99]; prefix: string = "process"; resolution: number = 10 }, done: () => void): void

Defined in src/event-loop-delay.ts:12

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "Approximate mean event loop delay in seconds."; labels: undefined | { [key:string]: string; } ; name: string = "event_loop_delay"; percentiles: number[] = [50, 75, 90, 95, 99]; prefix: string = "process"; resolution: number = 10 }
done	() => void

Returns: void

---

eventLoopUtilization

▸ eventLoopUtilization(telemetry: Telemetry, __namedParameters: { description: string = `ELU is similar to CPU utilization, except that it only measures event loop statistics and not CPU usage. It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait).`; labels: undefined | { [key:string]: string; } ; name: string = "event_loop_utilization"; prefix: string = "process" }, done: () => void): void

Defined in src/event-loop-utilization.ts:9

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = `ELU is similar to CPU utilization, except that it only measures event loop statistics and not CPU usage. It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait).`; labels: undefined | { [key:string]: string; } ; name: string = "event_loop_utilization"; prefix: string = "process" }
done	() => void

Returns: void

---

gcDuration

▸ gcDuration(telemetry: Telemetry, __namedParameters: { description: string = "Garbage collection duration by kind, one of major, minor, incremental or weakcb."; labels: undefined | { [key:string]: string; } ; name: string = "gc_duration_seconds"; prefix: string = "process"; boundaries: { count: number = 15; start: number = 0.0001 } }, done: () => void): void

Defined in src/gc.ts:17

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "Garbage collection duration by kind, one of major, minor, incremental or weakcb."; labels: undefined | { [key:string]: string; } ; name: string = "gc_duration_seconds"; prefix: string = "process"; boundaries: { count: number = 15; start: number = 0.0001 } }
done	() => void

Returns: void

---

heapSpace

▸ heapSpace(telemetry: Telemetry, __namedParameters: { description: string = "Statistics about the V8 heap spaces (batch observer)"; labels: undefined | { [key:string]: string; } ; name: string = "heap_space_size"; prefix: string = "process" }, done: () => void): void

Defined in src/heap-space.ts:7

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "Statistics about the V8 heap spaces (batch observer)"; labels: undefined | { [key:string]: string; } ; name: string = "heap_space_size"; prefix: string = "process" }
done	() => void

Returns: void

---

memoryUsage

▸ memoryUsage(telemetry: Telemetry, __namedParameters: { description: string = "Memory usage of the Node.js process (batch observer)"; labels: undefined | { [key:string]: string; } ; name: string = ""; prefix: string = "process" }, done: () => void): void

Defined in src/memory-usage.ts:5

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "Memory usage of the Node.js process (batch observer)"; labels: undefined | { [key:string]: string; } ; name: string = ""; prefix: string = "process" }
done	() => void

Returns: void

---

metrics

▸ metrics(telemetry: Telemetry, __namedParameters: { cpu: false | true | ProcessCpuUsageOptions = true; eventLoopDelay: false | true | ProcessEventLoopDelayOptions = isEventLoopDelaySupported; eventLoopUtilization: false | true | ProcessEventLoopUtilizationOptions = isEventLoopUtilizationSupported; gc: false | true | ProcessGcDurationOptions = true; heapSpace: false | true | ProcessHeapSpaceOptions = true; labels: undefined | { [key:string]: string; } ; memory: false | true | ProcessMemoryUsageOptions = true; name: string = "process"; prefix: string = ""; startTime: false | true | ProcessStartTimeOptions = true; uptime: false | true | ProcessUptimeOptions = true; version: false | true | ProcessVersionOptions = true }, done: () => void): void

Defined in src/process.ts:21

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ cpu: false | true | ProcessCpuUsageOptions = true; eventLoopDelay: false | true | ProcessEventLoopDelayOptions = isEventLoopDelaySupported; eventLoopUtilization: false | true | ProcessEventLoopUtilizationOptions = isEventLoopUtilizationSupported; gc: false | true | ProcessGcDurationOptions = true; heapSpace: false | true | ProcessHeapSpaceOptions = true; labels: undefined | { [key:string]: string; } ; memory: false | true | ProcessMemoryUsageOptions = true; name: string = "process"; prefix: string = ""; startTime: false | true | ProcessStartTimeOptions = true; uptime: false | true | ProcessUptimeOptions = true; version: false | true | ProcessVersionOptions = true }
done	() => void

Returns: void

---

startTime

▸ startTime(telemetry: Telemetry, __namedParameters: { description: string = "Start time of the process since unix epoch in seconds."; labels: undefined | { [key:string]: string; } ; name: string = "start_time_seconds"; prefix: string = "process" }, done: () => void): void

Defined in src/start-time.ts:8

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "Start time of the process since unix epoch in seconds."; labels: undefined | { [key:string]: string; } ; name: string = "start_time_seconds"; prefix: string = "process" }
done	() => void

Returns: void

---

uptime

▸ uptime(telemetry: Telemetry, __namedParameters: { description: string = "The number of seconds the current Node.js process has been running."; labels: undefined | { [key:string]: string; } ; name: string = "uptime_seconds"; prefix: string = "process" }, done: () => void): void

Defined in src/uptime.ts:5

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "The number of seconds the current Node.js process has been running."; labels: undefined | { [key:string]: string; } ; name: string = "uptime_seconds"; prefix: string = "process" }
done	() => void

Returns: void

---

version

▸ version(telemetry: Telemetry, __namedParameters: { description: string = "Node.js version info."; labels: undefined | { [key:string]: string; } ; name: string = "version_info"; prefix: string = "process" }, done: () => void): void

Defined in src/version.ts:5

Parameters:

Name	Type
telemetry	Telemetry
__namedParameters	{ description: string = "Node.js version info."; labels: undefined | { [key:string]: string; } ; name: string = "version_info"; prefix: string = "process" }
done	() => void

Returns: void