Audit Log Guide¶
The web.alive audit logs function to log important events within an environment and are intended for consumption by other computer programs (e.g. analytics). Audit logs are only created on the server. These logs follow the W3C logging standard and have the following fields:
- Date (UTC)
- Time (UTC)
- Client IP Address
- Client User Name - this is name of the user on their avatar.
- Client User Id – The Id of the user if authenticated.
- Client Session Id – The Identifier of the user’s session.
- Method – Indication of what happened (e.g. LOGIN, ENTER, etc.).
- Subject (URI) – Indication of what object the method happened to. Can be an unreal object identifier or something more useful if the content developer has provided a better identifier. Depending on the log being generated, it can be something more applicable too.
- Status – an HTTP code for success, failure, etc.
- Coords – 3-D co-ordinates in Unreal space (x.y.z).
- Comment – log message.
The file name for Audit logs is always Audit_<timestamp>.log. These files are never deleted by the server as only the server admin can determine when they are no longer applicable. The table below lists the various audit log entries that may be encountered in the audit log file.
| Method | Status | Subject | Description |
| CREATE_SESSION | 200 | - | Session was created. |
| LOGIN | 200 | - | Login Successful |
| LOGIN | 401 | - | Login Failed |
| LOGIN | 403 | - | Login Failed - Banned Client IP Address |
| LOGIN | 503 | - | Login Failed - Maximum session limit reached |
| LOGOUT | 200 | - | User logged out |
| USER_COUNT | 200 | - | Indicates current user count in message. |
| SERVER_FULL_ADMIN | 200 | - | Server max session limit hit and admin user buffer exhausted |
| SERVER_FULL | 200 | - | Server max session limit hit |
| ECHOTEST | 200 | User Session ID | User passed echo test. |
| ECHOTEST | 406 | User Session ID | User failed echo test. |
| PLAYDEVICE | 200 | User Session ID | Indicates the play device being used by a particular user. |
| RECORDDEVICE | 200 | User Session ID | Indicates the record device being used by a particular user. |
| IDLEKICK | 200 | User Session ID | A user was kicked for being idle too long. |
| USERIDLE | 200 | User Session ID | Indicates a user is now considered idle. |
| USERAWAY | 200 | User Session ID | Indicates a user has marked themselves away. |
| USERACTIVE | 200 | User Session ID | Indicates a user is now considered active. |
| INITAVATAR | 200 | Avatar Description String | Avatar was successfully initialized. |
| CHANGEDAVATAR | 200 | Avatar Description String | Avatar was changed by the user. |
| CHANGE_NAME | 200 | - | User name was successfully changed. |
| CHANGE_NAME | 403 | - | User name change was denied. |
| CHANGE_IMAGE | 200 | - | User badge image was successfully changed. |
| CHANGE_IMAGE | 403 | - | User badge image change was denied. |
| ENTER | 200 | Area ID | User entered a particular area. |
| EXIT | 200 | Area ID | User exited a particular area. (Log disabled by default) |
| TELEPORTTOUSER | 200 | User Session ID | Successfully teleported to a user. |
| TELEPORTTOUSER | 406 | User Session ID | Failed to teleport to user. |
| TELEPORTTOLOCATION | 200 | Location ID | Successfully teleported to a location. |
| TELEPORTTOLOCATION | 406 | Location ID | Failed to teleport to a location. |
| TRIGGERED | 200 | Object ID | A user has triggered a particular object by clicking on it. |
| TRIGGER | 200 | Object ID | A user has triggered a particular object. |
| UNTRIGGER | 200 | Object ID | A user has untriggered a particular object. (Log disabled by default) |
| STARE | 200 | Object ID | A user has stared at a particular object. |
| UNSTARE | 200 | Object ID | A user has stopped staring at a particular object. (Log disabled by default) |
| ADMINMUTE | 200 | User Session ID | Indicates that an administrator muted a user. |
| ADMINMUTED | 200 | User Session ID | Indicates that a user was successfully admin muted. |
| ADMINUNMUTE | 200 | User Session ID | Indicates that an administrator unmuted a user. |
| ADMINUNMUTED | 200 | User Session ID | Indicates that a user was successfully admin unmuted. |
| STARTECHOTEST | 200 | User Session ID | Echo test initialized by an administrator on a particular user. |
| RESETAVATAR | 200 | User Session ID | Avatar has been reset by an administrator. |
| RESETNAME | 200 | User Session ID | Avatar display name reset by an administrator. |
| RESETIMAGE | 200 | User Session ID | Avatar badge image reset by an administrator. |
| KICK_FROMROOM | 200 | User Session ID | Indicates that a presenter successfully kicked a user from a room. |
| KICKED_FROMROOM | 200 | User Session ID | Indicates that a user was kicked from a room. |
| KICK_USER | 200 | User Session ID | Indicates that an admin successfully kicked a user. |
| KICKED | 200 | User Session ID | Indicates that a user was kicked. |
| BANPERM | 200 | User Session ID | Indicates that an administrator has permanently banned a user. |
| PERMBANNED | 200 | User Session ID | Indicates that a user was successfully permanently banned. |
| BANSESSION | 200 | User Session ID | Indicates that an administrator has session banned a user. |
| SESSIONBANNED | 200 | User Session ID | Indicates that a user was successfully session banned. |
| ADD_GROUP | 200 | User Session ID | Indicates that an administrator added a user to a group. |
| GROUP_ADDED | 200 | User Session ID | Indicates that a user was successfully added to a group. |
| REMOVE_GROUP | 200 | User Session ID | Indicates that an administrator removed a user from a group. |
| GROUP_REMOVED | 200 | User Session ID | Indicates that a user was successfully removed from a group. |
| GLOBAL_TEXTCHAT | 200 | - | A global textchat message was sent. The comments include the sender and the message length. |
| PROXIMITY_TEXTCHAT | 200 | Receiver Session ID | A proximity textchat message was sent. The comments include the sender, the receiver and the message length. One log for each receiver. |
| PRIVATE_TEXTCHAT | 200 | Receiver Session ID | A private textchat message was sent. The comments include the sender, the receiver and the message length. |
| FILE_TRANSFER | 200 | Receiver Session ID | A file was transferred. The comments include the sender, the receiver, the file name and size. If there are multiple receivers, there is one log per receiver. |
| DROPBOX_UPLOAD | 200 | Object ID | A file was uploaded. The comments include the file name and size. |
| DROPBOX_SHOW | 200 | Object ID | The user invoked the Show Dropbox action. |
| DROPBOX_SHOWDELETE | 200 | Object ID | The user invoked the Delete Files from dropbox action. |
| UPLOAD_IMAGE_INSERTION | 200 | Object ID | An image insertion was uploaded. The comments include the file name and size. |
| RESET_IMAGE_INSERTION | 200 | Object ID | Image insertion was reset to default. |
| SET_IMAGE_URL | 200 | Object ID | Image insertion URL was set. |
| RESET_IMAGE_URL | 200 | Object ID | Image insertion URL was reset to default. |
| SET_LAUNCH_URL | 200 | Object ID | Image launch URL was set. |
| RESET_LAUNCH_URL | 200 | Object ID | Image launch URL was reset to default. |
| PAGE_CHANGE | 200 | Object ID | Document insertion page was changed. |
| UPLOAD_DOCUMENT_INSERTION | 200 | Object ID | A document insertion was uploaded. The comments include the file name and size. |
| RESET_DOCUMENT_INSERTION | 200 | Object ID | Document insertion was reset to default. |
| UPLOAD_MOVIE_INSERTION | 200 | Object ID | A movie insertion was uploaded. The comments include the file name and size. |
| RESET_MOVIE_INSERTION | 200 | Object ID | Movie insertion was reset to default. |
| SET_WEB_URL | 200 | Object ID | Web Renderer URL was set. |
| SET_HOME_PAGE_URL | 200 | Object ID | Web Renderer home page URL was set. |
| LOAD_URL | 200 | Object ID | Web Renderer URL changed as a result of Previous, Next, Home or Synchronize. |
| SET_WHITE_LIST | 200 | Object ID | Web Renderer's white list was set. |
| LAUNCH_URL | 200 | Object ID | The Launch URL operation was invoked on an image insertion. The comments include the user name and the URL. |
| GESTURE | 200 | Gesture name | The user performed a gesture (e.g raise_hand, bow etc.) |
| LASERPOINTER | 200 | "on"/"off" | The user turned the laser pointer on or off. |
| HANDSHAKE | 200 | User Session ID | The user shook hands with another user. |
| HANDSHAKE | 406 | User Session ID | The user tried to shake hands with another user but failed. |
| TELEPHONY_CALL_START | 200 | User Session ID | The user created a telephony integration call. |
| TELEPHONY_CALL_END | 200 | User Session ID | The user ended a telephony integration call. |
| HARDWARE_CPU | 200 | Level Title | Logs the CPU details of a particular client. |
| HARDWARE_GPU | 200 | Level Title | Logs the GPU details of a particular client. |
| BENCH_STARTUP | 200 | Level Title | Logs the start up time details of a particular client. |
| BENCH_PCKG_DOWN | 200 | Level Title | Logs the package download benchmark details of a particular client. |
| BENCH_INS_DOWN | 200 | Level Title | Logs the insertion download benchmark details of a particular client. |
| BENCH_INS_UP | 200 | Level Title | Logs the insertion upload benchmark details of a particular client. |
| BENCH_IMG_PROC | 200 | Level Title | Logs the image processing benchmark details of a particular client. |
| BENCH_FPS | 200 | Level Title | Logs the frame rate benchmark details of a particular client. |