Simplify logging tags
This was roop's initial idea, and it turns out to be the better one, now that we can pass cstrings more easily.
This commit is contained in:
parent
34a7e5b558
commit
33d88529c6
|
@ -5,33 +5,34 @@ import Foundation
|
||||||
import os.log
|
import os.log
|
||||||
|
|
||||||
public class Logger {
|
public class Logger {
|
||||||
|
enum LoggerError: Error {
|
||||||
|
case openFailure
|
||||||
|
}
|
||||||
static var global: Logger?
|
static var global: Logger?
|
||||||
|
|
||||||
var log: OpaquePointer?
|
var log: OpaquePointer
|
||||||
var tag: String
|
|
||||||
|
|
||||||
init(withFilePath filePath: String, withTag tag: String) {
|
init(withFilePath filePath: String) throws {
|
||||||
self.tag = tag
|
guard let log = open_log(filePath) else { throw LoggerError.openFailure }
|
||||||
self.log = open_log(filePath)
|
self.log = log
|
||||||
if self.log == nil {
|
}
|
||||||
os_log("Cannot open log file for writing. Log will not be saved to file.", log: OSLog.default, type: .error)
|
|
||||||
}
|
deinit {
|
||||||
|
close_log(self.log)
|
||||||
}
|
}
|
||||||
|
|
||||||
func log(message: String) {
|
func log(message: String) {
|
||||||
guard let log = log else { return }
|
write_msg_to_log(log, message.trimmingCharacters(in: .newlines))
|
||||||
write_msg_to_log(log, String(format: "[%@] %@", tag, message.trimmingCharacters(in: .newlines)))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func writeLog(mergedWith otherLogFile: String, to targetFile: String) -> Bool {
|
func writeLog(called ourTag: String, mergedWith otherLogFile: String, called otherTag: String, to targetFile: String) -> Bool {
|
||||||
guard let log = log else { return false }
|
|
||||||
guard let other = open_log(otherLogFile) else { return false }
|
guard let other = open_log(otherLogFile) else { return false }
|
||||||
let ret = write_logs_to_file(targetFile, log, other)
|
let ret = write_logs_to_file(targetFile, log, ourTag, other, otherTag)
|
||||||
close_log(other)
|
close_log(other)
|
||||||
return ret == 0
|
return ret == 0
|
||||||
}
|
}
|
||||||
|
|
||||||
static func configureGlobal(withFilePath filePath: String?, withTag tag: String) {
|
static func configureGlobal(withFilePath filePath: String?) {
|
||||||
if Logger.global != nil {
|
if Logger.global != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -39,7 +40,12 @@ public class Logger {
|
||||||
os_log("Unable to determine log destination path. Log will not be saved to file.", log: OSLog.default, type: .error)
|
os_log("Unable to determine log destination path. Log will not be saved to file.", log: OSLog.default, type: .error)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
Logger.global = Logger(withFilePath: filePath, withTag: tag)
|
do {
|
||||||
|
try Logger.global = Logger(withFilePath: filePath)
|
||||||
|
} catch {
|
||||||
|
os_log("Unable to open log file for writing. Log will not be saved to file.", log: OSLog.default, type: .error)
|
||||||
|
return
|
||||||
|
}
|
||||||
var appVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "Unknown version"
|
var appVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? "Unknown version"
|
||||||
if let appBuild = Bundle.main.infoDictionary?["CFBundleVersion"] as? String {
|
if let appBuild = Bundle.main.infoDictionary?["CFBundleVersion"] as? String {
|
||||||
appVersion += " (\(appBuild))"
|
appVersion += " (\(appBuild))"
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
enum {
|
enum {
|
||||||
MAX_LOG_LINE_LENGTH = 512,
|
MAX_LOG_LINE_LENGTH = 512,
|
||||||
MAX_LINES = 1024,
|
MAX_LINES = 1024,
|
||||||
MAGIC = 0xdeadbeefU
|
MAGIC = 0xbeefbabeU
|
||||||
};
|
};
|
||||||
|
|
||||||
struct log_line {
|
struct log_line {
|
||||||
|
@ -59,7 +59,7 @@ static bool first_before_second(const struct log_line *line1, const struct log_l
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
int write_logs_to_file(const char *file_name, const struct log *log1, const struct log *log2)
|
int write_logs_to_file(const char *file_name, const struct log *log1, const char *tag1, const struct log *log2, const char *tag2)
|
||||||
{
|
{
|
||||||
uint32_t i1, i2, len1 = log1->header.len, len2 = log2->header.len;
|
uint32_t i1, i2, len1 = log1->header.len, len2 = log2->header.len;
|
||||||
char buf[MAX_LOG_LINE_LENGTH];
|
char buf[MAX_LOG_LINE_LENGTH];
|
||||||
|
@ -78,19 +78,22 @@ int write_logs_to_file(const char *file_name, const struct log *log1, const stru
|
||||||
const struct log_line *line1 = &log1->lines[(log1->header.first + i1) % MAX_LINES];
|
const struct log_line *line1 = &log1->lines[(log1->header.first + i1) % MAX_LINES];
|
||||||
const struct log_line *line2 = &log2->lines[(log2->header.first + i2) % MAX_LINES];
|
const struct log_line *line2 = &log2->lines[(log2->header.first + i2) % MAX_LINES];
|
||||||
const struct log_line *line;
|
const struct log_line *line;
|
||||||
|
const char *tag;
|
||||||
|
|
||||||
if (i1 < len1 && (i2 >= len2 || first_before_second(line1, line2))) {
|
if (i1 < len1 && (i2 >= len2 || first_before_second(line1, line2))) {
|
||||||
line = line1;
|
line = line1;
|
||||||
|
tag = tag1;
|
||||||
++i1;
|
++i1;
|
||||||
} else if (i2 < len2 && (i1 >= len1 || first_before_second(line2, line1))) {
|
} else if (i2 < len2 && (i1 >= len1 || first_before_second(line2, line1))) {
|
||||||
line = line2;
|
line = line2;
|
||||||
|
tag = tag2;
|
||||||
++i2;
|
++i2;
|
||||||
} else {
|
} else {
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
memcpy(buf, line->line, MAX_LOG_LINE_LENGTH);
|
memcpy(buf, line->line, MAX_LOG_LINE_LENGTH);
|
||||||
buf[MAX_LOG_LINE_LENGTH - 1] = '\0';
|
buf[MAX_LOG_LINE_LENGTH - 1] = '\0';
|
||||||
if (fprintf(file, "%lu.%06d: %s\n", line->tv.tv_sec, line->tv.tv_usec, buf) < 0) {
|
if (fprintf(file, "%lu.%06d: [%s] %s\n", line->tv.tv_sec, line->tv.tv_usec, tag, buf) < 0) {
|
||||||
int ret = -errno;
|
int ret = -errno;
|
||||||
fclose(file);
|
fclose(file);
|
||||||
return ret;
|
return ret;
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
|
|
||||||
struct log;
|
struct log;
|
||||||
void write_msg_to_log(struct log *log, const char *msg);
|
void write_msg_to_log(struct log *log, const char *msg);
|
||||||
int write_logs_to_file(const char *file_name, const struct log *log1, const struct log *log2);
|
int write_logs_to_file(const char *file_name, const struct log *log1, const char *tag1, const struct log *log2, const char *tag2);
|
||||||
struct log *open_log(const char *file_name);
|
struct log *open_log(const char *file_name);
|
||||||
void close_log(struct log *log);
|
void close_log(struct log *log);
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
|
||||||
|
|
||||||
func application(_ application: UIApplication,
|
func application(_ application: UIApplication,
|
||||||
willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
|
willFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
|
||||||
Logger.configureGlobal(withFilePath: FileManager.appLogFileURL?.path, withTag: "APP")
|
Logger.configureGlobal(withFilePath: FileManager.appLogFileURL?.path)
|
||||||
|
|
||||||
let window = UIWindow(frame: UIScreen.main.bounds)
|
let window = UIWindow(frame: UIScreen.main.bounds)
|
||||||
window.backgroundColor = UIColor.white
|
window.backgroundColor = UIColor.white
|
||||||
|
|
|
@ -119,7 +119,7 @@ class SettingsTableViewController: UITableViewController {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
let isWritten = Logger.global?.writeLog(mergedWith: networkExtensionLogFilePath, to: destinationURL.path) ?? false
|
let isWritten = Logger.global?.writeLog(called: "APP", mergedWith: networkExtensionLogFilePath, called: "NET", to: destinationURL.path) ?? false
|
||||||
guard isWritten else {
|
guard isWritten else {
|
||||||
ErrorPresenter.showErrorAlert(title: "Log export failed", message: "Unable to write logs to file", from: self)
|
ErrorPresenter.showErrorAlert(title: "Log export failed", message: "Unable to write logs to file", from: self)
|
||||||
return
|
return
|
||||||
|
|
|
@ -140,7 +140,7 @@ class PacketTunnelProvider: NEPacketTunnelProvider {
|
||||||
}
|
}
|
||||||
|
|
||||||
private func configureLogger() {
|
private func configureLogger() {
|
||||||
Logger.configureGlobal(withFilePath: FileManager.networkExtensionLogFileURL?.path, withTag: "EXT")
|
Logger.configureGlobal(withFilePath: FileManager.networkExtensionLogFileURL?.path)
|
||||||
wgSetLogger { level, msgC in
|
wgSetLogger { level, msgC in
|
||||||
guard let msgC = msgC else { return }
|
guard let msgC = msgC else { return }
|
||||||
let logType: OSLogType
|
let logType: OSLogType
|
||||||
|
|
Loading…
Reference in New Issue