f9cca9fb5d
On macOS (catalyst) URL.appGroupContainerDirectory returns: /Users/matthew/Library/Group%20Containers/group.io.element/ So you need to strip the %20 out into a space, otherwise logging fails with a permissions error. * Use path(percentEncoded:)
96 lines
4.3 KiB
Swift
96 lines
4.3 KiB
Swift
//
|
|
// Copyright 2022 New Vector Ltd
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
import Foundation
|
|
import MatrixRustSDK
|
|
|
|
struct OTLPConfiguration {
|
|
let url: String
|
|
let username: String
|
|
let password: String
|
|
}
|
|
|
|
enum RustTracing {
|
|
/// The base filename used for log files. This may be suffixed by the target
|
|
/// name and other log management metadata during rotation.
|
|
static let filePrefix = "console"
|
|
/// The directory that stores all of the log files.
|
|
static var logsDirectory: URL { .appGroupContainerDirectory }
|
|
|
|
private(set) static var currentTracingConfiguration: TracingConfiguration?
|
|
static func setup(configuration: TracingConfiguration, otlpConfiguration: OTLPConfiguration?) {
|
|
currentTracingConfiguration = configuration
|
|
|
|
// Keep a minimum of 1 week of log files. In reality it will be longer
|
|
// as the app is unlikely to be running continuously.
|
|
let maxFiles: UInt64 = 24 * 7
|
|
|
|
if let otlpConfiguration {
|
|
setupOtlpTracing(config: .init(clientName: "ElementX-iOS",
|
|
user: otlpConfiguration.username,
|
|
password: otlpConfiguration.password,
|
|
otlpEndpoint: otlpConfiguration.url,
|
|
filter: configuration.filter,
|
|
writeToStdoutOrSystem: true,
|
|
writeToFiles: .init(path: logsDirectory.path(percentEncoded: false),
|
|
filePrefix: configuration.fileName,
|
|
fileSuffix: configuration.fileExtension,
|
|
maxFiles: maxFiles)))
|
|
} else {
|
|
setupTracing(config: .init(filter: configuration.filter,
|
|
writeToStdoutOrSystem: true,
|
|
writeToFiles: .init(path: logsDirectory.path(percentEncoded: false),
|
|
filePrefix: configuration.fileName,
|
|
fileSuffix: configuration.fileExtension,
|
|
maxFiles: maxFiles)))
|
|
}
|
|
}
|
|
|
|
/// A list of all log file URLs, sorted chronologically. This is only public for testing purposes, within
|
|
/// the app please use ``copyLogs(to:)`` so that the files are name appropriates for QuickLook.
|
|
static var logFiles: [URL] {
|
|
var logFiles = [(url: URL, modificationDate: Date)]()
|
|
|
|
let fileManager = FileManager.default
|
|
let enumerator = fileManager.enumerator(at: logsDirectory, includingPropertiesForKeys: [.contentModificationDateKey])
|
|
|
|
// Find all *.log files and their modification dates.
|
|
while let logURL = enumerator?.nextObject() as? URL {
|
|
guard let resourceValues = try? logURL.resourceValues(forKeys: [.contentModificationDateKey]),
|
|
let modificationDate = resourceValues.contentModificationDate
|
|
else { continue }
|
|
|
|
if logURL.lastPathComponent.hasPrefix(filePrefix) {
|
|
logFiles.append((logURL, modificationDate))
|
|
}
|
|
}
|
|
|
|
let sortedFiles = logFiles.sorted { $0.modificationDate > $1.modificationDate }.map(\.url)
|
|
|
|
MXLog.info("logFiles: \(sortedFiles.map(\.lastPathComponent))")
|
|
|
|
return sortedFiles
|
|
}
|
|
|
|
/// Delete all log files.
|
|
static func deleteLogFiles() {
|
|
let fileManager = FileManager.default
|
|
for logFileURL in logFiles {
|
|
try? fileManager.removeItem(at: logFileURL)
|
|
}
|
|
}
|
|
}
|