Full AI Logging - [merged]

[benloh]

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

Branch: dev-bl/log-ui

This is a prototype implementation of the logging system for researcher and AI processing purposes. The goal is to provide a baseline example of logging data to determine if this is sufficient. We expect to iterate on this to refine the reporting.

OVERVIEW

There are two different logs representing two different time scales of data:

1. Human-Readable Log

   • Events are logged in human-friendly English phrases
   • The time scale of events occur usually in seconds
   • Data is stored as key value pairs when needed
   • This log is intended to be opened in Excel

2. Real Time Log

   • Events are logged in terse code fragments optimized for file size and speed
   • The time scale of events occurs in milliseconds, generally about 30fps corresponding to the speed of the simulation
   • Data might be stored as JSON and would require extra parsing to be viewable
   • This log is not intended to be opened in Excel

Log files are stored in gsgo/gs_packages/gem-srv/runtime/logs

All log lines contain:

• timestamp (with milliseconds)
• UADDR -- Unique device address. Each device will have a unique UADDR value. Opening a second browser on a computer/laptop/phone will create a new UADDR. Each browser page reload will also create a new UADDR.

More details below.

Human-Readable Log

The human readable log will log the following events:

DEVICE

• joined network

PROJECT

• Create New Project
• Open Project
• Open SimViewer
• Open CharController

PROJECT SETUP: ProjSetup

• Select Setup
• Select Save
• Project Settings Edit
• Project Settings Save
• Edit Round Script
• Save Round Script
• New Blueprint <bpName>
• Add Character
• Edit Blueprint <bpName>
• Edit Instance InitScript
• Save Instance InitScript
• Drag <name> <x> <y>
• Click Character <name> <x> <y>

INSPECT: Inspect

• Show Inspector <name>
• Hide Inspector <name>

RUN SIM: SimEvent

• Prep Round
• Pick Characters
• Start Round
• Stop Round
• Reset Stage

SCRIPT EDIT: ScriptEdit

• Save to Server
• Save Slot <linetext>
• Cancel Save Slot
• Delete Slot <linetext>
• Select Choice <symbol>

SESSION: Session

• Viewer Connect
• CharController Connect

CHARCONTROL: CharCtrl

• CharController Set Number of Entities <num>
• CharController Select Character <bpName>
• Drag <bpName> <entity-id> <x> <y>

Realtime Log

The realtime log will log the following events:

DISPLAYLIST

• DISPLAYLIST <displayListJSON>

POZYX: pz (in RTLog)

• pz id <id> bpid <bpid> x <x> y <y>

PTRACK: pt (in RTLog)

• pt id <id> bpid <bpid> x <x> y <y>

---

Testing

1. git fetch && git checkout dev-bl/log-ui
2. npm run build && npm run gem -- NOTE there are server changes, so a build is necessary.
3. Load a project that uses pozyx tags. Logs are NOT enabled by default.
4. Click the "Log" checkbox in the navbar to turn on logging -- verify that logging has started by reviewing the log files.
5. Uncheck the "Log" checkbox to stop logging -- verify that logging has stopped.

Verify RealTime Logging

• [ ] Check the -rtlog-.txt file to make sure you see DISPLAYLIST entries with JSON data.
• [ ] Move a pozyx tag around. Make sure you can see it on screen. Check the *-rtlog-*.txt file to make sure you see pz entries.

Verify Normal Logging

• [ ] Go through each of the events in the "Human-Readable Log" above, trigger the event, and verify that it is displayed in the *-log-*.txt file.

---

SETUP

Delimiter: Tab

Currently the delimiter is set to be a tab. You can change this in server-logger.js line 29 with the LOG_DELIMITER constant.

---

TO DO

• [x] DisplayList logging does not pay attention to the "Log" checkbox
• [x] Since "Log" is enabled on an opened project page, always log project opening

[benloh]

requested review from @jdanish

[benloh]

@jdanish I'm still refining a few things, but this is ready for general testing.

[benloh]

added 2 commits

• ae6aab31 - log-ui: Always log CLIENT_LOG events regardless of whether logging is on or...
• 88cb8176 - log-ui: DisplayList log now responds to Main "Log" checkbox.

Compare with previous version

[benloh]

marked the checklist item Since "Log" is enabled on an opened project page, always log project opening as completed

[benloh]

marked the checklist item DisplayList logging does not pay attention to the "Log" checkbox as completed

[benloh]

marked this merge request as ready

[benloh]

@jdanish Alright, all basic logging should be in place.

[benloh]

added 2 commits

• 8815ab96 - log-ui: CharController logging enabled now matches Main's.
• 74d44797 - log-ui: CharController drag now only tries to log `entity` drags. Ignores...

Compare with previous version

[benloh]

mentioned in commit dd18b5672bae345aadbd6ae8dad022a3b52097f9