ORE Studio Comms Analyser Component

Session recording analyser for ORE Studio.

Component Architecture

Diagram:

Figure 1: ORE Studio Comms Analyser Component Diagram

This module provides a command-line tool for analysing ORES session recording files (.ores). These files are created by the session recorder in ores.comms and capture client-server communication for debugging and analysis. Key features include:

Session file parsing: reads .ores binary recording files
Metadata extraction: session ID, start time, server address, protocol version
Frame extraction: recorded frames with timestamps and direction (sent/received)
Quick inspection: read metadata only without loading all frames
Compression support: handles compressed session recordings

The module is organized into namespaces: app (application entry point), config (command-line options and parsing), and domain (session reading logic).

Domain Types

Type	Description
`session_metadata`	Metadata about a recorded session (ID, time, server, protocol)
`recorded_frame`	Single frame with timestamp offset and direction
`session_data`	Complete session including metadata and all frames
`session_reader`	Parser for `.ores` session recording files

Usage

# Analyse a session recording file
ores.comms.analyser --input /path/to/session.ores

# Show help
ores.comms.analyser --help

Related Components

ores.comms: Contains session_recorder that creates .ores files
ores.comms.service: Server that can be recorded

Top: Documentation

Previous: System Model