theRAPTLab / gsgo

GEM-STEP Foundation repo migrated from GitLab June 2023
1 stars 1 forks source link

AI Logging - [merged] #714

Closed benloh closed 1 year ago

benloh commented 2 years ago

Merges dev-bl/ai-log -> dev-next

Early prototyping of logging for AI Institute.

Currently this only logs ALL display objects (e.g. the raw JSON being sent across the network to any Viewers and CharControllers).
The display objects contain all of the information necessary for duplicating the visual display of the simulation (e.g. agents, positions, skins, effects).

This does not currently do any other logging of user or simulation events. Other events will be added to this merge request as continue to work on this.


How to Use Logging

Because dumping the display objects can quickly balloon log files to hundreds of megabytes of information, we do not turn the logging on by default.

Currently you can enable and disable logging via a setting in local-settings.json. Add this line to enable logging of display objects:

  ~~"LOG_DISPLAY_OBJECTS": true~~

When set to true, you should find a new log for every time you start the server at: /gsgo/gs_packages/gem-srv/runtime/logs

UPDATE 9/21/22: As of !279 LOG_DISPLAY_OBJECTS is no longer being used.

benloh commented 2 years ago

requested review from @jdanish

benloh commented 2 years ago

@jdanish Please give this a whirl to collect sample display object data logs for the AI guys to review, and to test performance and file size issues.

benloh commented 2 years ago

marked this merge request as ready

benloh commented 2 years ago

Merging for now. Other logging will be done in separate branches.

benloh commented 2 years ago

mentioned in commit 215c77bc184efc67abcc0cea7da5329e93083488