Configure Session Recording¶

Set what is recorded during container sessions: the screen video and the text logs.

Configure Recording in a Container Profile¶

Access: inventory_2 Inventory > box_edit Container Profiles, then create or edit a profile. The Session Recording step is in the form.

By default, session recording is disabled at the organization level: in a profile, Disabled (Organization) means the profile uses the organization’s value.

To record the video of this profile, choose Enabled in Video recording. To record the text, choose Portal, Standard output, or Portal and standard output in Text recording. The options are detailed in Recording Settings.

If the instance administrator has locked a setting to Disabled, you cannot enable it.

Configure Recording in a Container Blueprint¶

Access: verified_user Administration Area > architecture Container Blueprints, then create or edit a blueprint. The Session Recording step is in the same form.

Configure the settings (see Recording Settings).
To enforce a setting on organization administrators, lock it with the lock button, on the right of the setting.

Organization administrators can no longer change a locked setting. For example, if you lock it to Disabled, they cannot enable it.

Recording Settings¶

Record the Video¶

Video recording: records the screen of container sessions (disabled by default). The settings below only appear when it is Enabled.

Codec and Quality¶

Codec: compression format of the video.
- VP9: requires no additional component (default).
- AV1: more compact at equal quality, but requires an agent built with AV1 support.
- JPEG: stores one independent image per frame.
Chroma sampling: sets how much color detail is kept.
- 4:4:4: text stays readable (default).
- 4:2:0: lighter, but no text can be read whatever the bitrate. Choose it only if seeing which application was open is enough.
Rate control: chooses what stays stable in the recording.
- Constant quality: the image stays stable and the size varies (default).
- Target bitrate: the bitrate stays stable and the quality varies. Set its value with the setting of the same name, in Detailed Settings.
- Lossless: the image is pixel-exact, at roughly 4 times the volume.

Detailed Settings¶

Select the checkbox of a setting to show its numeric field.

Target bitrate: bitrate aimed for by the recording, 400 kbit/s by default. This setting only appears when rate control is set to Target bitrate.
Capture quality (1-100): quality of each captured image, 60 by default.
Capture interval: delay between two captured images, 2,000 ms by default.
Maximum width: maximum width of the recording, 1,920 px by default.
Maximum height: maximum height of the recording, 1,080 px by default.
Keyframe interval: how often full frames appear in the video, 10 frames by default.
Encoder speed (0-9, higher is faster and larger): trade-off between encoding speed and file size, 8 by default.
Encoder threads: number of threads (tasks run in parallel) that the encoder uses to compress the video, 1 by default.

Record the Text¶

Text recording: chooses where the agent’s session logs (typed commands, visited URLs) are sent:
- Disabled: no log is recorded (default).
- Portal or Portal and standard output: commands and URLs show up in the player.
- Standard output: the lines stay in the container logs and do not reach the player.

Note

The Commands counters and the recording player logs require Portal or Portal and standard output, and a signaling service in version 2.14.0 or later. See Record API.