Creates a log viewer #89
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi Template Application open-source project | ||
| // | ||
| // SPDX-FileCopyrightText: 2024 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import OSLog | ||
| import SwiftUI | ||
|
|
||
|
|
||
| enum LogLevel: String, CaseIterable, Identifiable { | ||
| case all = "All" | ||
| case info = "Info" | ||
| case debug = "Debug" | ||
| case error = "Error" | ||
| case fault = "Fault" | ||
| case notice = "Notice" | ||
| case undefined = "Undefined" | ||
|
|
||
| var id: String { self.rawValue } | ||
|
|
||
| var osLogLevel: OSLogEntryLog.Level? { | ||
| switch self { | ||
| case .all: | ||
| return nil | ||
| case .info: | ||
| return .info | ||
| case .debug: | ||
| return .debug | ||
| case .error: | ||
| return .error | ||
| case .fault: | ||
| return .fault | ||
| case .notice: | ||
| return .notice | ||
| case .undefined: | ||
| return .undefined | ||
| } | ||
| } | ||
|
|
||
| var color: Color { | ||
|
There was a problem hiding this comment. I would suggest to move this extension to |
||
| switch self { | ||
| case .info: | ||
| return .blue | ||
| case .debug: | ||
| return .green | ||
| case .error: | ||
| return .red | ||
| case .fault: | ||
| return .purple | ||
| case .notice: | ||
| return .orange | ||
| case .all, .undefined: | ||
| return .gray | ||
| } | ||
| } | ||
|
|
||
| init(from osLogLevel: OSLogEntryLog.Level) { | ||
| switch osLogLevel { | ||
|
Check warning on line 61 in TemplateApplication/Logging/LogLevel.swift
|
||
| case .info: | ||
| self = .info | ||
| case .debug: | ||
| self = .debug | ||
| case .error: | ||
| self = .error | ||
| case .fault: | ||
| self = .fault | ||
| case .notice: | ||
| self = .notice | ||
| @unknown default: | ||
| self = .undefined | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi Template Application open-source project | ||
| // | ||
| // SPDX-FileCopyrightText: 2024 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import Foundation | ||
| import OSLog | ||
| import Spezi | ||
| import SwiftUI | ||
|
|
||
|
|
||
| /// Manages log entries within the application using `OSLogStore`, allowing querying | ||
| /// based on date ranges and log levels. | ||
| class LogManager { | ||
| /// Reference to the `OSLogStore`, which provides access to system logs. | ||
| private let store: OSLogStore? | ||
|
|
||
| /// Initializes the `LogManager` and attempts to set up the `OSLogStore` with | ||
| /// a scope limited to the current process identifier. | ||
| /// | ||
| /// - Throws: An error if the `OSLogStore` cannot be initialized. | ||
| init() throws { | ||
| do { | ||
| self.store = try OSLogStore(scope: .currentProcessIdentifier) | ||
| } catch { | ||
| throw error | ||
| } | ||
| } | ||
|
|
||
| /// Queries logs within a specified date range and optional log level. | ||
| /// | ||
| /// - Parameters: | ||
| /// - startDate: The start date from which logs should be queried. | ||
| /// - endDate: An optional end date up to which logs should be queried. | ||
| /// - logLevel: An optional log level filter, returning only entries of this level if specified. | ||
| /// - Returns: An array of `OSLogEntryLog` entries that match the specified criteria. | ||
| /// - Throws: `LogManagerError.invalidLogStore` if `OSLogStore` is unavailable, or | ||
| /// `LogManagerError.invalidBundleIdentifier` if the bundle identifier cannot be retrieved. | ||
| func query( | ||
| startDate: Date, | ||
| endDate: Date? = nil, | ||
| logLevel: OSLogEntryLog.Level? = nil | ||
| ) throws -> [OSLogEntryLog] { | ||
|
There was a problem hiding this comment. I tested the views in the application and I could not see any log messages emitted by, e.g., a default logger in the view: Logger().log(level: .error, "Test Log Message ...")Not sure if this is just for me but it would be good to test the basic behavior in a UI/unit test within the template application to ensure that the basic query functionality is working as expected. |
||
| guard let store else { | ||
| throw LogManagerError.invalidLogStore | ||
| } | ||
|
|
||
| guard let bundleIdentifier = Bundle.main.bundleIdentifier else { | ||
| throw LogManagerError.invalidBundleIdentifier | ||
| } | ||
|
|
||
| let position = store.position(date: startDate) | ||
| let predicate = NSPredicate(format: "subsystem == %@", bundleIdentifier) | ||
| let logs = try store.getEntries(at: position, matching: predicate) | ||
| .reversed() | ||
|
Comment on lines
+56
to
+57
There was a problem hiding this comment. Instead of reversing the list we can pass this as an argument to |
||
| .compactMap { $0 as? OSLogEntryLog } | ||
|
|
||
| return logs | ||
| .filter { logEntry in | ||
| /// Filter by log type if specified | ||
| if let logLevel, logEntry.level != logLevel { | ||
| return false | ||
| } | ||
|
Comment on lines
+63
to
+65
There was a problem hiding this comment. You might even be able to optimize this query by moving this into the predicate; given the configuration options documented in I could imagine that the predicate String creation of the |
||
|
|
||
| /// Filter by end date if specified | ||
| if let endDate, logEntry.date > endDate { | ||
| return false | ||
| } | ||
|
|
||
| return true | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi Template Application open-source project | ||
| // | ||
| // SPDX-FileCopyrightText: 2024 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| enum LogManagerError: Error { | ||
| /// Throw when the log store is invalid | ||
| case invalidLogStore | ||
| /// Throw when the bundle identifier is invalid | ||
| case invalidBundleIdentifier | ||
| } | ||
|
|
||
| extension LogManagerError: CustomStringConvertible { | ||
| public var description: String { | ||
| switch self { | ||
| case .invalidLogStore: | ||
| return "The OSLogStore is invalid." | ||
| case .invalidBundleIdentifier: | ||
| return "The bundle identifier is invalid." | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest to explore using OptionSet to model this here. It would be easily used to configure the selection instead of duplicating all the
OSLogEntryLog.Levels. Alternatively it could be morphed into aLogLevelSelection(which describes this a bit better); and use an enum with an associated type with anOSLogEntryLog.Level.