Skip to content

Truncate log message in NonDarwinLogger at 10.000 characters #1186

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

Merged
merged 1 commit into from
Apr 20, 2024
Merged

Truncate log message in NonDarwinLogger at 10.000 characters #1186

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion Sources/LSPLogging/NonDarwinLogging.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,11 +299,20 @@ public struct NonDarwinLogger: Sendable {
guard level >= self.logLevel else { return }
let date = Date()
loggingQueue.async {
// Truncate log message after 10.000 characters to avoid flooding the log with huge log messages (eg. from a
// sourcekitd response). 10.000 characters was chosen because it seems to fit the result of most sourcekitd
// responses that are not generated interface or global completion results (which are a lot bigger).
var message = message().value.string(for: self.privacyLevel)
if message.utf8.count > 10_000 {
// Check for UTF-8 byte length first because that's faster since it doesn't need to count UTF-8 characters.
// Truncate using `.prefix` to avoid cutting of in the middle of a UTF-8 multi-byte character.
message = message.prefix(10_000) + "..."
}
// Start each log message with `[org.swift.sourcekit-lsp` so that it’s easy to split the log to the different messages
logHandler(
"""
[\(subsystem):\(category)] \(level) \(dateFormatter.string(from: date))
\(message().value.string(for: self.privacyLevel))
\(message)
---
"""
)
Expand Down