API Docs for:
Show:

profiling Class

Module: profiling

Provides the profiling functionalities.

Methods

getCtiPackageRelease

(
  • cb
)

Returns the release number of the software packages.

Parameters:

  • cb Function

    The callback function

getNodeVersion

() String

Returns the node version.

Returns:

String:

The node version.

getProcessPid

() Number

Returns the process PID.

Returns:

Number:

The process PID.

getProcMem

() Object

Returns the memory quantity used by the process, in particular:

  • resident set size (rss): the portion of the process's memory held in RAM
  • total heap size
  • used heap size

Returns:

Object:

The quantity of the memory used by the process: "rss", "heapTotal", "heapUsed" (in byte).

getTcpNumConnectedClients

() Number

Returns the number of connected clientsi by tcp.

Returns:

Number:

the total number of connected clients by tcp.

getWsNumConnectedClients

() Number

Returns the number of connected clients by websocket.

Returns:

Number:

the total number of connected clients by websocket

setCompComNethctiTcp

(
  • comp
)

Sets the communication tcp component to be used.

Parameters:

  • comp Object

    The module to be set

setCompComNethctiWs

(
  • comp
)

Sets the communication websocket component to be used.

Parameters:

  • comp Object

    The module to be set

setLogger

(
  • log
)
static

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

Properties

compComNethctiTcp

Object private

The communication tcp component.

compComNethctiWs

Object private

The communication websocket component.

IDLOG

String private final

The module identifier used by the logger.

Default: [profiling]

logger

Object private

The logger. It must have at least three methods: info, warn and error.

Default: console