From 7f14eef82bf5ccecfbb228c906334778b905d3fc Mon Sep 17 00:00:00 2001 From: MrNewb <47620135+MrNewb@users.noreply.github.com> Date: Mon, 1 Sep 2025 02:29:15 -0400 Subject: [PATCH] Refactor logging system and centralize config Reworked the logging system to use a unified handler approach supporting built-in, qb, ox_lib, and Fivemerr log systems. Deprecated Logs.Send and Logs.Notify in favor of Logs.CreateLog. Centralized all logging configuration options in serverConfig.lua for easier management and extensibility. --- lib/logs/server/logs.lua | 158 ++++++++++++++------------------------ settings/serverConfig.lua | 7 +- 2 files changed, 62 insertions(+), 103 deletions(-) diff --git a/lib/logs/server/logs.lua b/lib/logs/server/logs.lua index 5fc0cec..650778a 100644 --- a/lib/logs/server/logs.lua +++ b/lib/logs/server/logs.lua @@ -1,115 +1,71 @@ Logs = Logs or {} +local BridgeServerConfig = BridgeServerConfig or Require("settings/serverConfig.lua") -local WebhookURL = "" -- Add webhook URL here if using built-in logging system -local LogoForEmbed = "https://cdn.discordapp.com/avatars/299410129982455808/31ce635662206e8bd0132c34ce9ce683?size=1024" -local LogSystem = "built-in" -- Default log system, can be "built-in", "qb", or "ox_lib" +local logHandlers = { + fivemerr = function(logData) + local fivemerrData = { + level = "info", + message = tostring(logData), + resource = GetInvokingResource() or GetCurrentResourceName(), + } + PerformHttpRequest("https://api.fivemerr.com/v1/logs", function(code, text, headers) + if code ~= 200 then + print(("Failed to send log to Fivemerr API (HTTP %d): Please verify your API key is correct and the service is available."):format(code)) + else + print("Log successfully sent to Fivemerr") + end + end, 'POST', json.encode(fivemerrData), { + ['Content-Type'] = 'application/json', + ['Authorization'] = BridgeServerConfig.FivemerrApiKey + }) + end, ----This will send a log to the configured webhook or log system. ----@param src number ----@param message string ----@return nil -Logs.Send = function(src, message) - if not src or not message then return end - local logType = LogSystem or "built-in" - if logType == "built-in" then - PerformHttpRequest(WebhookURL, function(err, text, headers) end, 'POST', json.encode( - { + qb = function(message) + TriggerEvent('qb-log:server:CreateLog', GetCurrentResourceName(), GetInvokingResource(), 'green', message, false) + end, + + ox_lib = function(message) + lib.logger(GetInvokingResource(), GetCurrentResourceName(), message) + end, + + ["built-in"] = function(message) + PerformHttpRequest(BridgeServerConfig.WebhookURL, function(err, text, headers) end, 'POST', json.encode({ username = "Community_Bridge's Logger", avatar_url = 'https://avatars.githubusercontent.com/u/192999457?s=400&u=da632e8f64c85def390cfd1a73c3b664d6882b38&v=4', - embeds = { - { - color = "15769093", - title = GetCurrentResourceName(), - url = 'https://discord.gg/Gm6rYEXUsn', - thumbnail = { url = LogoForEmbed }, - fields = { - { - name = '**Player ID**', - value = src, - inline = true, - }, - { - name = '**Player Identifier**', - value = Framework.GetPlayerIdentifier(src), - inline = true, - }, - { - name = 'Log Message', - value = "```"..message.."```", - inline = false, - }, - }, - timestamp = os.date('!%Y-%m-%dT%H:%M:%S'), - footer = { - text = "Community_Bridge | ", - icon_url = 'https://avatars.githubusercontent.com/u/192999457?s=400&u=da632e8f64c85def390cfd1a73c3b664d6882b38&v=4', - }, - } - } - }), { ['Content-Type']= 'application/json' }) - elseif logType == "qb" then - return TriggerEvent('qb-log:server:CreateLog', GetCurrentResourceName(), GetCurrentResourceName(), 'green', message) - elseif logType == "ox_lib" then - return lib.logger(src, GetCurrentResourceName(), message) + embeds = { { + color = "15769093", + title = GetInvokingResource(), + thumbnail = { url = BridgeServerConfig.EmbedLogo }, + fields = { + { + name = 'Log Message', + value = "```" .. message .. "```", + inline = false, + } + }, + timestamp = os.date('!%Y-%m-%dT%H:%M:%S'), + } } + }), { ['Content-Type'] = 'application/json' }) end +} + +---@deprecated Use Logs.CreateLog instead (deprecated 9/1/25) +Logs.Send = function(src, message) + print("^1Deprecated^0 function 'Logs.Send' called. Please use 'Logs.CreateLog' instead.") + Logs.CreateLog(message) end -local embeds = {} +---@deprecated Use Logs.CreateLog instead (deprecated 9/1/25) Logs.Notify = function(src, url, image, message) - if not src or not message then return end - local logType = LogSystem or "built-in" - if logType == "built-in" then - embeds[url] = embeds[url] or {} - local embed = embeds[url].embed or {} - local firstName, lastName = Framework.GetPlayerName(src) - - table.insert(embed, { - color = "15769093", - title = GetInvokingResource(), - -- url = 'https://discord.gg/Gm6rYEXUsn', - thumbnail = { url = LogoForEmbed }, - fields = { - { - name = '**Player ID**', - value = src, - inline = true, - }, - { - name = '**Player Identifier**', - value = Framework.GetPlayerIdentifier(src), - inline = true, - }, - { - name = 'Log Message', - value = "```"..message.."```", - inline = false, - }, - }, - timestamp = os.date('!%Y-%m-%dT%H:%M:%S'), - footer = { - text = "Community_Bridge | ", - icon_url = 'https://avatars.githubusercontent.com/u/192999457?s=400&u=da632e8f64c85def390cfd1a73c3b664d6882b38&v=4', - }, - }) - embeds[url].embed = embed - if embeds[url].inProgress then return end - embeds[url].inProgress = true - SetTimeout(5000, function() - PerformHttpRequest(url, function(err, text, headers) end, 'POST', json.encode({ - username = string.format("%s %s", firstName, lastName), - avatar_url = image or 'https://avatars.githubusercontent.com/u/192999457?s=400&u=da632e8f64c85def390cfd1a73c3b664d6882b38&v=4', - embeds = embeds[url].embed - }), { ['Content-Type']= 'application/json' }) - embeds[url].inProgress = false - end) - elseif logType == "qb" then - return TriggerEvent('qb-log:server:CreateLog', GetCurrentResourceName(), GetCurrentResourceName(), 'green', message) - elseif logType == "ox_lib" then - return lib.logger(src, GetCurrentResourceName(), message) - end + print("^1Deprecated^0 function 'Logs.Notify' called. Please use 'Logs.CreateLog' instead.") + Logs.CreateLog(message) end +Logs.CreateLog = function(logData) + local handler = logHandlers[BridgeServerConfig.LogSystem] + if handler then handler(logData) end +end exports('Logs', Logs) -return Logs +return Logs \ No newline at end of file diff --git a/settings/serverConfig.lua b/settings/serverConfig.lua index 742dd26..ebde8e6 100644 --- a/settings/serverConfig.lua +++ b/settings/serverConfig.lua @@ -1,4 +1,7 @@ BridgeServerConfig = {} BridgeServerConfig.MaxInventorySlots = 50 - -return BridgeServerConfig +BridgeServerConfig.LogSystem = "built-in" -- can be "none", "built-in", "qb", "fivemerr" or "ox_lib" +BridgeServerConfig.WebhookURL = "" -- Add webhook URL here if using built-in logging system +BridgeServerConfig.FivemerrApiKey = "" -- Add Fivemerr API key here if using fiveMerr +BridgeServerConfig.EmbedLogo = "https://cdn.discordapp.com/avatars/299410129982455808/31ce635662206e8bd0132c34ce9ce683?size=1024" +return BridgeServerConfig \ No newline at end of file