🪵 Logs

Overview

The TGG Banking system automatically logs all important banking activities to your database. These logs can be used for auditing, debugging, and tracking player actions. The logging system is built-in and requires no additional configuration - logs are automatically created when banking operations occur.

Features

• Automatic Logging: All banking operations are automatically logged
• Database Storage: Logs are stored in the tgg_banking_logs database table
• Event Integration: Logs trigger server events for external integrations
• Discord Webhook Support: Built-in Discord webhook integration via custom file
• Comprehensive Coverage: Tracks accounts, cards, transactions, and loans
• Player Tracking: All logs include player identifiers and IBANs
• Batch Processing: Logs are queued and sent in batches for efficiency

Configuration

Discord Webhook Setup

The banking system includes a built-in Discord webhook integration. To enable it:

1. Create a Discord Webhook:

   • Go to your Discord server settings
   • Navigate to Integrations → Webhooks
   • Create a new webhook and copy the webhook URL

2. Add the Convar to server.cfg:

   Code
   Copy
   set bankingLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"

3. Restart the Resource:

   bash
   Copy
   restart tgg-banking

Custom Logs Configuration

The logging system uses server/custom/logs.lua for Discord webhook integration. You can customize this file:

Excluding Log Types

To prevent certain log types from being sent to Discord, edit server/custom/logs.lua:

lua
Copy
local excludedLogTypes = {
    'account_member_modified',  -- Exclude member permission changes
    'account_name_updated',     -- Exclude account name updates
    'card_limits_updated',      -- Exclude card limit updates
    'card_name_updated',        -- Exclude card name updates
}

Adjusting Batch Timeout

By default, logs are sent every 10 seconds if the queue hasn't reached 10 logs. To change this:

lua
Copy
local logsTimeout = 10  -- Time in seconds before queued logs are sent

Batch Size

Logs are automatically sent when 10 logs are queued for the same IBAN. This is hardcoded in the file but can be modified:

lua
Copy
if #logQueue[iban] >= 10 then  -- Change 10 to your desired batch size
    -- Send logs...
end

Log Types

The banking system uses predefined log types. Here are all available log types:

Account Operations

Account Members

Transactions

Card Operations

Loan Operations

Savings Accounts

Custom Logs

Server Event Integration

When a log is created, the system automatically triggers a server event that can be used for external integrations (Discord webhooks, logging systems, etc.):

lua
Copy
TriggerEvent('banking:server:logs:create', iban, playerId, logType, logMessage)

Event Parameters

• iban (string): The IBAN of the account related to the log
• playerId (string): The identifier of the player who performed the action
• logType (string): The type of log (from LogType enum)
• logMessage (string): A descriptive message about what happened

Custom Event Handler

If you want to create your own logging system instead of using the built-in server/custom/logs.lua, you can listen to the event:

lua
Copy
AddEventHandler('banking:server:logs:create', function(iban, playerId, logType, logMessage)
    -- Your custom logging logic here
    -- Example: Send to custom webhook or logging service
    local webhook = GetConvar('your_custom_webhook', '')
    if webhook ~= '' then
        PerformHttpRequest(webhook, function(err, text, headers) end, 'POST', json.encode({
            embeds = {{
                title = 'Banking Log',
                description = logMessage,
                fields = {
                    {name = 'IBAN', value = iban, inline = true},
                    {name = 'Player', value = playerId, inline = true},
                    {name = 'Type', value = logType, inline = true}
                },
                color = 3447003,
                timestamp = os.date('!%Y-%m-%dT%H:%M:%SZ')
            }}
        }), {['Content-Type'] = 'application/json'})
    end
end)