Archive Inspector User Guide

Overview

Archive Inspector provides diagnostic information about archives created for an OpenTok session. It helps customers identify issues with the archiving feature by providing details about archiving events, the expected duration of archives, and the current state of archives.

Applies To

• Video API
• Archiving

Procedure

The Archive Inspector tool can be used to troubleshoot problems related to archiving. To begin troubleshooting, you'll need to have either the session ID or archive ID.

In the search box, enter the session ID or archive ID (Select a specific meeting if you have multiple instances of meetings using the same session ID)

The results will be divided into three main sections: Archive Information, Archive Overview, and Archive Timeline. Each of these sections provides important insights and data related to the archive.

Archive Information

This section includes Meeting Duration, Archive Duration (including both running and paused minutes), and Archive Status. 

The status of an archive can be any one of the following:

• "started" — The archive started and is in the process of being recorded.
• "paused" — When an archive is paused, nothing is recorded.
  • No clients are publishing streams to the session. In this case, there is a timeout of 60 minutes where the archive will stay paused, after which the archive stops and the status changes to stopped.
  • All clients disconnect the session. After 60 seconds the archive stops and the status changes to stopped.
  • If a client resumes publishing while the archive is in the paused state, the archive recording resumes and the status changes back to started.
• "stopped" — The archive stopped recording. 
  • The upload of the Archive to the customer's cloud storage or OpenTok cloud begins after the OpenTok servers complete the Archive and add it to the pending queue. At this time, the Archive status will show as stopped.
    
• "uploaded" — The archive is available for download from the S3 bucket or Azure container you specified at your Video API account. Note that for very small archives, the uploaded status event may occur before the stopped status event.
• "available" — The archive is available for download from the OpenTok cloud.
• "expired" — The archive is no longer available for download from the OpenTok cloud. (Archives on the OpenTok cloud are only available for 72 hours from the time they are created.)
• "failed" — The archive recording failed.

Archive Overview

Here, you can find additional information about the archive, such as the corresponding Session ID, the archive's size, file type, mode, and resolution. Additionally, you will find links to analyse the Session ID and check related KB articles for further assistance.

Once an archive has stopped recording, the system generates an MP4 or ZIP file. This file is then uploaded to an S3 bucket or Azure container, if these storage options have been configured and specified by the user. If the user do not set an S3 bucket or an Azure container, or if uploading to the specified storage fails, recorded archives are available for retrieval by download from the OpenTok cloud. Archives made available on the OpenTok cloud are available for 72 hours from the time they are created. Refer How does archiving work and how can I configure it for guidance on setting these options.

Archive Timeline

The timeline will contain following sections:

• "Meeting" -  Total duration of the meeting.
• "Archive states" - Shows states of the archive.
• "Publisher presence" - Refers to the presence of each publisher with their stream ID during the meeting.

Additional information

How to recognise if I'm using Vonage Video API Unified Environment or Vonage Video API OpenTok environment?