This is the multi-page printable view of this section. Click here to print.
Logging
- 1: Session logging
- 2: System logging
- 3: Eturnal logs
1 - Session logging
Introduction
Browsolate logs all session activity for auditing and security purposes. These logs are accessible through AWS CloudWatch in the log group named browsolate-logs. Each day has its own logfile, named according to the format sessions-YYYY-MM-DD
.
Logs are stored in the region where your Browsolate instance is deployed, and you can view them directly in CloudWatch.
Accessing Logs
- Navigate to AWS CloudWatch in your AWS Console.
- Select Log groups and find the log group named browsolate-logs.
- Inside this log group, you will find logs for each day, named in the format
sessions-YYYY-MM-DD
. - Open the log for the desired date to view detailed session events.
Sample Log Entries
Logs capture key events such as the start and end of a session, along with various session parameters and configurations. Below are sample log entries for session start and session end events.
Sample Session Start Event:
{
"event": "session_start",
"sessionId": "SESSION:94e31200-7991-4c4b-8a3e-a211a43f8723",
"startTime": "2024-10-23T10:18:34.838Z",
"clipboardRead": true,
"sessionExtensionTime": 30,
"screenWidth": 1024,
"customRequestHeaders": {
"header1": "value1",
"header2": "value2"
},
"urlEditable": false,
"screenHeight": 768,
"readOnly": false,
"userAgent": "",
"sessionExtensionAllowed": false,
"url": "https://www.redacted .com/",
"logIndirectUrlNavigation": false,
"navigation": true,
"linkId": "",
"clipboardWrite": true,
"linkExpiry": -1,
"logDirectUrlNavigation": false,
"sessionLifetime": 300,
"debugMode": false
}
Sample Session End Event:
{
"event": "session_end",
"sessionId": "SESSION:94e31200-7991-4c4b-8a3e-a211a43f8723",
"startTime": "2024-10-23T10:18:34.838Z",
"endTime": "2024-10-23T10:18:47.937Z",
"sessionLengthSeconds": 13,
"reason": "Session ended",
"clipboardRead": true,
"sessionExtensionTime": 30,
"screenWidth": 1024,
"customRequestHeaders": {
"header1": "value1",
"header2": "value2"
},
"urlEditable": false,
"screenHeight": 768,
"readOnly": false,
"userAgent": "",
"sessionExtensionAllowed": false,
"url": "https://www.redacted.com/",
"logIndirectUrlNavigation": false,
"navigation": true,
"linkId": "",
"clipboardWrite": true,
"linkExpiry": -1,
"logDirectUrlNavigation": false,
"sessionLifetime": 300,
"debugMode": false
}
2 - System logging
System logs
These logs help in tracking down issues related to deployment, configuration, and the overall health of the system.
System logs are stored in AWS CloudWatch under the ComputeStack log group. This log group is identified by the unique ID assigned during the installation process by the AWS Marketplace.
Accessing System Logs
- Navigate to AWS CloudWatch in your AWS Console.
- Select Log groups and find the log group named ComputeStack, followed by the unique ID generated during installation.
- Within this log group, you will find logs for different components of the system infrastructure.
Use Cases for System Logs
System logs are especially useful for:
- Debugging: Identifying issues related to infrastructure components such as ECS tasks, networking, or resource limits.
- Health Monitoring: Ensuring that all system components are running as expected and diagnosing potential failures or bottlenecks.
3 - Eturnal logs
Eturnal logs in Browsolate
The Eturnal STUN/TURN server handles WebRTC traffic routing for Browsolate, allowing real-time video and audio streaming through firewalls and NATs. Logging for Eturnal is crucial for diagnosing connectivity issues and monitoring the performance of WebRTC sessions.
Eturnal logs are stored in the eturnal-logs log group in AWS CloudWatch.
Accessing Eturnal Logs
- Navigate to AWS CloudWatch in your AWS Console.
- Select Log groups and find the log group named eturnal-logs.
- Review the logs to track WebRTC traffic and diagnose any issues with STUN/TURN traffic handling.