Oslog logger defaults
Skill wei18/apple-dev-skills/apple-dev-skills/skills/oslog-logger-defaults
Default logging stack for Apple-platform Swift Apps — Apple's built-in `os.Logger` (no third-party), subsystem = bundle ID, category = module name, all string interpolation defaults to `.private` with explicit `.public` opt-in. Invoke when starting a new project, choosing a logging library, writing the first Logger declaration, deciding privacy interpolation, or when asked "OSLog vs SwiftLog vs CocoaLumberjack, which one".From its SKILL.md
npx -y skills add wei18/apple-dev-skills --skill oslog-logger-defaultsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 18 stars18 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
3.6 KB, 742 tokens by cl100k_base, as published. Nobody here has run it
OSLog / os.Logger Defaults
When to invoke
- Starting a new Apple-platform project and picking a logging library.
- Writing the first
Loggerdeclaration. - Deciding the default for privacy interpolation.
- User asks "OSLog vs SwiftLog vs Sentry / CocoaLumberjack", "
.privatevs.publichow to pick".
Default decisions
- Use Apple's built-in
os.Logger(import os); do not pull in any third-party logging library. - Naming conventions:
subsystem= bundle ID (e.g.com.example.myapp)category= module name (aligned with the SwiftPM target name)
- Privacy defaults to
.private: all string interpolation is treated as private;.publicmust be marked explicitly.
import os
extension Logger {
static let engine = Logger(subsystem: "com.example.myapp", category: "Engine")
}
Logger.engine.info("user \(userId, privacy: .public) loaded puzzle \(puzzleId)")
// ^^^^^^^ explicit public; puzzleId defaults to private
Rationale
- Native integration with Console.app / Instruments / the unified logging system; zero dependencies.
- Friendly to Swift 6 actor / Sendable.
- Native privacy interpolation;
.privatecontent is automatically redacted in cross-device sysdiagnose. - No third-party SDK pulled in → no extra entries in
PrivacyInfo.xcprivacy, consistent with the "no third-party tracking" stance.
What .private actually means (easily misunderstood)
.privatecontent is redacted wherever no debugger is attached — this includes a TestFlight user viewing their own Console.app, not only "in someone else's sysdiagnose after release."- When the local Xcode debugger is attached to a running process, private values are still visible.
OSLogStoreexception: app code can openOSLogStorefor its own process and read.privateentries without a debugger. An in-app log viewer can therefore bypass redaction entirely — never log raw PII even under.private.
Deviation considerations
- Cross-platform shared logger interface (Linux / Android target): use
swift-logas a facade with OSLog as the Apple-side backend; the interface stays platform-neutral. - Need remote log aggregation: pair with
telemetry-facade-pattern's fan-out sink rather than replacing OSLog directly. - A third-party crash reporter requires its own logger: usually avoidable; if not, keep its use scoped to that SDK.
Verification checklist
- No
import Logging/import CocoaLumberjack/import Sentryor other third-party logging. - Each module has its own
Loggerextension with a category aligned to the module name. - Every
.publicannotation can be explained as non-privacy-violating (e.g. non-PII, build hash). - PII / player IDs / tokens are always
.private(or not logged at all).
Related skills
telemetry-facade-pattern: whereOSLogSinksits within the facade.apple-three-piece-analytics: OSLog is an Apple-only path, in the same "no third-party" stance as ASC / MetricKit / GC.apple-public-repo-security:.privatecorresponds to sysdiagnose redaction, but is still visible under a debugger — the safety reasoning for the public repo relies on this semantics.
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.