mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
c36a854e7a
OSLog only allows the creation of 4000 logger objects, which means that logging will crash on the 4000th request to sourcekit-lsp (which would create the 4000th os_log object because it is the 4000th distinct category in which we are logging). To circumvent this problem, only use the last two digits of the request and notification ID for the logging scope and wrap around afterwards. This should still allow us to tell apart log messages from concurrently handled requests/notifications while only using 200 os_log objects, which means we stay well clear of the 4000 limit. rdar://119221355
55 lines
1.9 KiB
Swift
55 lines
1.9 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import Foundation
|
|
|
|
public final class LoggingScope {
|
|
/// The name of the current logging scope or `nil` if no logging scope is set.
|
|
@TaskLocal fileprivate static var _scope: String?
|
|
|
|
/// The name of the current logging scope.
|
|
public static var scope: String {
|
|
return _scope ?? "default"
|
|
}
|
|
}
|
|
|
|
/// Create a new logging scope, which will be used as the category in any log messages created from the operation.
|
|
///
|
|
/// This overrides the current logging scope.
|
|
///
|
|
/// - Note: Since this stores the logging scope in a task-local value, it only
|
|
/// works when run inside a task. Outside a task, this is a no-op.
|
|
/// - Warning: Be very careful with the dynamic creation of logging scopes. The logging scope is used as the os_log
|
|
/// category, os_log only supports 4000 different loggers and thus at most 4000 different scopes must be used.
|
|
public func withLoggingScope<Result>(
|
|
_ scope: String,
|
|
_ operation: () throws -> Result
|
|
) rethrows -> Result {
|
|
return try LoggingScope.$_scope.withValue(
|
|
scope,
|
|
operation: operation
|
|
)
|
|
}
|
|
|
|
/// Same as `withLoggingScope` but allows the operation to be `async`.
|
|
///
|
|
/// - SeeAlso: ``withLoggingScope(_:_:)-6qtga``
|
|
public func withLoggingScope<Result>(
|
|
_ scope: String,
|
|
_ operation: () async throws -> Result
|
|
) async rethrows -> Result {
|
|
return try await LoggingScope.$_scope.withValue(
|
|
scope,
|
|
operation: operation
|
|
)
|
|
}
|