Skip to content

Commit 119f7eb

Browse files
adamretteradamretter
authored
Merge pull request #73 from evolvedbinary/7.x.x/feature/cleanup-startup-messages
[7.x.x] Cleanup startup messages
2 parents 8faa75d + 2cd994b commit 119f7eb

File tree

31 files changed

+172
-208
lines changed

31 files changed

+172
-208
lines changed

‎exist-ant/src/test/resources/log4j2.xml‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -176,12 +176,7 @@
176176
<AppenderRef ref="elemental.core"/>
177177
</Logger>
178178

179-
<Logger name="org.exist.jetty.JettyStart" additivity="false" level="trace">
180-
<AppenderRef ref="STDOUT"/>
181-
<AppenderRef ref="elemental.core"/>
182-
</Logger>
183-
184-
<Logger name="org.exist.jetty.StandaloneServer" additivity="false" level="trace">
179+
<Logger name="org.exist.jetty.JettyStart" additivity="false" level="warn">
185180
<AppenderRef ref="STDOUT"/>
186181
<AppenderRef ref="elemental.core"/>
187182
</Logger>
@@ -190,12 +185,12 @@
190185
<AppenderRef ref="elemental.profiling"/>
191186
</Logger>
192187

193-
<Logger name="org.exist.statistics" additivity="false" level="debug">
188+
<Logger name="org.exist.statistics" additivity="false" level="info">
194189
<AppenderRef ref="elemental.core"/>
195190
<AppenderRef ref="elemental.statistics"/>
196191
</Logger>
197192

198-
<Logger name="org.exist.backup.SystemExport" additivity="false" level="trace">
193+
<Logger name="org.exist.backup.SystemExport" additivity="false" level="info">
199194
<AppenderRef ref="elemental.backup"/>
200195
</Logger>
201196

‎exist-core/pom.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -879,6 +879,8 @@
879879
<include>src/main/java/org/exist/http/Descriptor.java</include>
880880
<include>src/main/java/org/exist/http/RESTServer.java</include>
881881
<include>src/test/java/org/exist/http/RESTServiceTest.java</include>
882+
<include>src/main/java/org/exist/http/servlets/AbstractExistHttpServlet.java</include>
883+
<include>src/main/java/org/exist/http/servlets/XQueryServlet.java</include>
882884
<include>src/main/java/org/exist/http/servlets/XSLTServlet.java</include>
883885
<include>src/main/java/org/exist/http/urlrewrite/ModuleCall.java</include>
884886
<include>src/main/java/org/exist/http/urlrewrite/PathForward.java</include>
@@ -1225,6 +1227,8 @@
12251227
<exclude>src/main/java/org/exist/http/Descriptor.java</exclude>
12261228
<exclude>src/main/java/org/exist/http/RESTServer.java</exclude>
12271229
<exclude>src/test/java/org/exist/http/RESTServiceTest.java</exclude>
1230+
<exclude>src/main/java/org/exist/http/servlets/AbstractExistHttpServlet.java</exclude>
1231+
<exclude>src/main/java/org/exist/http/servlets/XQueryServlet.java</exclude>
12281232
<exclude>src/main/java/org/exist/http/servlets/XSLTServlet.java</exclude>
12291233
<exclude>src/main/java/org/exist/http/urlrewrite/ModuleCall.java</exclude>
12301234
<exclude>src/main/java/org/exist/http/urlrewrite/PathForward.java</exclude>

‎exist-core/src/main/java/org/exist/http/servlets/AbstractExistHttpServlet.java‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* [email protected]
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -100,7 +124,9 @@ private BrokerPool getOrCreateBrokerPool(final ServletConfig config) throws EXis
100124

101125
// Configure BrokerPool
102126
if(BrokerPool.isConfigured()) {
103-
getLog().info("Database already started. Skipping configuration ...");
127+
if (getLog().isDebugEnabled()) {
128+
getLog().debug("Database already started. Skipping configuration ...");
129+
}
104130
} else {
105131
final String confFile = Optional.ofNullable(config.getInitParameter("configuration")).orElse("conf.xml");
106132

@@ -188,9 +214,11 @@ private void doGeneralExistServletConfig(ServletConfig config) {
188214
}
189215

190216
if (getDefaultUser() != null) {
191-
getLog().info("Using default user {} for all unauthorized requests.", getDefaultUsername());
217+
if (getLog().isDebugEnabled()) {
218+
getLog().debug("Using default user '{}' for all unauthorized requests.", getDefaultUsername());
219+
}
192220
} else {
193-
getLog().error("Default user {} cannot be found. A BASIC AUTH challenge will be the default.", getDefaultUsername());
221+
getLog().warn("Default user '{}' cannot be found. A BASIC AUTH challenge will be the default.", getDefaultUsername());
194222
}
195223
} else {
196224
getLog().info("No default user. All requires must be authorized or will result in a BASIC AUTH challenge.");

‎exist-core/src/main/java/org/exist/http/servlets/XQueryServlet.java‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
/*
2+
* Elemental
3+
* Copyright (C) 2024, Evolved Binary Ltd
4+
*
5+
* [email protected]
6+
* https://www.evolvedbinary.com | https://www.elemental.xyz
7+
*
8+
* This library is free software; you can redistribute it and/or
9+
* modify it under the terms of the GNU Lesser General Public
10+
* License as published by the Free Software Foundation; version 2.1.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
22+
* The original license header is included below.
23+
*
24+
* =====================================================================
25+
*
226
* eXist-db Open Source Native XML Database
327
* Copyright (C) 2001 The eXist-db Authors
428
*
@@ -144,7 +168,9 @@ public void init(ServletConfig config) throws ServletException {
144168
if(encoding == null) {
145169
encoding = DEFAULT_ENCODING;
146170
}
147-
getLog().info("encoding = {}", encoding);
171+
if (getLog().isDebugEnabled()) {
172+
getLog().debug("encoding = {}", encoding);
173+
}
148174

149175
contentType = config.getInitParameter("content-type");
150176
if(contentType == null) {

‎exist-core/src/main/java/org/exist/jetty/JettyStart.java‎

Lines changed: 42 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,9 @@ public synchronized void run(final String[] args, final Observer observer) {
229229
addObserver(observer);
230230
}
231231

232-
logger.info("Running with Java {} [{} ({}) in {}]",
232+
logger.info("Operating System: {} {} {}]", System.getProperty("os.name"), System.getProperty("os.version"), System.getProperty("os.arch"));
233+
logger.info("Running as user: {}", System.getProperty("user.name", "(unknown user.name)"));
234+
logger.info("Using Java: {} [{} ({}) in {}]",
233235
System.getProperty("java.version", "(unknown java.version)"),
234236
System.getProperty("java.vendor", "(unknown java.vendor)"),
235237
System.getProperty("java.vm.name", "(unknown java.vm.name)"),
@@ -239,19 +241,11 @@ public synchronized void run(final String[] args, final Observer observer) {
239241
logger.info("Approximate maximum amount of memory for JVM: {}", FileUtils.humanSize(Runtime.getRuntime().maxMemory()));
240242
logger.info("Number of processors available to JVM: {}", Runtime.getRuntime().availableProcessors());
241243

242-
logger.info("Running as user '{}'", System.getProperty("user.name", "(unknown user.name)"));
243-
logger.info("[Elemental Home : {}]", System.getProperty("exist.home", "unknown"));
244-
logger.info("[Elemental Version : {}]", SystemProperties.getInstance().getSystemProperty("product-version", "unknown"));
245-
logger.info("[Elemental Build : {}]", SystemProperties.getInstance().getSystemProperty("product-build", "unknown"));
246-
logger.info("[Git commit : {}]", SystemProperties.getInstance().getSystemProperty("git-commit", "unknown"));
247-
logger.info("[Git commit timestamp : {}]", SystemProperties.getInstance().getSystemProperty("git-commit-timestamp", "unknown"));
248-
249-
logger.info("[Operating System : {} {} {}]", System.getProperty("os.name"), System.getProperty("os.version"), System.getProperty("os.arch"));
250-
logger.info("[log4j.configurationFile : {}]", System.getProperty("log4j.configurationFile"));
251-
logger.info("[jetty Version: {}]", Jetty.VERSION);
252-
logger.info("[{} : {}]", JETTY_HOME_PROP, configProperties.get(JETTY_HOME_PROP));
253-
logger.info("[{} : {}]", JETTY_BASE_PROP, configProperties.get(JETTY_BASE_PROP));
254-
logger.info("[jetty configuration : {}]", jettyConfig.toAbsolutePath().toString());
244+
logger.info("[Elemental Version: {}]", SystemProperties.getInstance().getSystemProperty("product-version", "unknown"));
245+
logger.info("[Elemental Build: {}]", SystemProperties.getInstance().getSystemProperty("product-build", "unknown"));
246+
logger.info("[Elemental Git commit: {}]", SystemProperties.getInstance().getSystemProperty("git-commit", "unknown"));
247+
logger.info("[Elemental Git commit timestamp: {}]", SystemProperties.getInstance().getSystemProperty("git-commit-timestamp", "unknown"));
248+
logger.info("[Elemental Home: {}]", System.getProperty("exist.home", "unknown"));
255249

256250
// configure the database instance
257251
SingleInstanceConfiguration config;
@@ -260,10 +254,16 @@ public synchronized void run(final String[] args, final Observer observer) {
260254
} else {
261255
config = new SingleInstanceConfiguration();
262256
}
263-
logger.info("Configuring Elemental from {}",
264-
config.getConfigFilePath()
265-
.map(Path::normalize).map(Path::toAbsolutePath).map(Path::toString)
266-
.orElse("<UNKNOWN>"));
257+
final String elementalConfigPath = config.getConfigFilePath()
258+
.map(Path::normalize).map(Path::toAbsolutePath).map(Path::toString)
259+
.orElse("<UNKNOWN>");
260+
logger.info("[Elemental Configuration: {}]", elementalConfigPath);
261+
262+
logger.info("[Log4j Configuration: {}]", System.getProperty("log4j.configurationFile"));
263+
logger.info("[Jetty Version: {}]", Jetty.VERSION);
264+
logger.info("[Jetty Home: {}]", configProperties.get(JETTY_HOME_PROP));
265+
logger.info("[Jetty Base: {}]", configProperties.get(JETTY_BASE_PROP));
266+
logger.info("[Jetty Configuration: {}]", jettyConfig.toAbsolutePath().toString());
267267

268268
BrokerPool.configure(1, 5, config, Optional.ofNullable(observer));
269269

@@ -284,7 +284,9 @@ public synchronized void run(final String[] args, final Observer observer) {
284284
final List<Object> configuredObjects = new ArrayList<>();
285285
XmlConfiguration last = null;
286286
for(final Path confFile : configFiles) {
287-
logger.info("[loading jetty configuration : {}]", confFile.toString());
287+
if (logger.isDebugEnabled()) {
288+
logger.debug("[Loading Jetty Configuration: {}]", confFile.toString());
289+
}
288290
final Resource resource = new PathResource(confFile);
289291
final XmlConfiguration configuration = new XmlConfiguration(resource);
290292
if (last != null) {
@@ -508,7 +510,9 @@ private Optional<Server> startJetty(final List<Object> configuredObjects) throws
508510

509511
try {
510512
Runtime.getRuntime().addShutdownHook(shutdownHookThread);
511-
logger.debug("BrokerPoolsAndJetty.ShutdownHook hook registered");
513+
if (logger.isDebugEnabled()) {
514+
logger.debug("BrokerPoolsAndJetty.ShutdownHook hook registered");
515+
}
512516
} catch (final IllegalArgumentException | IllegalStateException e) {
513517
// Hook already registered, or Shutdown in progress
514518
logger.error("Unable to add BrokerPoolsAndJetty.ShutdownHook hook: {}", e.getMessage(), e);
@@ -520,7 +524,9 @@ private Optional<Server> startJetty(final List<Object> configuredObjects) throws
520524

521525
if (configuredObject instanceof LifeCycle lc) {
522526
if (!lc.isRunning()) {
523-
logger.info("[Starting jetty component : {}]", lc.getClass().getName());
527+
if (logger.isDebugEnabled()) {
528+
logger.debug("[Starting Jetty Component : {}]", lc.getClass().getName());
529+
}
524530
lc.start();
525531
}
526532
}
@@ -582,7 +588,9 @@ public synchronized void shutdown() {
582588
shutdownHookThread.ifPresent(thread -> {
583589
try {
584590
Runtime.getRuntime().removeShutdownHook(thread);
585-
logger.debug("BrokerPoolsAndJetty.ShutdownHook hook unregistered");
591+
if (logger.isDebugEnabled()) {
592+
logger.debug("BrokerPoolsAndJetty.ShutdownHook hook unregistered");
593+
}
586594
} catch (final IllegalStateException e) {
587595
// Shutdown in progress
588596
logger.warn("Unable to remove BrokerPoolsAndJetty.ShutdownHook hook: {}", e.getMessage());
@@ -677,7 +685,9 @@ public synchronized boolean isStarted() {
677685

678686
@Override
679687
public synchronized void lifeCycleStarting(final LifeCycle lifeCycle) {
680-
logger.info("Jetty server starting...");
688+
if (logger.isDebugEnabled()) {
689+
logger.debug("Jetty server starting...");
690+
}
681691
setChanged();
682692
notifyObservers(SIGNAL_STARTING);
683693
status = STATUS_STARTING;
@@ -686,7 +696,9 @@ public synchronized void lifeCycleStarting(final LifeCycle lifeCycle) {
686696

687697
@Override
688698
public synchronized void lifeCycleStarted(final LifeCycle lifeCycle) {
689-
logger.info("Jetty server started.");
699+
if (logger.isDebugEnabled()) {
700+
logger.debug("Jetty server started.");
701+
}
690702
setChanged();
691703
notifyObservers(SIGNAL_STARTED);
692704
status = STATUS_STARTED;
@@ -699,14 +711,18 @@ public void lifeCycleFailure(final LifeCycle lifeCycle, final Throwable throwabl
699711

700712
@Override
701713
public synchronized void lifeCycleStopping(final LifeCycle lifeCycle) {
702-
logger.info("Jetty server stopping...");
714+
if (logger.isDebugEnabled()) {
715+
logger.debug("Jetty server stopping...");
716+
}
703717
status = STATUS_STOPPING;
704718
notifyAll();
705719
}
706720

707721
@Override
708722
public synchronized void lifeCycleStopped(final LifeCycle lifeCycle) {
709-
logger.info("Jetty server stopped");
723+
if (logger.isDebugEnabled()) {
724+
logger.debug("Jetty server stopped");
725+
}
710726
status = STATUS_STOPPED;
711727
notifyAll();
712728
}

‎exist-core/src/test/resources/log4j2.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -176,20 +176,16 @@
176176
<AppenderRef ref="elemental.core"/>
177177
</Logger>
178178

179-
<Logger name="org.exist.jetty.StandaloneServer" additivity="false" level="warn">
180-
<AppenderRef ref="elemental.core"/>
181-
</Logger>
182-
183179
<Logger name="xquery.profiling" additivity="false" level="trace">
184180
<AppenderRef ref="elemental.profiling"/>
185181
</Logger>
186182

187-
<Logger name="org.exist.statistics" additivity="false" level="debug">
183+
<Logger name="org.exist.statistics" additivity="false" level="info">
188184
<AppenderRef ref="elemental.core"/>
189185
<AppenderRef ref="elemental.statistics"/>
190186
</Logger>
191187

192-
<Logger name="org.exist.backup.SystemExport" additivity="false" level="trace">
188+
<Logger name="org.exist.backup.SystemExport" additivity="false" level="info">
193189
<AppenderRef ref="elemental.backup"/>
194190
</Logger>
195191

‎exist-distribution/src/main/config/log4j2.xml‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,7 @@
153153
<AppenderRef ref="elemental.core"/>
154154
</Logger>
155155

156-
<Logger name="org.exist.jetty.JettyStart" additivity="false" level="trace">
157-
<AppenderRef ref="STDOUT"/>
158-
<AppenderRef ref="elemental.core"/>
159-
</Logger>
160-
161-
<Logger name="org.exist.jetty.StandaloneServer" additivity="false" level="trace">
156+
<Logger name="org.exist.jetty.JettyStart" additivity="false" level="info">
162157
<AppenderRef ref="STDOUT"/>
163158
<AppenderRef ref="elemental.core"/>
164159
</Logger>
@@ -167,12 +162,12 @@
167162
<AppenderRef ref="elemental.profiling"/>
168163
</Logger>
169164

170-
<Logger name="org.exist.statistics" additivity="false" level="debug">
165+
<Logger name="org.exist.statistics" additivity="false" level="info">
171166
<AppenderRef ref="elemental.core"/>
172167
<AppenderRef ref="elemental.statistics"/>
173168
</Logger>
174169

175-
<Logger name="org.exist.backup.SystemExport" additivity="false" level="trace">
170+
<Logger name="org.exist.backup.SystemExport" additivity="false" level="info">
176171
<AppenderRef ref="elemental.backup"/>
177172
</Logger>
178173

‎extensions/contentextraction/src/test/resources/log4j2.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -176,20 +176,16 @@
176176
<AppenderRef ref="elemental.core"/>
177177
</Logger>
178178

179-
<Logger name="org.exist.jetty.StandaloneServer" additivity="false" level="warn">
180-
<AppenderRef ref="elemental.core"/>
181-
</Logger>
182-
183179
<Logger name="xquery.profiling" additivity="false" level="trace">
184180
<AppenderRef ref="elemental.profiling"/>
185181
</Logger>
186182

187-
<Logger name="org.exist.statistics" additivity="false" level="debug">
183+
<Logger name="org.exist.statistics" additivity="false" level="info">
188184
<AppenderRef ref="elemental.core"/>
189185
<AppenderRef ref="elemental.statistics"/>
190186
</Logger>
191187

192-
<Logger name="org.exist.backup.SystemExport" additivity="false" level="trace">
188+
<Logger name="org.exist.backup.SystemExport" additivity="false" level="info">
193189
<AppenderRef ref="elemental.backup"/>
194190
</Logger>
195191

‎extensions/debuggee/src/test/resources/log4j2.xml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -176,20 +176,16 @@
176176
<AppenderRef ref="elemental.core"/>
177177
</Logger>
178178

179-
<Logger name="org.exist.jetty.StandaloneServer" additivity="false" level="warn">
180-
<AppenderRef ref="elemental.core"/>
181-
</Logger>
182-
183179
<Logger name="xquery.profiling" additivity="false" level="trace">
184180
<AppenderRef ref="elemental.profiling"/>
185181
</Logger>
186182

187-
<Logger name="org.exist.statistics" additivity="false" level="debug">
183+
<Logger name="org.exist.statistics" additivity="false" level="info">
188184
<AppenderRef ref="elemental.core"/>
189185
<AppenderRef ref="elemental.statistics"/>
190186
</Logger>
191187

192-
<Logger name="org.exist.backup.SystemExport" additivity="false" level="trace">
188+
<Logger name="org.exist.backup.SystemExport" additivity="false" level="info">
193189
<AppenderRef ref="elemental.backup"/>
194190
</Logger>
195191

0 commit comments

Comments
 (0)