Skip to main content

LoggingOptions

Upgather Analytics

Upgather Analytics / LoggingOptions

Interface: LoggingOptions

Configuration options for logging behavior in the analytics client.

Remarks​

Controls the verbosity and content of logs produced by the analytics client. These settings help with debugging and monitoring while keeping sensitive information protected in production environments.

Example​

import { LoggingOptions } from '@upgather/analytics';

const options: LoggingOptions = {
  level: 'detailed',
  includePayloads: true
};

Properties​

includePayloads?​

optional includePayloads: boolean

Whether to include full request/response payloads in logs.

Remarks​

When true, complete request and response bodies will be included in logs. This can be useful for debugging but may expose sensitive information. Consider disabling in production environments.

Default​

false

level​

level: "minimal" | "normal" | "detailed"

Logging verbosity level.

Remarks​

  • 'minimal': Logs only critical errors and important operations
  • 'normal': Logs all requests, responses, and errors (default)
  • 'detailed': Logs all activity including internal state changes

Default​

'normal'