Skip to content

Story/cite 219 - There needs to be log to see what is happening during sycnronization #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
+201 −1
Open

Story/cite 219 - There needs to be log to see what is happening during sycnronization #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
94c72ed
[CITE-219] Added InMemoryAppender for Javers logs
PradnyaC11 Apr 17, 2025
b46dce8
[CITE-219] Resolved issues with in memory appender
PradnyaC11 Apr 18, 2025
80b14b6
[CITE-219] Updated frontend code
PradnyaC11 Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions citesphere/src/main/java/edu/asu/diging/citesphere/config/core/InMemoryAppender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
package edu.asu.diging.citesphere.config.core;


import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Core;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.layout.PatternLayout;

@Plugin(name = "InMemoryAppender", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE)
public class InMemoryAppender extends AbstractAppender {

// Thread‑safe buffer to hold events
private static final List<LogEvent> BUFFER = Collections.synchronizedList(new ArrayList<>());

// Maximum number of events to keep
private static final int MAX_BUFFER_SIZE = 1000;

protected InMemoryAppender(String name, Filter filter, Layout<? extends Serializable> layout) {
super(name, filter, layout, false);
}

@PluginFactory
public static InMemoryAppender createAppender(
@PluginAttribute("name") String name,
@PluginElement("Filter") Filter filter
) {
if (name == null) {
LOGGER.error("No name provided for InMemoryAppender");
return null;
}
// Default pattern layout if none provided
PatternLayout layout = PatternLayout.newBuilder()
.withPattern("%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n")
.build();
return new InMemoryAppender(name, filter, layout);
}

@Override
public void append(LogEvent event) {
// make the event immutable (optional but safer)
LogEvent immutable = event.toImmutable();
BUFFER.add(immutable);
if (BUFFER.size() > MAX_BUFFER_SIZE) {
BUFFER.remove(0);
}
}

public static List<LogEvent> getEvents() {
synchronized (BUFFER) {
return new ArrayList<>(BUFFER);
}
}
}
49 changes: 49 additions & 0 deletions citesphere/src/main/java/edu/asu/diging/citesphere/config/core/LoggingConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package edu.asu.diging.citesphere.config.core;

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.config.LoggerConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
//import org.apache.logging.log4j.core.filter.LoggerNameFilter;

@Configuration
public class LoggingConfig {

@Bean
public Appender inMemoryAppender() {
LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
org.apache.logging.log4j.core.config.Configuration config = ctx.getConfiguration();

InMemoryAppender appender = InMemoryAppender.createAppender("InMemoryAppender", null);
appender.start();
config.addAppender(appender);

Appender console = config.getAppender("Console");

LoggerConfig javersLogger = config.getLoggerConfig("org.javers.core.Javers");
if (!"org.javers.core.Javers".equals(javersLogger.getName())) {
javersLogger = new LoggerConfig("org.javers.core.Javers", Level.INFO, false);
config.addLogger("org.javers.core.Javers", javersLogger);
}

javersLogger.addAppender(appender, Level.INFO, null);
javersLogger.addAppender(console, Level.INFO, null);

String asyncHandlerName = "org.springframework.aop.interceptor.SimpleAsyncUncaughtExceptionHandler";
LoggerConfig asyncLogger = config.getLoggerConfig(asyncHandlerName);
if (!asyncLogger.getName().equals(asyncHandlerName)) {
asyncLogger = new LoggerConfig(asyncHandlerName, Level.INFO, false);
config.addLogger(asyncHandlerName, asyncLogger);
}
asyncLogger.addAppender(appender, Level.INFO, null);
asyncLogger.addAppender(console, Level.INFO, null);

ctx.updateLoggers();

return appender;
}
}
14 changes: 14 additions & 0 deletions citesphere/src/main/java/edu/asu/diging/citesphere/web/user/SyncInfoController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
package edu.asu.diging.citesphere.web.user;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import edu.asu.diging.citesphere.config.core.InMemoryAppender;
import edu.asu.diging.citesphere.core.model.jobs.impl.GroupSyncJob;
import edu.asu.diging.citesphere.core.service.jobs.ISyncJobManager;

Expand All @@ -25,6 +30,14 @@ public SyncInfo getSyncInfo(@PathVariable("zoteroGroupId") String groupId) {
info.total = job.getTotal();
info.current = job.getCurrent();
info.status = job.getStatus() != null ? job.getStatus().name() : "";
if(info.logs == null || (info.status == "PENDING")) {
info.logs = new ArrayList<String>();
}
info.logs.addAll(InMemoryAppender.getEvents().stream()
.map(ev ->
ev.getLevel() + " " + ev.getLoggerName()
+ " - " + ev.getMessage().getFormattedMessage())
.collect(Collectors.toList()));
}

return info;
Expand All @@ -35,5 +48,6 @@ class SyncInfo {
public long total;
public long current;
public String status;
public List<String> logs;
}
}
74 changes: 73 additions & 1 deletion citesphere/src/main/webapp/WEB-INF/views/auth/group/items.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ <h2>
</h2>
<div class="pull-right">
<div class="progress" style="width: 200px">
<div id="syncProgress" class="progress-bar" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%">
<div id="syncProgress" class="progress-bar" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%" onclick="getlogs()">
<span id="syncText">Up to date</span></div>
</div>
<div style="text-align: right;margin-top: -20px;margin-bottom: 20px;">
Expand Down Expand Up @@ -374,6 +374,28 @@ <h2>
$("#syncProgress").attr('aria-valuemax', data['total']);
$("#syncProgress").addClass("progress-bar-striped active");
$("#syncText").text(Math.round(percent) + "% synced");
const $logsList = $('#logs-list');
$logsList.empty();
if(data['logs'].length == 0) {
$('<li>').text("No sync logs").appendTo($logsList);
} else {
data['logs'].forEach(log => {
const parts = log.split(' ', 2);
const level = parts[0] || '';
const message = log.substring(level.length).trim();

const $li = $('<li>');
const $strong = $('<strong>').text(level);

if (level === 'ERROR') {
$strong.addClass('text-danger');
}

$li.append($strong).append(' ').append(document.createTextNode(message));

$logsList.append($li);
});
}
}
setTimeout(pollStatus,1000);
} else {
Expand All @@ -383,11 +405,37 @@ <h2>
$("#syncProgress").removeClass("progress-bar-striped active");
$("#syncText").text("Up to date");
$("#table-spinner").hide();
const $logsList = $('#logs-list');
$logsList.empty();
if(data['logs'].length == 0) {
$('<li>').text("No sync logs").appendTo($logsList);
} else {
data['logs'].forEach(log => {
const parts = log.split(' ', 2);
const level = parts[0] || '';
const message = log.substring(level.length).trim();

const $li = $('<li>');
const $strong = $('<strong>').text(level);

if (level === 'ERROR') {
$strong.addClass('text-danger');
}

$li.append($strong).append(' ').append(document.createTextNode(message));

$logsList.append($li);
});
}
}
getCurrentItemsData("notFirstLoad");
});
}

function getlogs() {
$('#sync-logs').modal("show");
}

function getCurrentItemsData(parameter){
let pageNumber = $(".page-item.active").text();
$.ajax({
Expand Down Expand Up @@ -825,6 +873,30 @@ <h4 class="modal-title">Delete Entries</h4>
</div>
</div>

<div class="modal fade" id="sync-logs" tabindex="-1" role="dialog">
<div class="modal-dialog" role="document">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
<h4 class="modal-title">Sync Logs</h4>
</div>
<div class="modal-body">
<div
id="sync-logs-body"
class="border bg-light rounded p-3 overflow-auto"
style="max-height: 300px; overflow-y: auto;" >
<ul
id="logs-list"
class="list-unstyled text-monospace mb-0"></ul>
</div>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div>
</div>
</div>

</div>
<script >
//# sourceURL=move.js
Expand Down