CXoneGuideUtility

Overview

CXoneGuideUtility is a robust logging framework designed for iOS applications, providing flexible and powerful logging capabilities through a clean, type-safe interface.

Requirements

• iOS 15.0+
• Swift 5+

## Modules

• Utility
• Core
• UI
• Sample

Core Architecture

1. LogWriter Protocol

The foundation of the logging system that defines the basic logging behavior:

public protocol LogWriter {
    func log(record: LogRecord)
}

2. Core Writers

PrintLogWriter

Console output logging:

let writer = PrintLogWriter()

FileLogWriter

File-based logging:

let writer = FileLogWriter(path: fileURL)

SystemLogWriter

System logging using os.Logger:

let writer = SystemLogWriter()

ForkLogWriter

Multi-destination logging:

let writer = ForkLogWriter(
    FileLogWriter(path: fileURL),
    PrintLogWriter()
)

3. Configuration Options

Filters

Control log output:

// Level-based filtering
logWriter.filter(minLevel: .warning)

// Category-based filtering
logWriter.filter(categories: "NETWORK")

Formatters

Control log appearance:

logWriter.format(.simple)
logWriter.format(.full)

Implementation Guide

Basic Setup

enum Log: StaticLogger {
    nonisolated(unsafe) static var instance: LogWriter = PrintLogWriter()
    static let category: String? = "Application"
}

Advanced Configuration

Log.configure(
    format: .full,
    isPrintEnabled: true,
    isWriteToFileEnabled: true,
    isCrashlyticsEnabled: true,
    isSystemEnabled: true
)

Usage Examples

Basic Logging

Log.trace("Debug message")
Log.warning("Warning message")
Log.error("Error message")

Category-based Logging

Log.log("Network request started", category: "NETWORK")

Multi-destination Logging

Log.instance = ForkLogWriter(
    FileLogWriter(path: fileURL).format(.full),
    PrintLogWriter().format(.simple)
).filter(minLevel: .warning)

File Management

Log Sharing

let shareDialog = try Log.getLogShareDialog()

Log Cleanup

try Log.removeLogs()

Integration Support

SDK Integration

The logger automatically integrates with:

• CXoneChat
• CXoneChatUI

Best Practices

• Configure appropriate log levels for different environments
• Use categories for better log organization
• Implement proper error handling
• Regular log file maintenance