Skip to content

Commit

Permalink
chore: improve some logging (#202)
Browse files Browse the repository at this point in the history 
* chore: improve some logging

* DEPENDENCIES
  • Loading branch information
@paullatzelsperger
paullatzelsperger authored Jun 14, 2024
1 parent 311a0ad commit 8cc0e32
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 31 deletions.
14 changes: 7 additions & 7 deletions DEPENDENCIES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ maven/mavencentral/com.apicatalog/copper-multibase/0.5.0, Apache-2.0, approved,
maven/mavencentral/com.apicatalog/copper-multicodec/0.1.1, Apache-2.0, approved, #14500
maven/mavencentral/com.apicatalog/iron-verifiable-credentials/0.14.0, Apache-2.0, approved, clearlydefined
maven/mavencentral/com.apicatalog/titanium-json-ld/1.0.0, Apache-2.0, approved, clearlydefined
maven/mavencentral/com.apicatalog/titanium-json-ld/1.4.0, Apache-2.0, approved, #13683
maven/mavencentral/com.apicatalog/titanium-json-ld/1.4.0, Apache-2.0, approved, #15200
maven/mavencentral/com.fasterxml.jackson.core/jackson-annotations/2.10.3, Apache-2.0, approved, CQ21280
maven/mavencentral/com.fasterxml.jackson.core/jackson-annotations/2.16.2, Apache-2.0, approved, #11606
maven/mavencentral/com.fasterxml.jackson.core/jackson-annotations/2.17.0, Apache-2.0, approved, #13672
Expand All @@ -28,7 +28,7 @@ maven/mavencentral/com.fasterxml.jackson/jackson-bom/2.17.1, Apache-2.0, approve
maven/mavencentral/com.github.docker-java/docker-java-api/3.3.6, Apache-2.0, approved, #10346
maven/mavencentral/com.github.docker-java/docker-java-transport-zerodep/3.3.6, Apache-2.0 AND (Apache-2.0 AND BSD-3-Clause), approved, #7946
maven/mavencentral/com.github.docker-java/docker-java-transport/3.3.6, Apache-2.0, approved, #7942
maven/mavencentral/com.google.code.findbugs/jsr305/3.0.2, Apache-2.0, approved, #20
maven/mavencentral/com.google.code.findbugs/jsr305/3.0.2, CC-BY-2.5, approved, #15220
maven/mavencentral/com.google.code.gson/gson/2.10.1, Apache-2.0, approved, #6159
maven/mavencentral/com.google.crypto.tink/tink/1.13.0, Apache-2.0, approved, #14502
maven/mavencentral/com.google.errorprone/error_prone_annotations/2.22.0, Apache-2.0, approved, #10661
Expand All @@ -40,7 +40,7 @@ maven/mavencentral/com.google.protobuf/protobuf-java/3.25.1, BSD-3-Clause, appro
maven/mavencentral/com.nimbusds/nimbus-jose-jwt/9.40, Apache-2.0, approved, #15156
maven/mavencentral/com.puppycrawl.tools/checkstyle/10.17.0, LGPL-2.1-or-later AND (Apache-2.0 AND LGPL-2.1-or-later) AND Apache-2.0, approved, #15077
maven/mavencentral/com.squareup.okhttp3/okhttp-dnsoverhttps/4.12.0, Apache-2.0, approved, #11159
maven/mavencentral/com.squareup.okhttp3/okhttp/4.12.0, Apache-2.0, approved, #11156
maven/mavencentral/com.squareup.okhttp3/okhttp/4.12.0, Apache-2.0, approved, #15227
maven/mavencentral/com.squareup.okhttp3/okhttp/4.9.3, Apache-2.0 AND MPL-2.0, approved, #3225
maven/mavencentral/com.squareup.okio/okio-jvm/3.6.0, Apache-2.0, approved, #11158
maven/mavencentral/com.squareup.okio/okio/3.6.0, Apache-2.0, approved, #11155
Expand All @@ -50,7 +50,7 @@ maven/mavencentral/commons-codec/commons-codec/1.11, Apache-2.0 AND BSD-3-Clause
maven/mavencentral/commons-codec/commons-codec/1.15, Apache-2.0 AND BSD-3-Clause AND LicenseRef-Public-Domain, approved, CQ22641
maven/mavencentral/commons-collections/commons-collections/3.2.2, Apache-2.0, approved, #15185
maven/mavencentral/commons-logging/commons-logging/1.2, Apache-2.0, approved, CQ10162
maven/mavencentral/dev.failsafe/failsafe-okhttp/3.3.2, Apache-2.0, approved, #9178
maven/mavencentral/dev.failsafe/failsafe-okhttp/3.3.2, Apache-2.0, approved, #15208
maven/mavencentral/dev.failsafe/failsafe/3.3.2, Apache-2.0, approved, #9268
maven/mavencentral/info.picocli/picocli/4.7.6, Apache-2.0, approved, #4365
maven/mavencentral/io.github.classgraph/classgraph/4.8.165, MIT, approved, CQ22530
Expand All @@ -59,7 +59,7 @@ maven/mavencentral/io.opentelemetry/opentelemetry-api/1.32.0, Apache-2.0, approv
maven/mavencentral/io.opentelemetry/opentelemetry-context/1.32.0, Apache-2.0, approved, #11683
maven/mavencentral/io.rest-assured/json-path/5.4.0, Apache-2.0, approved, #12042
maven/mavencentral/io.rest-assured/rest-assured-common/5.4.0, Apache-2.0, approved, #12039
maven/mavencentral/io.rest-assured/rest-assured/5.4.0, Apache-2.0, approved, #12040
maven/mavencentral/io.rest-assured/rest-assured/5.4.0, Apache-2.0, approved, #15190
maven/mavencentral/io.rest-assured/xml-path/5.4.0, Apache-2.0, approved, #12038
maven/mavencentral/io.setl/rdf-urdna/1.1, Apache-2.0, approved, clearlydefined
maven/mavencentral/io.swagger.core.v3/swagger-annotations-jakarta/2.2.21, Apache-2.0, approved, #5947
Expand Down Expand Up @@ -92,7 +92,7 @@ maven/mavencentral/junit/junit/4.13.2, EPL-2.0, approved, CQ23636
maven/mavencentral/net.bytebuddy/byte-buddy-agent/1.14.15, Apache-2.0, approved, #7164
maven/mavencentral/net.bytebuddy/byte-buddy/1.14.15, Apache-2.0 AND BSD-3-Clause, approved, #7163
maven/mavencentral/net.bytebuddy/byte-buddy/1.14.16, Apache-2.0 AND BSD-3-Clause, approved, #7163
maven/mavencentral/net.java.dev.jna/jna/5.13.0, Apache-2.0 AND LGPL-2.1-or-later, approved, #6709
maven/mavencentral/net.java.dev.jna/jna/5.13.0, Apache-2.0 AND LGPL-2.1-or-later, approved, #15196
maven/mavencentral/net.sf.saxon/Saxon-HE/12.4, MPL-2.0 AND (MPL-2.0 AND Apache-2.0) AND (MPL-2.0 AND LicenseRef-X11-style) AND MPL-1.0 AND W3C, approved, #12716
maven/mavencentral/org.antlr/antlr4-runtime/4.13.1, BSD-3-Clause, approved, #10767
maven/mavencentral/org.apache.commons/commons-compress/1.24.0, Apache-2.0 AND BSD-3-Clause AND bzip2-1.0.6 AND LicenseRef-Public-Domain, approved, #10368
Expand Down Expand Up @@ -294,7 +294,7 @@ maven/mavencentral/org.junit.platform/junit-platform-commons/1.10.1, EPL-2.0, ap
maven/mavencentral/org.junit.platform/junit-platform-commons/1.10.2, EPL-2.0, approved, #9715
maven/mavencentral/org.junit.platform/junit-platform-engine/1.10.1, EPL-2.0, approved, #9709
maven/mavencentral/org.junit.platform/junit-platform-engine/1.10.2, EPL-2.0, approved, #9709
maven/mavencentral/org.junit.platform/junit-platform-launcher/1.10.2, EPL-2.0, approved, #9704
maven/mavencentral/org.junit.platform/junit-platform-launcher/1.10.2, EPL-2.0, approved, #15216
maven/mavencentral/org.junit/junit-bom/5.10.1, EPL-2.0, approved, #9844
maven/mavencentral/org.junit/junit-bom/5.10.2, EPL-2.0, approved, #9844
maven/mavencentral/org.junit/junit-bom/5.9.2, EPL-2.0, approved, #4711
Expand Down
24 changes: 10 additions & 14 deletions core/crawler-core/src/main/java/org/eclipse/edc/catalog/cache/ExecutionManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,8 @@ private ExecutionManager() {

public void executePlan(ExecutionPlan plan) {
plan.run(() -> {

monitor.info("Run pre-execution task");
runPreExecution();

monitor.info("Run execution");
doWork();

monitor.info("Run post-execution task");
runPostExecution();
});

Expand All @@ -81,7 +75,7 @@ private void doWork() {
// load work items from directory
var workItems = fetchWorkItems();
if (workItems.isEmpty()) {
monitor.warning("No WorkItems found, aborting execution");
monitor.debug("No WorkItems found, skipping execution");
return;
}
monitor.debug("Loaded " + workItems.size() + " work items from storage");
Expand All @@ -104,7 +98,7 @@ private void doWork() {

var item = allItems.poll();
if (item == null) {
monitor.warning("WorkItem queue empty, abort execution");
monitor.debug("WorkItem queue empty, skip execution");
break;
}

Expand All @@ -116,9 +110,9 @@ private void doWork() {
crawler.run(item, adapter.get())
.whenComplete((updateResponse, throwable) -> {
if (throwable != null) {
monitor.severe(format("Unexpected exception happened during in crawler %s", crawler.getId()), throwable);
monitor.severe(format("Unexpected exception occurred during in crawler %s", crawler.getId()), throwable);
} else {
monitor.info(format("Crawler [%s] is done", crawler.getId()));
monitor.debug(format("Crawler [%s] is done", crawler.getId()));
}
availableCrawlers.add(crawler);
});
Expand All @@ -140,6 +134,7 @@ private Crawler nextAvailableCrawler(ArrayBlockingQueue<Crawler> availableCrawle
private void runPostExecution() {
if (postExecutionTask != null) {
try {
monitor.debug("Run post-execution task");
postExecutionTask.run();
} catch (Throwable thr) {
monitor.severe("Error running post execution task", thr);
Expand All @@ -150,6 +145,7 @@ private void runPostExecution() {
private void runPreExecution() {
if (preExecutionTask != null) {
try {
monitor.debug("Run pre-execution task");
preExecutionTask.run();
} catch (Throwable thr) {
monitor.severe("Error running pre execution task", thr);
Expand Down Expand Up @@ -201,6 +197,10 @@ private Builder() {
instance = new ExecutionManager();
}

public static Builder newInstance() {
return new Builder();
}

public Builder monitor(Monitor monitor) {
instance.monitor = monitor;
return this;
Expand Down Expand Up @@ -247,9 +247,5 @@ public ExecutionManager build() {
Objects.requireNonNull(instance.directory, "ExecutionManager.Builder: nodeDirectory cannot be null");
return instance;
}

public static Builder newInstance() {
return new Builder();
}
}
}
11 changes: 1 addition & 10 deletions core/crawler-core/src/test/java/org/eclipse/edc/catalog/cache/ExecutionManagerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,13 @@
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.contains;
import static org.mockito.ArgumentMatchers.isA;
import static org.mockito.ArgumentMatchers.startsWith;
import static org.mockito.Mockito.atLeastOnce;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;

class ExecutionManagerTest {
Expand Down Expand Up @@ -157,14 +155,7 @@ void executePlan_completesExceptionally() {
void executePlan_workItemsEmpty() {
when(nodeDirectoryMock.getAll()).thenReturn(List.of());
manager.executePlan(simplePlan());
var inorder = inOrder(preExecutionTaskMock, monitorMock);

inorder.verify(monitorMock).info(anyString());
inorder.verify(preExecutionTaskMock).run();
inorder.verify(monitorMock).info(anyString());
inorder.verify(monitorMock).warning(startsWith("No WorkItems found"));
inorder.verify(monitorMock).info(anyString());
verifyNoMoreInteractions(monitorMock);

verifyNoInteractions(crawlerActionRegistry);
}

Expand Down

0 comments on commit 8cc0e32

Please sign in to comment.