Eclipse LS logging OFF, CONSOLE, ERROR LOG

Author: BoykoAlex

eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/LoggingTarget.java

@@ -0,0 +1,19 @@
+/*******************************************************************************
+ * Copyright (c) 2026 Broadcom, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Broadcom, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springframework.tooling.ls.eclipse.commons;
+
+public enum LoggingTarget {
+
+	OFF,
+	ERROR_LOG,
+	CONSOLE
+
+}

eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/STS4LanguageServerProcessStreamConnector.java

@@ -37,45 +37,52 @@
 import org.springframework.tooling.ls.eclipse.commons.preferences.LsPreferencesUtil;
 import org.springsource.ide.eclipse.commons.core.util.IOUtil;
 
-import com.google.common.base.Supplier;
-
 public abstract class STS4LanguageServerProcessStreamConnector extends ProcessStreamConnectionProvider {
 
 	private static LanguageServerProcessReaper processReaper = new LanguageServerProcessReaper();
 
 	private static final String LOG_RESOLVE_VM_ARG_PREFIX = "-Xlog:jni+resolve=";
 
-	private Supplier<Console> consoles = null;
-	private String connectorId;
+	private final ServerInfo serverInfo;
 
-	public STS4LanguageServerProcessStreamConnector(ServerInfo server) {
-		this.connectorId = server.bundleId();
-		this.consoles = LanguageServerConsoles.getConsoleFactory(server);
+	public STS4LanguageServerProcessStreamConnector(ServerInfo serverInfo) {
+		this.serverInfo = serverInfo;
 	}
 
 	@Override
 	public void start() throws IOException {
 		super.start();
 
 		Process process = LanguageServerProcessReaper.getProcess(this);
-		processReaper.addProcess(connectorId, process);
+		processReaper.addProcess(serverInfo.bundleId(), process);
+
+		streamLogging();
+	}
 
-		if (consoles!=null) {
-			Console console = consoles.get();
-			if (console!=null) {
+	private void streamLogging() {
+		switch (getLoggingTarget()) {
+		case CONSOLE:
+			Console console = LanguageServerConsoles.getConsoleFactory(serverInfo.label()).get();
+			if (console != null) {
 				forwardTo(getLanguageServerLog(), console.out);
-			} else {
-				new Thread("Consume LS error stream") {
-					@Override
-					public void run() {
-						try {
-							IOUtil.consume(getLanguageServerLog());
-						} catch (IOException e) {
-							// ignore
-						}
-					}
-				}.start();
+				return;
 			}
+			// fall through to NONE case if there is no console created to simply consume the error log.
+		case OFF:
+			new Thread("Consume LS error stream") {
+				@Override
+				public void run() {
+					try {
+						IOUtil.consume(getLanguageServerLog());
+					} catch (IOException e) {
+						// ignore
+					}
+				}
+			}.start();
+			break;
+		case ERROR_LOG:
+			// Otherwise logging to ERROR LOG nothing to do see `getErrorStream()`
+			break;
 		}
 	}
 
@@ -135,10 +142,8 @@ private void fillCommand(List<String> command, List<String> extraVmArgs) {
 
 		LsPreferencesUtil.getServerInfo(getPluginId()).ifPresent(info -> {
 			IPreferenceStore preferenceStore = LanguageServerCommonsActivator.getInstance().getPreferenceStore();
-			if (!preferenceStore.getBoolean(info.preferenceKeyConsoleLog())) {
-			}
 			String pathStr = preferenceStore.getString(info.preferenceKeyFileLog());
-			if (pathStr != null && !pathStr.isBlank()) {
+  			if (pathStr != null && !pathStr.isBlank()) {
 				command.add("-Dlogging.file.name=" + pathStr);
 			}
 			command.add("-Dlogging.level.root=" + preferenceStore.getString(info.preferenceKeyLogLevel()));
@@ -208,9 +213,6 @@ protected static boolean hasVmArgStartingWith(List<String> vmargs, String prefix
 
 	@Override
 	protected ProcessBuilder createProcessBuilder() {
-		if (consoles==null) {
-			return super.createProcessBuilder();
-		}
 		ProcessBuilder builder = new ProcessBuilder(getCommands());
 		builder.directory(new File(getWorkingDirectory()));
 		//Super does this, but we do not:
@@ -223,7 +225,7 @@ private void forwardTo(InputStream is, OutputStream os) {
 			@Override
 			protected IStatus run(IProgressMonitor arg0) {
 				try {
-					pipe(is, os);
+					is.transferTo(os);
 				} catch (IOException e) {
 				}
 				finally {
@@ -236,34 +238,30 @@ protected IStatus run(IProgressMonitor arg0) {
 				return Status.OK_STATUS;
 			}
 
-			void pipe(InputStream input, OutputStream output) throws IOException {
-				try {
-				    byte[] buf = new byte[1024*4];
-				    int n = input.read(buf);
-				    while (n >= 0) {
-				      output.write(buf, 0, n);
-				      n = input.read(buf);
-				    }
-				    output.flush();
-				} finally {
-					input.close();
-				}
-			}
-
 		};
 		consoleJob.setSystem(true);
 		consoleJob.schedule();
 	}
 
 	@Override
 	public InputStream getErrorStream() {
-		return null;
+		return getLoggingTarget() == LoggingTarget.ERROR_LOG ? getLanguageServerLog() : null;
 	}
 
 	private InputStream getLanguageServerLog() {
 		return super.getErrorStream();
 	}
 
+	private LoggingTarget getLoggingTarget() {
+		LanguageServerCommonsActivator plugin = LanguageServerCommonsActivator.getInstance();
+		try {
+			return LoggingTarget.valueOf(plugin.getPreferenceStore().getString(serverInfo.prefernceKeyLogTarget()));
+		} catch (Exception e) {
+			plugin.getLog().error("Cannot determine language srever logging target", e);
+			return LoggingTarget.OFF;
+		}
+	}
+
 	@Override
 	public void stop() {
 		super.stop();

eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/console/LanguageServerConsoles.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018, 2023 Pivotal, Inc.
+ * Copyright (c) 2018, 2026 Pivotal, Inc.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -13,31 +13,26 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import org.springframework.tooling.ls.eclipse.commons.LanguageServerCommonsActivator;
 import org.springframework.tooling.ls.eclipse.commons.console.ConsoleUtil.Console;
-import org.springframework.tooling.ls.eclipse.commons.preferences.LanguageServerConsolePreferenceConstants.ServerInfo;
 
 import com.google.common.base.Supplier;
 
 public class LanguageServerConsoles {
 
 	private static Map<String, Supplier<Console>> managers;
 
-	public static synchronized Supplier<Console> getConsoleFactory(ServerInfo server) {
+	public static synchronized Supplier<Console> getConsoleFactory(String serverLabel) {
 		if (managers==null) {
 			managers = new HashMap<>();
 		}
-		return managers.computeIfAbsent(server.label(), label -> new Supplier<Console>() {
+		return managers.computeIfAbsent(serverLabel, label -> new Supplier<Console>() {
 			ConsoleUtil consoleMgr = new ConsoleUtil(); //one console manager per language server type. This way each has their
 														// own history (which limits number of open consoles per type)
 			int consoleCounter = 0;
 
 			@Override
 			public Console get() {
-				if (isConsoleEnabled(server)) {
-					return consoleMgr.getConsole(server.label()+" Language Server "+consoleCounter());
-				}
-				return null;
+				return consoleMgr.getConsole(serverLabel+" Language Server "+consoleCounter());
 			}
 
 			private synchronized int consoleCounter() {
@@ -46,8 +41,4 @@ private synchronized int consoleCounter() {
 		});
 	}
 
-	private static boolean isConsoleEnabled(ServerInfo server) {
-		return LanguageServerCommonsActivator.getInstance().getPreferenceStore().getBoolean(server.preferenceKeyConsoleLog());
-	}
-
 }

eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/preferences/LanguageServerConsolePreferenceConstants.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018, 2025 Pivotal, Inc.
+ * Copyright (c) 2018, 2026 Pivotal, Inc.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -12,15 +12,13 @@
 
 public class LanguageServerConsolePreferenceConstants {
 
-	public static final boolean ENABLE_BY_DEFAULT = false;
-
 	public static final String PREFIX_BOSH = "bosh";
 	public static final String PREFIX_CF = "cloudfoundry";
 	public static final String PREFIX_CONCOURSE = "concourse";
 	public static final String PREFIX_SPRING_BOOT = "boot-java";
 
+	public static final String SUFFIX_LOG_TARGET = ".log.target";
 	public static final String SUFFIX_LOG_FILE = ".log.file";
-	public static final String SUFFIX_LOG_CONSOLE = ".console.enabled";
 	public static final String SUFFIX_LOG_LEVEL = ".log.level";
 
 
@@ -38,16 +36,16 @@ public class LanguageServerConsolePreferenceConstants {
 
 	public record ServerInfo(String lsPrefix, String label, String bundleId) {
 
-		public String preferenceKeyConsoleLog() {
-			return lsPrefix + SUFFIX_LOG_CONSOLE;
-		}
-
 		public String preferenceKeyFileLog() {
 			return lsPrefix + SUFFIX_LOG_FILE;
 		}
 
 		public String preferenceKeyLogLevel() {
 			return lsPrefix + SUFFIX_LOG_LEVEL;
 		}
+
+		public String prefernceKeyLogTarget() {
+			return lsPrefix + SUFFIX_LOG_TARGET;
+		}
 	}
 }

eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/preferences/LanguageServerPreferencesPage.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018, 2025 Pivotal, Inc.
+ * Copyright (c) 2018, 2026 Pivotal, Inc.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -14,7 +14,6 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 
-import org.eclipse.jface.preference.BooleanFieldEditor;
 import org.eclipse.jface.preference.ComboFieldEditor;
 import org.eclipse.jface.preference.FieldEditorPreferencePage;
 import org.eclipse.jface.preference.FileFieldEditor;
@@ -28,6 +27,7 @@
 import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkbenchPreferencePage;
 import org.springframework.tooling.ls.eclipse.commons.LanguageServerCommonsActivator;
+import org.springframework.tooling.ls.eclipse.commons.LoggingTarget;
 import org.springframework.tooling.ls.eclipse.commons.preferences.LanguageServerConsolePreferenceConstants.ServerInfo;
 
 public class LanguageServerPreferencesPage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {
@@ -38,10 +38,7 @@ static IPreferenceStore getPrefsStoreFromPlugin() {
 
 	@Override
 	public void init(IWorkbench workbench) {
-		setDescription("Log settings for STS Language Servers. "
-				+ "Changes only take effect the next time a Language Server is started.\n"
-				+ "\n"
-				+ "Note: Enabling logging to console disables logging to file!\n");
+		setDescription("Log settings for STS Language Servers. Changes only take effect the next time a Language Server is started.");
 		setPreferenceStore(getPrefsStoreFromPlugin());
 	}
 
@@ -67,6 +64,27 @@ protected void createFieldEditors() {
 			Composite c = new Composite(group, SWT.NONE);
 			c.setLayout(new GridLayout());
 			c.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
+			addField(new ComboFieldEditor(s.preferenceKeyLogLevel(), "Logging Level", new String[][] {
+				{"Error", "error"},
+				{"Warn", "warn"},
+				{"Info", "info"},
+				{"Debug", "debug"},
+				{"Trace", "trace"},
+				{"Off", "off"},
+			}, c));
+
+			c = new Composite(group, SWT.NONE);
+			c.setLayout(new GridLayout());
+			c.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
+			addField(new ComboFieldEditor(s.prefernceKeyLogTarget(), "Logging to IDE", new String[][] {
+				{"Off", LoggingTarget.OFF.toString()},
+				{"Console", LoggingTarget.CONSOLE.toString()},
+				{"Error Log", LoggingTarget.ERROR_LOG.toString()},
+			}, c));
+
+			c = new Composite(group, SWT.NONE);
+			c.setLayout(new GridLayout());
+			c.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
 			addField(new FileFieldEditor(s.preferenceKeyFileLog(), "Logging to File", true, c) {
 
 				@Override
@@ -114,23 +132,6 @@ protected boolean checkState() {
 
 			});
 
-			c = new Composite(group, SWT.NONE);
-			c.setLayout(new GridLayout());
-			c.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
-			addField(new BooleanFieldEditor(s.preferenceKeyConsoleLog(), "Logging to Console", c));
-
-			c = new Composite(group, SWT.NONE);
-			c.setLayout(new GridLayout());
-			c.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
-			addField(new ComboFieldEditor(s.preferenceKeyLogLevel(), "Logging Level", new String[][] {
-				{"Error", "error"},
-				{"Warn", "warn"},
-				{"Info", "info"},
-				{"Debug", "debug"},
-				{"Trace", "trace"},
-				{"Off", "off"},
-			}, c));
-
 		}
 	}
 }

eclipse-language-servers/org.springframework.tooling.ls.eclipse.commons/src/org/springframework/tooling/ls/eclipse/commons/preferences/PrefsInitializer.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018, 2025 Pivotal, Inc.
+ * Copyright (c) 2018, 2026 Pivotal, Inc.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -10,10 +10,9 @@
  *******************************************************************************/
 package org.springframework.tooling.ls.eclipse.commons.preferences;
 
-import static org.springframework.tooling.ls.eclipse.commons.preferences.LanguageServerConsolePreferenceConstants.ENABLE_BY_DEFAULT;
-
 import org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer;
 import org.eclipse.jface.preference.IPreferenceStore;
+import org.springframework.tooling.ls.eclipse.commons.LoggingTarget;
 import org.springframework.tooling.ls.eclipse.commons.preferences.LanguageServerConsolePreferenceConstants.ServerInfo;
 
 public class PrefsInitializer extends AbstractPreferenceInitializer {
@@ -22,8 +21,8 @@ public void initializeDefaultPreferences() {
 		IPreferenceStore store = LanguageServerPreferencesPage.getPrefsStoreFromPlugin();
 		ServerInfo[] installedServers = LsPreferencesUtil.getInstalledLs();
 		for (ServerInfo s : installedServers) {
-			store.setDefault(s.preferenceKeyConsoleLog(), ENABLE_BY_DEFAULT);
 			store.setDefault(s.preferenceKeyLogLevel(), "error");
+			store.setDefault(s.prefernceKeyLogTarget(), LoggingTarget.OFF.toString());
 //			Bundle bundle = Platform.getBundle(s.bundleId);
 //			if (bundle != null) {
 //				IPath stateLocation = Platform.getStateLocation(bundle);