8. Telemetry Management#

8.1. setupTelemetry#

Configures the telemetry output stream for logging and monitoring.

static void setupTelemetry(bool use_OTEL, std::ostream* os);

Parameters:

  • use_OTEL: Request OpenTelemetry integration when OpenTelemetry support is built in.

  • os: Output stream for telemetry data.

Valid values:

Parameter

Value

Description

use_OTEL

false

Use stream telemetry through os.

use_OTEL

true

Request OpenTelemetry telemetry when OpenTelemetry support is built in.

Notes:

  • Call setupTelemetry() before creating the first cuObjClient object. Current behavior applies the setting when the telemetry object is created.

  • If OpenTelemetry support is not built in, stream telemetry is used.

  • os must be non-null when stream logging is used.

  • Call shutdownTelemetry() before closing os.

  • os must remain valid until all cuObjClient objects are destroyed.

8.2. shutdownTelemetry#

Shuts down telemetry and resets the default output stream.

static void shutdownTelemetry();

Notes:

  • Call this API before closing custom output streams.

  • Telemetry is fully closed when all cuObjClient objects are destroyed.

8.3. setTelemFlags#

Configures telemetry logging flags.

static void setTelemFlags(unsigned flags);

Parameters:

  • flags: Bitmask of telemetry logging flags.

Valid values:

Flag

Value

Description

CUOBJ_LOG_PATH_INFO

0x0001

Enables informational telemetry messages.

CUOBJ_LOG_PATH_DEBUG

0x0002

Enables debug telemetry messages.

CUOBJ_LOG_PATH_ERROR

0x0004

Enables error telemetry messages.

Flags may be combined with bitwise OR. For example:

cuObjClient::setTelemFlags(CUOBJ_LOG_PATH_ERROR | CUOBJ_LOG_PATH_INFO);

Passing 0 disables info, debug, and error telemetry messages. Bits other than the valid values listed above have no defined effect.

Notes:

  • Call setTelemFlags() before creating the first cuObjClient object. Current behavior applies the flags when the telemetry object is created.

  • This API does not return a status value.