Skip to main content
The Fivemanage Logger is configured using a config.json file located in mods/Fivemanage_Logger/config.json.

​
Configuration Structure

The configuration is divided into two main sections: LogProvider and PlayerEvents. 
{
  "LogProvider": {
    "Provider": "fivemanage",
    "ApiKey": "your-fivemanage-api-key",
    "WriteToDisk": false,
    "EnableBatching": true,
    "BufferSize": 10,
    "FlushIntervalMs": 5000
  },
  "PlayerEvents": {
    "Dataset": "player-events",
    "Enabled": true
  }
}

​
Log Provider Options

OptionTypeDescription
ProviderstringThe logging backend to use: fivemanage, grafana-loki, or file.
ApiKeystringYour Fivemanage API key (required for fivemanage provider).
EndpointstringThe Loki push endpoint URL (required for grafana-loki).
UsernamestringBasic auth username for Grafana Loki.
PasswordstringBasic auth password/API key for Grafana Loki.
WriteToDiskbooleanIf true, logs will also be written to local files in the logs directory.
EnableBatchingbooleanWhether to buffer logs before sending them to the provider.
BufferSizeintegerNumber of logs to buffer before flushing (default: 10).
FlushIntervalMsintegerMaximum time (in ms) to wait before flushing the buffer (default: 5000).

​
Provider Specifics

​
Fivemanage Cloud

To use Fivemanage Cloud, set the provider to fivemanage and provide your API key. 
"LogProvider": {
  "Provider": "fivemanage",
  "ApiKey": "YOUR_API_KEY"
}

​
Grafana Loki

To send logs to Grafana Loki or Grafana Cloud, use the grafana-loki provider. 
"LogProvider": {
  "Provider": "grafana-loki",
  "Endpoint": "https://logs-prod-us-central1.grafana.net/loki/api/v1/push",
  "Username": "123456",
  "Password": "your-grafana-api-key"
}

​
Player Events Options

OptionTypeDescription
DatasetstringThe name of the dataset (or label) where player events will be stored.
EnabledbooleanIf true, the plugin will automatically log player connect, ready, and disconnect events.

​
Automatically Tracked Events

When PlayerEvents.Enabled is set to true, the following events are captured:
  • Player Connect: Logged when a player initiates a connection.
  • Player Ready: Logged when a player has fully loaded into the world.
  • Player Disconnect: Logged when a player leaves the server.