Skip to main content

​
Logging

The SDK’s built-in logger only emits warnings and errors. You can customize this with two options on createTimeback():
​
logger
SdkLogger
Custom logger instance. Compatible with console, Pino, Winston, Bunyan, and any logger whose methods accept a string message followed by optional arguments.
​
logLevel
SdkLogLevel
default:"warn"
Minimum level for the built-in logger. Ignored when a custom logger is provided.

​
Custom logger

Pass any logger whose methods accept a string message followed by optional arguments. The SDK prefixes each message with the internal scope, for example [timeback:handlers:user]. 
import { createTimeback } from '@timeback/sdk'
import pino from 'pino'

const timeback = await createTimeback({
	logger: pino({ level: 'debug' }),
	// ...
})
When a custom logger is provided, the SDK forwards all log calls to it. Level filtering is the logger’s responsibility.

​
Log level

When using the built-in logger, logLevel controls the minimum severity: 
const timeback = await createTimeback({
	logLevel: 'debug', // 'debug' | 'info' | 'warn' | 'error' | 'silent'
	// ...
})
LevelWhat you see
debugEverything, including request details
infoOperational messages and above
warnWarnings and errors only (default)
errorErrors only
silentNothing
Set the DEBUG=1 environment variable to enable debug-level output without changing code. This takes effect when no explicit logLevel is configured.

​
Request lifecycle hooks

Track request timing and status with the onRequestStart and onRequestEnd hooks: 
const timeback = await createTimeback({
	hooks: {
		onRequestStart({ handler }) {
			console.log(`[${handler}] started`)
		},
		onRequestEnd({ handler, durationMs, status }) {
			console.log(`[${handler}] ${status} in ${durationMs}ms`)
		},
	},
	// ...
})
These fire for every SDK handler:
HandlerTrigger
activity.submitActivity completion
activity.heartbeatTime-spent heartbeat
user.meUser profile lookup
user.verifyUser session check
identity.signInSSO sign-in initiation
identity.callbackSSO callback processing