Plan Usage Test

Though Zoom is best known for its video conferencing platform, Zoom Meetings, it has continually expanded to offer additional software solutions that meet the remote workforce’s increasing demands since the pandemic. Zoom now offers Unified Communications (UCaaS), advanced team collaboration tools, a VoIP phone system, virtual events, and hybrid office environments. Each product has flexible tiers and pricing plans–including free versions–that allow for a variety of use cases across large and small teams.

Zoom’s multichannel unified communications product, streamlines Zoom Phone, Zoom Chat, Zoom Meetings, and business SMS messaging into one communications solution. It primarily come with 3 major plan options - Basic, Pro and Business. It is really important for administrators to keep track of plan usage so that they can ensure that various aspects of service can be actively managed and services like Zoom meetings, Zoom rooms, capability to join meetings, capability to record etc. is available to all active users. Administrators also need to ensure that we're not consuming billing or licenses for the features we are not using at all. This is the reason it is important to monitor Zoom plan usage sot hat administrators have full clarity of usage aand draw insights around the suitability of current plan or if organization needs upgrade.

This test monitors the Zoom plan usage and captures key metrics like type of plan, number of hosts, usage, large meetings hosts, Zoom rooms hosts and usage, recording plan, storage etc. These metrics are highly valuable for administrators to understand how the plan is used.

Target of the test : Zoom

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the monitored in Zoom.

Configurable parameters for the test
Parameters Description

Test period

How often should the test be executed, the default value is 12 hrs.

Host

The host for which the test is to be configured. By default, this is Zoom.us.

Client ID

When configuring the Zoom API, you should have created an API client with OAuth authentication. Each client app is assigned with a Client ID which you need to copy from client app configuration wizard and save down. Zoom API requires Client ID and Secret Token when calling REST APIs. To know more about how to create Client ID and Secret Token, refer to Setting up Zoom API

Client Secret

Secret Token is generated along with Client ID during API configuration. Each client app is assigned with a Client ID which you need to copy from client app configuration wizard. Zoom API requires Client ID and Secret Token when calling REST APIs. To know more about how to create Client ID and Client Secret, refer to Setting up Zoom API

Authorization Code

Authorization Code acts as an access token which tells Zoom on subsequent requests that current client has already been authorized. The Authorization Code is sent to client as string along with redirect URL once the client request has been authorized. In this text box, you need to specify the authorization code that you obtained during API configuration. For more details, refer to Setting up Zoom API

Redirect URL

In the authorization flow, the Zoom API request is first passed on to Zoom Auth Server. Once the authorization is successful, the client request is redirected back to URL provided by user in Redirect URL along with authorization code. Client can now hit the API with given authorization code to pull metrics.

API URL

Zoom offers globally accessible URL for Zoom REST APIs. To enable the eG agent to connect Zoom REST APIs and pull out metrics, this test should be configured with the accessible URL against this parameter. The default value of this parameter is https://api.zoom.us/v2/.

Before using the APIs, first you need to create an API client, set up the authentication and authorization details as elaborated in topic Setting up Zoom API.

Show N DD

By default, this parameter is set to 50. This indicates that, by default, the detailed diagnosis of this test will display the details of only 50 events. If you wish this test to report details of all events, then specify "all" against this parameter.

Proxy Host and Port

If the eG agent need to communicates with Zoom via a proxy, then, you also need to configure the eG agent on the connector with the proxy server details. This will enable the eG agent to connect to the Zoom without a glitch, and pull metrics. To facilitate this communication. do the following:

  • Specify the IP address/fully-qualified host name of the proxy server, against PROXY HOST.

  • Specify the port at which the Proxy server listens for requests from the eG agent, against PROXY PORT.

By default, both these parameters are set to none, indicating that the eG agent does not communicate with the Zoom via a proxy.

Proxy User Name and Password

Specify the Proxy username and password if proxy server is being used to connect with Zoom.

Confirm Password

Confirm the password by typing it in Confirm password box.

DD Frequency

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time the test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD Frequency.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enabled/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test

Measurement

Description

Measurement Unit

Interpretation

Base type

Indicates the base plan subscription for the account.

Number

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure Value Numeric Value
Standard Pro Monthly 1
Standard Pro Annual 2
Standard Pro Two Years Prepay 3
Standard Pro Three Years Prepay 4
Pro Monthly with capacity 25 5
Pro Annual with capacity 25 6
Pro Monthly with capacity 50 7
Pro Annual with capacity 50 8
Standard Biz Monthly 9
Standard Biz Annual 10
Standard Biz Two Years Prepay 11
Standard Biz Three Years Prepay 12
Education Annual 13
Education Two Years Prepay 14
Education Three Years Prepay 15

Note:

By default, this measure reports the Measure Values listed in the table above to indicate which base plan is used.

Base hosts

Indicates the number of hosts which are on base plan..

Number

 

Base usage

Indicates the number of hosts which are actively using the base plan.

Number

 

Large meeting hosts

Indicates the total number of hosts which are part of large meetings.

Number

 

Large meeting usage

Indicates the total of hosts using the large meetings.

Number

 

Zoom room type

Indicates the type of room which is used.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure Value Numeric Value
Zoom Rooms Monthly 16
Zoom Rooms Annual 17
Zoom Rooms Two Years Prepay 18
Zoom Rooms Three Years Prepay 19

Note:

By default, this measure reports the Measure Values listed in the table above to indicate which base plan is used.

Zoom room hosts

Indicates the total number of host who have Zoom rooms.

Number

Zoom rooms consume licenses, so administrators need to ensure that Zoom rooms are used effectively, and unused rooms are deleted.

 

Zoom rooms usage

Indicates the total number of host which are using Zoom room out of total Zoom rooms.

Number

Recording total storage

Indicates the total storage available for recordings under current plan.

GB

  

Administrators need to ensure that the recordings are managed efficiently, old recordings are deleted so that there is always space for new recordings to be created. Zoom provides feature that when plan recoding storage is full, mit start using free storage available for recording to store new recordings Administrators need to keep track of how much storage is available in plan storage as well as free storage so that recordings are not interrupted.

 

 

 

Recording transcript completed

Indicates the total storage occupied by recording transcript.

GB

Recording plan storage

Indicates the total storage available with recording plan.

GB

Recording plan storage usage

Indicates the percentage of available recording plan storage, which is used.

GB

Recording plan storage usage

Indicates the percentage of plan storage that is used.

Percentage

Recording free storage

Indicates the free storage available for use for recording.

GB

Recording free storage usage

Indicates the storage used out of total available free storage.

GB

Recording free storage usage

Indicates the percentage of free storage that is used.

Percentage