Skip to main content

Analytics

Frame provides a variety of reports to see exactly how your account is being used. Navigate to the “Analytics” panel in your Dashboard to see detailed information about your users' sessions, usage, disk usage, and elasticity. Each of these reports can be downloaded using the "Download CSV" button in the upper right corner of the panel.

Sessions

The “Sessions” tab is the first page displayed on the Analytics page of your Dashboard. This page shows a plot of the number of sessions per hour, day, or month during a given time interval. Use the drop down menus on this tab to display the information by frequency, system, and time period. This example shows the number of production sessions launched within a month.

Analytics - Sessions

Analytics - Sessions

You can also see the total sessions, average session time, and average distance from the datacenter displayed below the graph.

More detailed information is displayed when hovering over a bar on the graph.

Analytics - Sessions - Mouseover

Analytics - Sessions - Mouseover

In this example, we can see there were 3,539 total production instances on February 10th, 2022.

Usage

The “Usage” tab is the next tab over on the Analytics page. “Usage” provides detailed information about the hourly usage consumed per specified frequency, system, pool, and time interval.

Analytics - Usage

Analytics - Usage

The hourly usage is broken up by system type, with a key for each system type displayed below. Toggle which system types are displayed on the graph by clicking on them or changing the “Pool” from the drop down menu. In the example below, we have disabled the production Air 16GB system type.

Analytics - Usage - Mouseover

Analytics - Usage - Mouseover

The total hours used will always be displayed on the bottom left side of the graph on this page.

Disk Usage

The “Disk Usage” tab displays the amount of disk volume usage (in GB) within a specific period of time. You can adjust the frequency (hourly, daily, or monthly) using the drop down menu above the graph.

Analytics - Disk Usage

Analytics - Disk Usage

More detailed information is displayed when hovering over a bar on the graph.

Analytics - Disk Usage - Mouseover

Analytics - Disk Usage - Mouseover

The total disk volume usage (in GB hours) will always be displayed in the bottom left corner below the graph.

Elasticity

The Elasticity tab provides additional detail for evaluating the performance of your capacity settings (min, max, and buffer). The most important part of this chart lets you compare the active sessions (represents users that are connecting) to active instances (the number of systems that are powered on and are consuming usage hours). For example, if you find that your active instances are always much higher than your active sessions, then you should consider lowering your “min” and “buffer” settings. Additionally, you can use this graph to ensure your Default Capacity max is not too high relative to the peak active sessions.

Analytics - Elasticity

Analytics - Elasticity

More detailed information is displayed when hovering over a point on the graph.

Analytics - Elasticity - Mouseover

Analytics - Elasticity - Mouseover
note

Individual measures can be enabled and disabled by clicking the text descriptor for the measures.

Analytics - Elasticity - Show/Hide Measures

Analytics - Elasticity - Show/Hide Measures

The measures are defined as:

  • Active Instances: Active Instances are instances which are powered on.
  • Active Sessions: An Active Session is an active instance with a connected user.
  • Min setting: The minimum number of instances powered on at a given time that can be accessed by users immediately.
  • Buffer setting: Additional powered-on instances that are ready for a user within seconds. Set this to a number of users you expect will connect within a 2-minute window of time (the time it takes to boot an instance).
  • Actual capacity: The total number of instances, active or otherwise, that could be provisioned.
  • Max setting: The desired number of instances (concurrent users) to be provisioned for the pool. The administrator should determine this number based on peak session concurrency since this is a hard limit.

Session Reports

The session reports feature allows administrators to download and view session activity logs as .CSV files for more detailed user tracking and session troubleshooting. This section outlines how to enable and interpret session reports.

Enable Session Reports

To enable session reports, navigate to the Settings tab of the Nutanix Console and click the “session reports generation” option.

note

Once enabled, sesson report generation cannot be disabled.

Settings - Enable Session Report Generation

Settings - Enable Session Report Generation

A prompt will open formally notifying you that these changes cannot be reversed. Click Accept.

Confirm Session Report Generation

Confirm Session Report Generation

Navigate to the Analytics tab of the Nutanix Console and select the session reports tab.

Analytics - Download Session Reports

Analytics - Download Session Reports

In order to download a specific report, simply click the corresponding “Download report” link and save the file to your local computer.

note

Once enabled, session reports take approximately 24 hours to be made available for download from the Frame Dashboard.

Session Report Definition

The session report consist of a .CSV file which can be imported into the application of your choice for compiling into an itemized list with log activity of all sessions from the reports date range. This information consists of:

NameDescription
UsernameThe user ID associated with the session.
NameThe user's name on record.
EmailThe email address associated with the user of the session.
Geo_DistanceAn estimate of the geographic distance between the user's location and the datacenter accessed, measured in miles.
CityThe name of the city the user accessed their session from, as indicated by IP address.
Started_AtUTC Time and date the session was started.
Time_To_StartElapsed time from an instance being requested to the session beginning, measured in seconds.
Session_DurationDuration of the session, measured in seconds.
StateWhether the session is open or closed, at time of report generation.
Remote_IPThe IP address utilized by the session user.
System_TypeThe type of instance utilized for the session.
Session_TypeThe type of instance used during the session. IE: Sandbox, Utility Server, Production Instance, Persistent Desktop.
User_DataLists any custom data passed to the user's session via a userData object property.
Account_IDThe Frame Vendor ID.
Account_NameName of the Frame account accessed.
API_Account_IDNot user serviceable at this time.
RegionThe region of the cloud account.
CountryThe country of the cloud account.
Session_IDThe session ID.
Storage_UsedLists any attached personal cloud storage such as Google Drive or Dropbox.