Error Tracking API Reference

Complete API documentation for the Error Tracking feature across all supported engines.

Overview

All SDKs communicate with the Shard Launcher via HTTP POST to report errors. The API is consistent across engines with language-appropriate naming conventions.

Endpoint

POST http://localhost:9876/api/monitor/report

Payload

{
  "message": "Connection to server failed",
  "stackTrace": "at GameManager.Connect() line 42\nat Main.Start() line 15",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Report Error

Report an error to the Shard Launcher.

# Godot 4.x - Message only
ShardSDK.monitor.report_error("Connection failed")
 
# With stack trace
ShardSDK.monitor.report_error("Null reference error", stack_trace_string)

Parameter	Type	Description
`message`	String	Error message
`stack_trace`	String	Stack trace (optional)

// Unity - Message only
ShardSDK.Monitor.ReportError("Connection failed");
 
// With stack trace
ShardSDK.Monitor.ReportError("Null reference error", ex.StackTrace);

Parameter	Type	Description
`message`	string	Error message
`stackTrace`	string	Stack trace (optional)

// MonoGame - Message only
ShardSDK.Monitor.ReportError("Connection failed");
 
// With stack trace
ShardSDK.Monitor.ReportError("Null reference error", ex.StackTrace);

Parameter	Type	Description
`message`	string	Error message
`stackTrace`	string	Stack trace (optional)

// GameMaker - Message only
shard_monitor_report("Connection failed");

// With stack trace
shard_monitor_report("Collision error", "obj_player Step event");

Parameter	Type	Description
`message`	string	Error message
`stack_trace`	string	Stack trace (optional)

// RPG Maker MV/MZ - Message only
ShardSDK.Monitor.reportError("Connection failed");
 
// With stack trace
ShardSDK.Monitor.reportError("Null reference error", e.stack);

Parameter	Type	Description
`message`	string	Error message
`stackTrace`	string	Stack trace (optional)

Configuration

All SDKs support the same configuration options:

Setting	Default	Description
`launcher_url`	`http://localhost:9876`	Shard Launcher URL
`enable_monitor`	`true`	Enable/disable error reporting

Configure in Project Settings under shard_sdk/:

# Or programmatically
ShardSDK.launcher_url = "http://localhost:9876"
ShardSDK.enable_monitor = true

var config = new ShardConfig
{
    LauncherUrl = "http://localhost:9876",
    EnableMonitor = true
};
ShardSDK.Initialize(config);

var config = new ShardConfig
{
    LauncherUrl = "http://localhost:9876",
    EnableMonitor = true
};
ShardSDK.Initialize(config);

shard_init({
    launcher_url: "http://localhost:9876",
    enable_monitor: true
});

Configure via Plugin Manager parameters or:

// Not typically needed - uses defaults

Error Handling

All SDKs use fire-and-forget HTTP requests with silent failure:

If the Shard Launcher is not running, calls silently fail
No exceptions are thrown to your game code
Network timeouts are handled automatically (5 second timeout)

Your game continues running normally even if the launcher is unavailable.

Engine-Specific Documentation

For detailed setup instructions, see your engine’s documentation: