Configuration

Studio SDK

Configuration

GameBench configuration is done either with a JSON configuration file at build time, or through APIs at runtime.

Credentials

url URL of the GameBench server to which session data will be uploaded.

GameBench Cloud users should use https://web.gamebench.net/
Private server users should use their own URL.

user (or email) The email address or LDAP username associated with your GameBench account. We recommend using a dedicated email account to store GameBench sessions.

token API token (a hex string). See the API token documentation for more details.

{                                                     
    "url": "https://web.gamebench.net/",
    "email": "you@yourcompany.com",
    "token": "0123456789ABCDEF0123456789ABCDEF"
} 

Gamebench.SetConfigItem(ConfigItem.UploadUrl, "https://web.gamebench.net/");
Gamebench.SetConfigItem(ConfigItem.UploadEmail, "you@yourcompany.com");
Gamebench.SetConfigItem(ConfigItem.UploadToken, "0123456789ABCDEF0123456789ABCDEF");

getGameBench()->setStringConfigItem("url", "https://web.gamebench.net/");
getGameBench()->setStringConfigItem("user", "you@yourcompany.com");
getGameBench()->setStringConfigItem("token", "0123456789ABCDEF0123456789ABCDEF");

GameBench.setUrl("https://web.gamebench.net/");
GameBench.setUser("you@yourcompany.com");
GameBench.setToken("0123456789ABCDEF0123456789ABCDEF");

Metrics

The SDK collects metric data at configurable intervals expressed in seconds. Each metric has a three-letter identifier. The configurable metric identifiers are:

CPU, GPU, MEM, NET, POW, BAT

NB: Frames per second (FPS) is also a metric but it is not configurable… it is always collected and always at the rate of once per second.

{
    "metrics": {
        "CPU": 1.0,
        "GPU": 1.0,
        "MEM": 1.0,
        "NET": 1.0,
        "POW": 5.0,
        "BAT": 30.0,
    }
} 

Gamebench.SetCaptureInterval(MetricType.CPU, 1.0);
Gamebench.SetCaptureInterval(MetricType.GPU, 1.0);
Gamebench.SetCaptureInterval(MetricType.MEM, 1.0);
Gamebench.SetCaptureInterval(MetricType.NET, 1.0);
Gamebench.SetCaptureInterval(MetricType.POW, 5.0);
Gamebench.SetCaptureInterval(MetricType.BAT, 30.0);

getGameBench()->scheduleCapture(CPU, 1.0);
getGameBench()->scheduleCapture(GPU, 1.0);
getGameBench()->scheduleCapture(MEM, 1.0);
getGameBench()->scheduleCapture(NET, 1.0);
getGameBench()->scheduleCapture(POW, 5.0);
getGameBench()->scheduleCapture(BAT, 30.0);

GameBench.setMetricInterval("CPU", 1.0);
GameBench.setMetricInterval("GPU", 1.0);
GameBench.setMetricInterval("MEM", 1.0);
GameBench.setMetricInterval("NET", 1.0);
GameBench.setMetricInterval("POW", 5.0);
GameBench.setMetricInterval("BAT", 30.0);

Screenshots

For configuration purposes, screenshots are just other types of metrics. Five sizes of screenshot are presently supported, their identifiers are:

    SS0 : Full-size (100%)
    SS1 : ¹⁄₂ size (50%)
    SS2 : ¹⁄₄ size (25%)
    SS3 : ¹⁄₈ size (12.5%)
    SS4 : ¹⁄₁₆ size (6.75%)

In this example a 1/8th size screenshot is scheduled to occur every 2 seconds and a full-size screenshot every 30 seconds:

{
    "metrics": {
        "SS0": 30.0,
        "SS3": 2.0
    }
} 

Gamebench.SetCaptureInterval(MetricType.SS0, 30.0);
Gamebench.SetCaptureInterval(MetricType.SS3, 2.0);

getGameBench()->scheduleCapture(SS0, 30.0);
getGameBench()->scheduleCapture(SS3, 2.0);

GameBench.setMetricInterval("SS0", 30.0);
GameBench.setMetricInterval("SS3", 2.0);

Miscellaneous

autoSession Boolean value controlling whether sessions are automatically recorded while the application is foregrounded.

markSceneChanges Unity-specific boolean value. When set to ’true’, scene changes will be automatically recorded as marker events. Default is ’true'.

verboseLog Boolean value useful for troubleshooting, when set to ’true’ GameBench will write more information to the system log.

tags Tags are an unordered set of comma-delimited key=value string pairs that are useful for identifying sessions or groups of sessions in the Analysis area of the Web Dashboard.

{                                                     
    "autoSession": true,
    "markSceneChanges": true,
    "verboseLog": false,
    "tags": "foo=bar,baz=bat"
} 

Gamebench.SetConfigItem(ConfigItem.AutoSession, true);
Gamebench.SetConfigItem(ConfigItem.MarkSceneChanges, true);
Gamebench.SetConfigItem(ConfigItem.VerboseLogging, false);
Gamebench.SetTag("foo", "bar");
Gamebench.SetTag("baz", "bat");

getGameBench()->setIntConfigItem("autoSession", 1);
getGameBench()->setIntConfigItem("markSceneChanges", 1);
getGameBench()->setIntConfigItem("verboseLog", 0);
getGameBench()->SetTag("foo", "bar");
getGameBench()->SetTag("baz", "bat");

GameBench.setAutoSessionEnabled(true);
GameBench.setMarkSceneChangesEnabled(true);
GameBench.setVerboseLoggingEnabled(false);
GameBench.setTags("foo=bar,baz=bat");

Last updated on April 24, 2024

Metrics Data