OSLog 사용해보기

Published in

PEPPERMINT100

5 min readAug 20, 2024

서론

올해 초 F-lab에서 멘토님께 코드리뷰 받을 때 print문 대신 NSLog를 사용해보는게 어떻느냐는 제안을 받았었다. 사실 디버깅용으로 콘솔에 출력하고 현재 프로세스가 어디를 지나고 있는지 잘되고 있는지 확인하기 위해 적절한 포인트에 print문을 넣었었는데, Log를 사용하는 방향이 좋다고 한다.

다만 그 당시에 피드백 받았던 NSLog는 조금 오래된 Log API로 로그 당시의 타임 스탬프, 프로세스이름, 스레드 등을 출력해준다.

하지만 OSLog는 iOS 10 이후에 도입된 비교적 최신 로깅 API로 즉시 출력되지 않고 필요한 경우에만 시스템에 의해 처리되어 효율적이고 privacy 옵션을 사용하여 민감한 정보를 마스킹하여 보안에도 좋다.

또 로그의 구조화를 지원하여 Xcode Instrument를 레벨별로 로그를 필터링하거나 중요한 로그만을 수집하도록 하여 조금 더 용이한 분석이 가능하다.

OSLog

이러한 OSLog를 사용하려면

import OSLog

// 로그를 기록할 로거 인스턴스 생성
let logger = Logger(subsystem: "com.example.yourapp", category: "network")

logger.info("This is an info message.")
logger.debug("This is a debug message with a variable: \\(42).")
logger.error("An error occurred: \\(error.localizedDescription).")

이런식으로 사용할 수 있는데

여기서 subsystem은 앱의 번들ID를 넣어 로깅의 출처를 구분하는데 사용하고, Category는 로그의 성격을 나타내게 된다. 모듈화를 하는 경우 subsystem을 사용하여 어느 모듈에서 사용하는지 분리하고 category를 통해 이 로그가 network 성격을 가지고 있는지, ui에서 출력하는 로그인지 등을 분리할 수 있다.

Logger

이제 이 로거를 쉽게 사용할 수 있도록 클래스를 만들어보았다.

import Foundation
import OSLog

enum LogCategory: String {
    case network
    case ui
    case database
    case authentication
    case none
}

final class Logger {
    private static let subsystem = Bundle.main.bundleIdentifier ?? "your.app.bundleid"
    static func osLog(for category: LogCategory) -> OSLog {
        return OSLog(subsystem: subsystem, category: category.rawValue)
    }
    static func debug(_ message: String, category: LogCategory = .none) {
        os_log("%{public}@", log: Logger.osLog(for: category), type: .debug, message)
    }
    static func info(_ message: String, category: LogCategory = .none) {
        os_log("%{public}@", log: Logger.osLog(for: category), type: .info, message)
    }
    static func error(_ message: String, category: LogCategory = .none) {
        os_log("%{public}@", log: Logger.osLog(for: category), type: .error, message)
    }
    func fault(_ message: String, category: LogCategory = .none) {
        os_log("%{public}@", log: Logger.osLog(for: category), type: .fault, message)
    }
}