Skip to content

Commit

Permalink
Refactor into own class
Browse files Browse the repository at this point in the history
  • Loading branch information
mcm001 committed Nov 6, 2024
1 parent f05edfc commit 2ab5409
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 43 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/*
* Copyright (C) Photon Vision.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package org.photonvision.common.logging;

import edu.wpi.first.util.RuntimeDetector;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import org.photonvision.common.util.TimedTaskManager;
import org.photonvision.jni.QueuedFileLogger;

/**
* Listens for and reproduces Linux kernel logs, from /var/log/kern.log, into the Photon logger
* ecosystem
*/
public class KernelLogLogger {
private static KernelLogLogger INSTANCE;

public static KernelLogLogger getInstance() {
if (INSTANCE == null) {
INSTANCE = new KernelLogLogger();
}
return INSTANCE;
}

QueuedFileLogger listener = null;
Logger logger = new Logger(KernelLogLogger.class, LogGroup.General);

public KernelLogLogger() {
if (RuntimeDetector.isLinux()) {
logger.info("Listening for klogs on /var/log/dmesg ! Boot logs:");

try {
var bootlog = Files.readAllLines(Path.of("/var/log/dmesg"));
for (var line : bootlog) {
logger.log(line, LogLevel.DEBUG);
}
} catch (IOException e) {
logger.error("Couldn't read /var/log/dmesg - not printing boot logs");
}

listener = new QueuedFileLogger("/var/log/kern.log");
} else {
System.out.println("NOT for klogs");
}

// arbitrary frequency to grab logs. The underlying native buffer will grow unbounded without
// this, lol
TimedTaskManager.getInstance().addTask("outputPrintk", this::outputNewPrintks, 1000);
}

public void outputNewPrintks() {
for (var msg : listener.getNewlines()) {
// We currently set all logs to debug regardless of their actual level
logger.log(msg, LogLevel.DEBUG);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@

package org.photonvision.common.logging;

import edu.wpi.first.util.RuntimeDetector;
import java.io.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.text.ParseException;
import java.text.SimpleDateFormat;
Expand All @@ -31,7 +29,6 @@
import org.photonvision.common.dataflow.DataChangeService;
import org.photonvision.common.dataflow.events.OutgoingUIEvent;
import org.photonvision.common.util.TimedTaskManager;
import org.photonvision.jni.QueuedFileLogger;

/** TODO: get rid of static {} blocks and refactor to singleton pattern */
public class Logger {
Expand All @@ -40,8 +37,8 @@ public class Logger {

private static final UILogAppender uiLogAppender = new UILogAppender();

// TODO why's the logger care about this? split it out
private static KernelLogListener klogListener = null;
// // TODO why's the logger care about this? split it out
// private static KernelLogLogger klogListener = null;

static {
levelMap.put(LogGroup.Camera, LogLevel.INFO);
Expand All @@ -61,10 +58,6 @@ public class Logger {
cleanLogs(PathManager.getInstance().getLogsDir());
}

public static void addKlongListener() {
klogListener = new KernelLogListener();
}

public static final String ANSI_RESET = "\u001B[0m";
public static final String ANSI_BLACK = "\u001B[30m";
public static final String ANSI_RED = "\u001B[31m";
Expand Down Expand Up @@ -298,38 +291,6 @@ private static String convertStackTraceToString(Throwable throwable) {
}
}

private static class KernelLogListener {
QueuedFileLogger listener = null;
Logger logger = new Logger(KernelLogListener.class, LogGroup.General);

public KernelLogListener() {
if (RuntimeDetector.isLinux()) {
logger.info("Listening for klogs on /var/log/dmesg ! Boot logs:");

try {
var bootlog = Files.readAllLines(Path.of("/var/log/dmesg"));
for (var line : bootlog) {
logger.log(line, LogLevel.DEBUG);
}
} catch (IOException e) {
logger.error("Couldn't read /var/log/dmesg - not printing boot logs");
}

listener = new QueuedFileLogger("/var/log/kern.log");
} else {
System.out.println("NOT for klogs");
}

TimedTaskManager.getInstance().addTask("outputPrintk", this::outputNewPrintks, 1000);
}

public void outputNewPrintks() {
for (var msg : listener.getNewlines()) {
logger.log(msg, LogLevel.DEBUG);
}
}
}

private interface LogAppender {
void log(String message, LogLevel level);

Expand Down
5 changes: 3 additions & 2 deletions photon-server/src/main/java/org/photonvision/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import org.photonvision.common.hardware.HardwareManager;
import org.photonvision.common.hardware.PiVersion;
import org.photonvision.common.hardware.Platform;
import org.photonvision.common.logging.KernelLogLogger;
import org.photonvision.common.logging.LogGroup;
import org.photonvision.common.logging.LogLevel;
import org.photonvision.common.logging.Logger;
Expand Down Expand Up @@ -437,8 +438,8 @@ public static void main(String[] args) {
Logger.setLevel(LogGroup.General, logLevel);
logger.info("Logging initialized in debug mode.");

// after native libraries are loaded :(
Logger.addKlongListener();
// Add Linux kernel log->Photon logger
KernelLogLogger.getInstance();

// Add CSCore->Photon logger
PvCSCoreLogger.getInstance();
Expand Down

0 comments on commit 2ab5409

Please sign in to comment.