Skip to main content
FiveMesh Logs collects player, inventory, economy and staff events from a FiveM server into one searchable view. Each server connects to Logs with the FiveMesh SDK and an ingestion key. The dashboard then searches, filters, exports and retains the events that arrive from that server.

​
Prerequisites

Before you connect a server, confirm:
  • The organization is on a plan that includes Logs.
  • The cfx.re server is registered in Account > Servers.
  • You can edit your server’s server.cfg.
  • Someone with permission to create API keys can create a Logs key, or you already have one.

​
Connect a server

1

Select the server

The dashboard sidebar carries the selected server into every service. Open Logs and confirm the server you want to connect.
2

Enable Logs for the server

The first time the organization uses Logs, the page asks the billing owner to enable Logs for the organization. After that, click Enable Logs for this server to create its source.
3

Create an ingestion key

Open Logs > Settings and click Create ingestion key. The key uses the Logs logs:write permission and is only for ingestion.
4

Install the SDK

Download the latest FiveMesh SDK release and place it in your server resources like any other resource.
5

Configure server.cfg

Add the SDK settings with the ingestion key. Use a key that is specific to this server, so the SDK does not need the server ID.
FIVEMESH_SERVER_ID is only required when the ingestion key is global (allowed on every server of the organization), because a server-specific key already names its server.Restart or reload the server with your normal deployment process.
6

Verify ingestion

Open Logs > Explorer. Incoming events appear within a few seconds of server activity.
Treat the ingestion key as a secret. Anyone with it can write events into your Logs workspace, so keep it out of public repositories and client-side code.

​
What the SDK records automatically

With FIVEMESH_LOGS_AUTOMATIC enabled, the SDK captures events from:
  • FiveM server and resource lifecycle
  • baseevents player connections
  • ox_inventory item and money movement
  • txAdmin moderation actions
Resources can also send their own events through the SDK exports. See Server exports.

​
In-game staff viewer

The optional fivemesh-logs resource opens the Explorer inside the game with /fmlogs.
  1. Create a separate read-only key with Create viewer key in Logs > Settings. It uses the logs:read permission.
  2. Download the latest FiveMesh Logs viewer.
  3. Configure the viewer and restrict access to staff groups.
The viewer needs fivemesh-sdk 0.1.5 or newer and a key with logs:read. A key created for this server already names it, so FIVEMESH_SERVER_ID is only required when the viewer key is global (all servers).

​
Direct ingestion

Integrations that do not use the SDK can post atomic event batches directly to the ingestion endpoint shown in Logs > Settings.

​
Next steps