Profiler

The Server profiler is an essential tool for identifying performance bottlenecks in your server. It provides detailed insights into script execution times, resource usage, and thread performance, helping you optimize your server's performance.

Prerequisites

Before using the profiler:

• Ensure your client is up to date
• Use the latest server artifacts
• Have Google Chrome installed (required for viewing profiles)
• Keep your game/server running while viewing profiles
• Have sufficient permissions to access the console

Using the Profiler

Basic Commands

Recording a Profile

1. Start Recording

   # Record 500 frames (recommended starting point)
   profiler record 500
    
   # For longer analysis
   profiler record 1000
    
   # For specific resource
   profiler record resource_name 500

2. Monitor Progress

   profiler status

   Output example:

   Recording: true
   Frames captured: 250/500
   Current resource: es_extended

3. Save the Profile

profiler saveJSON server_profile.json

Viewing Profiles

Client-Side Viewing

1. Open the console (F8)
2. Run profiler view
3. Chrome will automatically open with the profile

Server-Side Viewing

1. Save the profile:

   profiler saveJSON server_profile.json

2. Transfer the file to your local machine
3. Open Chrome DevTools (Ctrl+Shift+I)
4. Go to the Performance tab
5. Right-click → Load profile
6. Select your saved JSON file

Analyzing Profiles

Understanding the Interface

The profile view consists of several key components:

1. Timeline Overview

   • Top: Recording timestamp
   • Green line: FPS graph
   • Yellow line: CPU time graph
   • Red markers: Frame drops

2. Resource Breakdown

   • Resource name
   • Execution time (ms)
   • File and line numbers
   • Thread information

Identifying Issues

Server Hitches

• Look for sudden spikes in the CPU time graph
• Example: A spike from 5ms to 50ms indicates a potential hitch
• Common causes:
  • Heavy database operations
  • Unoptimized loops
  • Resource conflicts

Frame Drops

• Check the FPS graph for significant dips
• Normal FPS should be stable (60 FPS)
• Dips below 30 FPS indicate performance issues

Resource Bottlenecks

• Hover over resource tick events to see:

  Resource: es_extended
  File: client/main.lua
  Lines: 150-155
  Time: 45ms
  Thread: main

Practical Examples

Example 1: Database Query Optimization

-- Before optimization
profiler record 500
-- Profile shows 100ms execution time for database query
 
-- After optimization with caching
local userCache = {}
local function getUsers()
    if not userCache.lastUpdate or (GetGameTimer() - userCache.lastUpdate) > 60000 then
        MySQL.Async.fetchAll('SELECT * FROM users', {}, function(result)
            userCache.data = result
            userCache.lastUpdate = GetGameTimer()
        end)
    end
    return userCache.data
end
 
-- Profile shows 5ms execution time after optimization

Example 2: Event Handler with Rate Limiting

-- Before optimization
profiler record 500
-- Profile shows frequent spikes in CPU time
 
-- After optimization with rate limiting
local lastCall = 0
RegisterNetEvent('event:name')
AddEventHandler('event:name', function()
    local currentTime = GetGameTimer()
    if currentTime - lastCall > 1000 then
        lastCall = currentTime
        -- Process event
    end
end)
 
-- Profile shows more stable CPU usage

Best Practices

Recording Strategy

• Start with 500 frames for initial analysis
• Increase to 1000+ frames for detailed profiling
• Record during peak server load
• Save multiple profiles for comparison

Analysis Tips

1. Focus Areas

   • Sudden CPU time spikes
   • Consistent frame drops
   • Resource-intensive operations
   • Thread conflicts

2. Common Patterns

   • Regular spikes might indicate scheduled tasks
   • Random spikes often point to event handling
   • Consistent high CPU time suggests optimization needed

3. Optimization Priorities

   • Address the highest CPU time operations first
   • Focus on frequently called functions
   • Check for resource conflicts
   • Review event handling efficiency

Troubleshooting

1. Incomplete Profiles

   • Increase frame count
   • Check server stability
   • Verify recording duration

2. Performance Impact

   • Reduce frame count
   • Profile during off-peak hours
   • Use separate test server

Advanced Usage

Resource-Specific Profiling

# Profile specific resource
profiler record es_extended 500
 
# Profile multiple resources
profiler record es_extended,ox_inventory 500

Custom Time Windows

# Profile for specific duration (in seconds)
profiler record time 30

Additional Resources

• FiveM Profiler Documentation
• FiveM Performance Guide
• FiveM Forums
• FiveM Discord