Documentation

Support

Multiplay Hosting

Multiplay Hosting

Configure core dumps

Learn how to enable core dumps to help diagnose server crashes.
Read time 2 minutesLast updated 3 days ago
Enable crash debugging and analysis using Multiplay Hosting core dumps and Google Cloud Storage. A core dump is a debugging file that contains a process's address space (memory) when it terminates unexpectedly. This file provides a snapshot of what happened when a process crashed. To generate core dumps for your game server, you must configure the feature at the fleet level to specify where to store the core dump file.

Core dump archive contents

When a crash occurs, Multiplay Hosting saves a core dump as an archive to your configured Google Cloud Storage (GCS) bucket. This archive provides a comprehensive snapshot of the server's state and contains the following files:
  • Core dump file: The raw memory dump of the process when it terminated.
  • stdout
    log: The standard output log from your game server process.
  • stderr
    log: The standard error log from your game server process.
  • metadata.json
    : A file containing key details about the server instance and crash event.
The 
metadata.json
file helps identify and debug the crash. This file's structure is as follows: 
{    "PID": $$PID$$,    "Started": "$$Started$$",    "ServerID": $$ServerID$$,    "ProfileID": $$ProfileID$$,    "AccountServiceID": $$AccountServiceID$$,    "GameID": $$GameID$$,    "ModID": $$ModID$$,    "Name": "$$Name$$",    "IP": "$$IP$$",    "GameVersionIdentifier": "$$GameVersionIdentifier$$",    "MaxDown": $$MaxDown$$,    "MemBase": $$MemBase$$,    "CPUBase": $$CPUBase$$,    "DumpMemory": true,    "DumpCPU": true,    "DumpQuery": true,    "QueryType": "sqp"}

Prerequisites

To configure core dumps for your game server, you must have an existing Google Cloud Storage (GCS) bucket. Refer to Create buckets (Google) for more information.

Unity Dashboard configuration

To configure core dumps:
  1. In the Unity Dashboard, open Multiplay Hosting.
  2. Select Fleets.
  3. Select the fleet for which you want to configure core dumps.
  4. Select Core Dump Storage.
  5. Select Configure core dump storage.
  6. In the Configure core dump storage dialog:
    1. Set Storage service to Google Cloud.
    2. Write the bucket name exactly as it appears in your GCS account.
    3. Add the service account client ID.
    4. Add the service account private key.
  7. Select Finish.
If this fleet causes your game server to crash, the core dump file appears in this GCS bucket.