Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

iOS public logging #408

Merged
merged 3 commits into from
Nov 15, 2024
Merged

iOS public logging #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06509d9
iOS public logging
rocketraman Nov 6, 2024
648d20f
OSLogWriter public logging by configuration
rocketraman Nov 14, 2024
aa58764
Merge branch 'main' into rg/log-public
KevinSchildhorn Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions kermit-core/src/appleMain/kotlin/co/touchlab/kermit/OSLogWriter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ package co.touchlab.kermit

import co.touchlab.kermit.darwin.*
import kotlinx.cinterop.ExperimentalForeignApi
import kotlinx.cinterop.ptr
import platform.darwin.OS_LOG_DEFAULT
import platform.darwin.OS_LOG_TYPE_DEBUG
import platform.darwin.OS_LOG_TYPE_DEFAULT
import platform.darwin.OS_LOG_TYPE_ERROR
Expand All @@ -30,9 +28,9 @@ open class OSLogWriter internal constructor(
private val darwinLogger: DarwinLogger,
) : LogWriter() {

constructor(messageStringFormatter: MessageStringFormatter = DefaultFormatter, subsystem: String = "", category: String = "") : this(
constructor(messageStringFormatter: MessageStringFormatter = DefaultFormatter, subsystem: String = "", category: String = "", publicLogging: Boolean = false) : this(
messageStringFormatter,
DarwinLoggerActual(subsystem, category),
DarwinLoggerActual(subsystem, category, publicLogging),
)

override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
Expand Down Expand Up @@ -77,9 +75,18 @@ internal interface DarwinLogger {
}

@OptIn(ExperimentalForeignApi::class)
private class DarwinLoggerActual(subsystem: String, category: String) : DarwinLogger {
private class DarwinLoggerActual(subsystem: String, category: String, publicLogging: Boolean) : DarwinLogger {
private val logger = darwin_log_create(subsystem, category)!!
// see https://developer.apple.com/documentation/os/logging/generating_log_messages_from_your_code?language=objc
// iOS considers everything coming from Kermit as a dynamic string, so without publicLogging=true, all logs are
// private
private val darwinLogFn: (osLogSeverity: os_log_type_t, message: String) -> Unit = if (publicLogging) {
{ osLogSeverity, message -> darwin_log_public_with_type(logger, osLogSeverity, message) }
} else {
{ osLogSeverity, message -> darwin_log_with_type(logger, osLogSeverity, message) }
}

override fun log(osLogSeverity: os_log_type_t, message: String) {
darwin_log_with_type(logger, osLogSeverity, message)
darwinLogFn(osLogSeverity, message)
}
}
9 changes: 9 additions & 0 deletions kermit-core/src/nativeInterop/cInterop/os_log.def
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,12 @@ darwin_os_log_t darwin_log_create(const char *subsystem, const char *category) {
void darwin_log_with_type(darwin_os_log_t log, os_log_type_t type, const char *msg) {
os_log_with_type((os_log_t)log, type, "%s", msg);
}

/**
* Uses format specifier %{public}s to make logging public.
* See https://developer.apple.com/documentation/os/logging/generating_log_messages_from_your_code?language=objc.
* We cannot pass the format specifier from Kotlin, as the API requires the value to be a string constant.
*/
void darwin_log_public_with_type(darwin_os_log_t log, os_log_type_t type, const char *msg) {
os_log_with_type((os_log_t)log, type, "%{public}s", msg);
}
Loading