πŸͺ΅Logs

The YSeries phone system includes a comprehensive logging mechanism that tracks and reports various phone activities to Discord webhooks.

Features

  • Discord Integration: Automatic posting to Discord channels via webhooks

  • Batch Processing: Efficient log queuing and batch sending to reduce API calls

  • Multi-App Support: Dedicated logging for different phone apps and features

  • Special Monitoring: Advanced monitoring capabilities for specific activities

  • Customizable Formatting: Rich embed formatting with custom colors and avatars

  • Automatic Cleanup: Built-in queue management and timeout systems

Configuration

Basic Settings

Configure logging in config/config.logs.lua:

Config.Logs = {}
Config.Logs.Timeout = 60 -- Time in seconds before queued logs are sent
Config.Logs.Webhooks = {
    -- Webhook URLs are configured in server.cfg using convars (see below)
}

Webhook Configuration

IMPORTANT: You must configure webhook URLs in your server.cfg file using the following convars:

# YSeries Logging Webhooks - Add these to your server.cfg
set yseriesInstashotsPostsLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesInstashotsMessagesLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesYPostsLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesYMessagesLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesYPayLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesYBuyLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesCompaniesLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesPhoneLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesMessagesLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesDarkChatLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"
set yseriesPromoHubLogs "YOUR_DISCORD_WEBHOOK_URL_HERE"

Setup Steps:

  1. Create Discord Webhooks:

    • Go to your Discord server settings

    • Navigate to Integrations β†’ Webhooks

    • Create webhooks for each channel you want logs in

    • Copy the webhook URLs

  2. Configure server.cfg:

    • Open your server.cfg file

    • Add the convar lines above with your actual webhook URLs

    • Replace "YOUR_DISCORD_WEBHOOK_URL_HERE" with your webhook URLs

  3. Example Configuration:

set yseriesInstashotsPostsLogs "https://discord.com/api/webhooks/1234567890/abcdefghijklmnop"
set yseriesPhoneLogs "https://discord.com/api/webhooks/0987654321/zyxwvutsrqponmlk"
  1. Restart Server: Restart your FiveM server for changes to take effect

Avatar Customization

Set custom avatars for different log types:

Config.Logs.Avatars = {
    ['instashots'] = 'https://example.com/instashots-avatar.png',
    ['y'] = 'https://example.com/y-avatar.png',
    ['ypay'] = 'https://example.com/ypay-avatar.png',
    ['ybuy'] = 'https://example.com/ybuy-avatar.png',
    ['companies'] = 'https://example.com/companies-avatar.png',
    ['phone'] = 'https://example.com/phone-avatar.png',
    ['messages'] = 'https://example.com/messages-avatar.png',
    ['darkchat'] = 'https://example.com/darkchat-avatar.png',
}

Color Configuration

Customize embed colors using hex values:

Config.Logs.Colors = {
    ['instashots'] = 15884387,        -- Light purple
    ['companies'] = 1940464,          -- Dark blue
    ['default'] = 14423100,           -- Light gray
    ['ybuy'] = 15020857,             -- Orange
    ['ypay'] = 431319,               -- Green
    ['y'] = 1940464,                 -- Dark blue
    ['phone'] = 009966,              -- Teal
    ['messages'] = 0x1388d6,         -- Blue
    ['darkchat'] = 0x128b7d,         -- Dark teal
}

Supported Log Types

Social Media Apps

InstaShots

  • Posts: Photo/video uploads and interactions

  • Messages: Direct messages between users

  • Activities: Likes, comments, follows

Y (Twitter-like)

  • Posts: Tweet creation and interactions

  • Messages: Direct messages

  • Activities: Retweets, likes, replies

Communication Apps

Phone Calls

  • Call Logs: Caller/recipient information

  • Anonymous Calls: Special handling for anonymous calls

  • Call Duration: Track call lengths and outcomes

Messages (SMS)

  • Text Messages: Content and participant tracking

  • Group Messages: Multi-participant conversations

  • Media Sharing: Photo and location sharing logs

DarkChat

  • Channel Messages: Encrypted communication tracking

  • Special Monitoring: Advanced surveillance capabilities

  • User Activity: Join/leave events

E-Commerce Apps

YBuy (Marketplace)

  • Listings: Item postings with details

  • Transactions: Purchase tracking

  • Contact Information: Seller/buyer details

YPay (Payment System)

  • Transactions: Payment processing logs

  • Transfer Details: Amount and participant tracking

  • Payment Methods: Card/cash transaction types

Advanced Features

Batch Processing

Logs are automatically batched for efficiency:

  • Queue Size: Sends immediately when 10 logs are queued

  • Timeout: Sends all queued logs after configured timeout (default 60 seconds)

  • Memory Management: Automatic queue cleanup after sending

Security Considerations

Webhook Protection

  1. Secure Storage: Store webhook URLs in server.cfg using convars (as shown above)

  2. Access Control: Restrict access to your server.cfg file - only server administrators should have access

Troubleshooting

Common Issues

  1. Logs not appearing in Discord:

    • Check webhook URLs are correct and active

    • Verify Discord channel permissions

    • Check server console for HTTP errors

  2. Partial log information:

    • Ensure all required fields are provided

    • Check specialized formatter implementations

    • Verify additionalData structure

  3. Rate limiting issues:

    • Increase timeout value to batch more logs

    • Check Discord rate limit responses


Last updated