FiveOps logoBetaHome

FiveM Connector

The FiveM connector is the fiveops_connector resource. It runs inside FXServer and connects a FiveM server to FiveOps.

What It Does

The connector can:

  • Verify server ownership.
  • Send heartbeats.
  • Report current players and identifiers.
  • Sync server resources.
  • Claim resource start/stop/restart actions.
  • Send resource telemetry and health events.
  • Capture resource ms samples through the Cfx profiler.
  • Sync offline identities through oxmysql.
  • Upload economy snapshots.
  • Auto-update connector files.

Install

Copy fiveops_connector into the server resources folder.

Example:

server-data/resources/[standalone]/fiveops_connector

Edit:

fiveops_connector/config.lua

Set:

Config.CommunityId = 'your-community-id'
Config.ApiBaseUrl = 'https://five-ops.vercel.app'
Config.CfxJoinUrl = 'https://cfx.re/join/abc123'

server.cfg

Add the connector token and ensure the resource:

set fiveops_token "paste-generated-token-here"

add_ace resource.fiveops_connector command.profiler allow
add_ace resource.fiveops_connector command.record allow
add_ace resource.fiveops_connector command.saveJSON allow
add_ace resource.fiveops_connector command.view allow

ensure fiveops_connector

If the folder name changes, update the ACE resource name.

Console Commands

Run these from the FXServer console:

fiveops_ping
fiveops_sync_resources
fiveops_sync_identities
fiveops_sync_economy
fiveops_clear_profiler
fiveops_update_connector

Key Config Options

Config.HeartbeatInterval = 60
Config.MaxInFlightRequestMs = 120000
Config.ResourceSync = true
Config.ResourceSyncInterval = 30
Config.Telemetry = true
Config.TelemetryInterval = 30
Config.HitchSampleInterval = 1000
Config.HitchWarningThresholdMs = 2500

Profiler Telemetry

Resource ms telemetry uses Cfx profiler captures.

Config.ResourceProfiler = true
Config.ResourceProfilerInterval = 600
Config.ResourceProfilerFrames = 1000
Config.ResourceProfilerInitialDelay = 45
Config.ResourceProfilerSaveWaitMs = 70000
Config.ResourceProfilerFile = 'fiveops-profiler.json'
Config.ResourceProfilerEndpointUrl = 'http://127.0.0.1:30120/profileData.json'
Config.ResourceProfilerDeleteAfterUpload = true
Config.ResourceProfilerResetBeforeCapture = true
Config.ResourceProfilerMaxFileKb = 8192

Database Sync

Database sync uses oxmysql and should be enabled only after the database connection is healthy.

Config.DatabaseSync = true
Config.OfflineIdentitySync = false
Config.EconomySync = true

Auto-Update

Run this command to download the latest hosted connector files:

fiveops_update_connector

The updater skips config.lua and asks you to restart the resource.