Merge pull request #15595 from mjlbach/feat/add-healthcheck-lsp

* feat(lsp): add lsp healthcheck

* feat(lsp): add warning message for large log size 

3 files changed, 48 insertions, 0 deletions

diff --git a/runtime/autoload/health/lsp.vim b/runtime/autoload/health/lsp.vim
new file mode 100644
index 0000000000..2d2ba91cdf
--- /dev/null
+++ b/runtime/autoload/health/lsp.vim
@@ -0,0 +1,5 @@
+function! health#lsp#check() abort
+  call health#report_start('Checking language server client configuration')
+  lua require 'vim.lsp.health'.check_health()
+endfunction
+
diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
new file mode 100644
index 0000000000..855679a2df
--- /dev/null
+++ b/runtime/lua/vim/lsp/health.lua
@@ -0,0 +1,27 @@
+local M = {}
+
+--- Performs a healthcheck for LSP
+function M.check_health()
+  local report_info = vim.fn['health#report_info']
+  local report_warn = vim.fn['health#report_warn']
+
+  local log = require('vim.lsp.log')
+  local current_log_level = log.get_level()
+  local log_level_string = log.levels[current_log_level]
+  report_info(string.format("LSP log level : %s", log_level_string))
+
+  if current_log_level < log.levels.WARN then
+    report_warn(string.format("Log level %s will cause degraded performance and high disk usage", log_level_string))
+  end
+
+  local log_path = vim.lsp.get_log_path()
+  report_info(string.format("Log path: %s", log_path))
+
+  local log_size = vim.loop.fs_stat(log_path).size
+
+  local report_fn = (log_size / 1000000 > 100 and report_warn or report_info)
+  report_fn(string.format("Log size: %d KB", log_size / 1000 ))
+end
+
+return M
+
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index a2d5c3a774..2a2133156a 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -32,6 +32,17 @@ do
 
   vim.fn.mkdir(vim.fn.stdpath('cache'), "p")
   local logfile = assert(io.open(logfilename, "a+"))
+
+	local log_info = vim.loop.fs_stat(logfilename)
+	if log_info and log_info.size > 1e9 then
+		local warn_msg = string.format(
+			"LSP client log is large (%d MB): %s",
+			log_info.size / (1000 * 1000),
+			logfilename
+		)
+		vim.notify(warn_msg)
+	end
+
   -- Start message for logging
   logfile:write(string.format("[ START ] %s ] LSP logging initiated\n", os.date(log_date_format)))
   for level, levelnr in pairs(log.levels) do
@@ -88,6 +99,11 @@ function log.set_level(level)
   end
 end
 
+--- Gets the current log level.
+function log.get_level()
+  return current_log_level
+end
+
 --- Checks whether the level is sufficient for logging.
 ---@param level number log level
 ---@returns (bool) true if would log, false if not