Account_ID
(For service providers only) Displays the company ID. If you have access to more
than one account's data, you can filter output by ACCOUNT_ID
.
For example, .../aternity.odata/API_NAME?$filter=(ACCOUNT_ID eq
'12345')
.
Account_Name
(For service providers only) Displays the company name. If you have access to
more than one account's data, you can filter output by
ACCOUNT_NAME
. For example,
.../aternity.odata/API_NAME?$filter=(ACCOUNT_NAME eq
'Company_Name')
.
Action
Displays the action which the user performed, which the system audited.
For the Aternity access audit API, it only logs a successful sign in to Aternity, which it
displays as Login.
For the Aternity dashboard audit API, it logs:
-
Open Dashboard
-
Dashboard Interaction, such as changing a parameter, marking a
selection, or changing a filter.
Active_Time
The active time of an application is the time when it is running, in the
foreground, and the user is actively interacting with it (NOT waiting for it
while it is busy trying to respond). It is calculated as the usage time minus the
wait time.
Activity
Displays the name of the monitored activity within the application as it appears in the
dashboards.
An activity is an end
user interaction or event in a managed application (like a mouse click, or
pressing Enter), together with its response (like a change on the screen).
Aternity measures the
activity response
time, which is the time between the activity's start event and
its response (end event). For example, it can monitor the launch of an
application, or the time to respond to a menu choice.
Activity_Client_Time_Avg
(For managed
applications only) Displays, in milliseconds, the client
time for a single activity,
or the average client time if this entry covers several activities.
Client time is when the device processes data before or after sending to the
server
Activity_Network_Time_Avg
(For managed
applications only) Displays, in milliseconds, the network
time for a single activity,
or the average network time if this entry covers several activities.
Network time is the time for all messages to cross the network and back as
part of an activity response
Activity_Response
Activity_Response_Avg
Activity_Score
The activity score is a value (0-100) with a status and color
which condenses many activity statuses into a single value, and is calculated using our Apdex-inspired
formula.
Use the Score to measure
short term (acute) sudden changes in performance, as they rely on recent baseline measurements.
The score reflects a recent change because it would be significantly different from
the established baseline response
times.
Aggregating many end user activities into a single score and status
Activity_Server_Time_Avg
(For managed
applications only) Displays, in milliseconds, the server
time for a single activity,
or the average server time if this entry covers several activities. Server time is the time required by
the server to process data on the server side, part of the overall response time of an
activity. It starts when the client sends a request to the target
server, when the last message of that request arrives at the target server
side. It ends when the server sends out the first message of its
response.
The server time for a single request-response pair is from the last
send to its first response minus the round trip time. If the
activity calls a server more than once, or several servers, the reported
time is the combination (union) of all the individual times together. If the
target server calls other back-end servers, Aternity's server time is the
total (union) of all network times and server times of all back end servers
in that chain, ending when the activity's target server sends its response
to the client. For more server-side visibility, view the transaction details
in SteelCentral AppInternals™.
Server time from the last message arriving at the server side until the
server sends its first response
Activity_Volume
(For managed
applications only) Displays the number of times someone performed this activity during the timeframe, thereby adding weight to the impact of
this problem. If the same user performs the same activity twice,
it counts as two.
Age_In_Days
Displays the time elapsed since the timestamp of the collection of the data in
days.
Age_In_Hours
Displays the time elapsed since the timestamp of the collection of the data in
hours.
Age_In_Minutes
Displays the time elapsed since the timestamp of the collection of the data in
minutes.
Agent_Current_Status
(Windows, Macs) Displays the reporting status of the Aternity Agent:
-
The status of a device is
Reporting
if
Aternity is actively
receiving monitoring data from that device.
-
(For Windows and Macs) The status of a device is
Disconnected
if Aternity has not received
monitoring data for more than five minutes from this device, but it has received
data within the last 7 days.
This could be caused by powering off the device (may
be company policy to switch off every night), or it may not have a license to report to
Aternity, or it could
point to a problem with the device, like no network connection.
When the Agent is
disconnected, it locally stores up to 50 minutes
of retention data in offline mode, and then sends it when it renews its
connection.
-
(For Windows and Macs) The status of a device is
Stopped
if its Agent behaves unusually (like high
CPU or memory usage), and therefore it automatically shuts down. Contact
Customer Services.
(For mobile devices)
Aternity Mobile reports a status
Stopped when it does not collect performance data,
but can still receive commands from the Aggregation Server.
-
(For monitored mobile apps only) The status of a
device is Not Reporting
if Aternity has not received
monitoring data from this mobile device for at least 10 minutes.
This could happen if the device is shut
down, or the device has no network data connection, or the mobile app is running
in the background or is not running at all.
Agent_Version
Displays the version of
the Aternity Agent on the device.
Application
The name of the application, as
specified in the Description field of
the executable file's properties.
Tip
Web Browsing is an umbrella term for
all web browsing in your organization on sites which are not
white listed. To white list a site, add it as a managed application.
An internet browser is
both a container of web applications and a desktop
application in its own right. You can monitor a browser's
performance by viewing its launch times and recent crashes
in Monitor Application,
and its memory and CPU consumption in the Analyze Process Resources
dashboard.
Application_Type
Displays the type of application:
Application_Version
Average_Response_Time_1d, Average_Response_Time_1h,
Average_Response_Time_5min
Displays (in milliseconds) the average response
time of this activity in the past five minutes, the past hour or the
past 24 hours.
Browser
(For web
applications only) Displays the type of web browser housing the application.
Business_Location
(For applications or activities) Displays the name of
the locations where the application is
used.
(For devices) Displays the current
geographic location of the device.
For example, if
some users still complain of poor performance after your
change, you can isolate whether the slow results are
restricted to one location or are spread across your
organization. Use Locations to
compare the performance before and after a change for each
location.
Change_Pilot_Group
Displays the pilot
group assigned to this device. A pilot
group is a custom set of users or devices which undergo a change, like
migrating to Windows 10, or updating the type of hard disk to SSD.
Client_Device_Name
(For virtual
deployments only) Displays the hostname of a device which is connecting to a VDI
or virtual application server.
Client_Device_Type
(For virtual
deployments only) Displays the type of front line terminal which runs the
virtual session hosted on a virtual server.
If the front line terminal
has an Aternity Agent locally installed, it reports the type of device of the terminal. Otherwise, if it
does not have its own Agent, it reports it as a Remote Device.
Client_Time
(For managed
applications only) Displays the client time for a single activity
in milliseconds. Client time is the time used by the device itself as part of an
activity to process
data before sending its first message request to the server and after the last
message response arrives back from the server.
The Aternity Agent calculates the client time as
the total activity response
time minus the infra time.
Client time is the time on the device side to process data as part of the
activity response
Client_Time_Avg
(For managed
applications only) Displays average the client
time in milliseconds for all the activities
covered in this entry.
Client time is the time used by the device itself as part of an
activity to process
data before sending its first message request to the server and after the last
message response arrives back from the server.
The Aternity Agent calculates the client time as
the total activity response
time minus the infra time.
Client time is the time on the device side to process data as part of the
activity response
Connected_Agents
Displays the number of devices of this Device_Type in this
location where the status of the Aternity Agent was
Reporting, Stopped or Not Reporting during the past
seven days.
-
The status of a device is
Reporting
if
Aternity is actively
receiving monitoring data from that device.
-
(For Windows and Macs) The status of a device is
Stopped
if its Agent behaves unusually (like high
CPU or memory usage), and therefore it automatically shuts down. Contact
Customer Services.
(For mobile devices)
Aternity Mobile reports a status
Stopped when it does not collect performance data,
but can still receive commands from the Aggregation Server.
-
(For monitored mobile apps only) The status of a
device is Not Reporting
if Aternity has not received
monitoring data from this mobile device for at least 10 minutes.This could happen if the device is shut
down, or the device has no network data connection, or the mobile app is running
in the background or is not running at all.
Connected_Remote_Devices
Displays the number of devices of this Device_Type in this
location which did not have a locally deployed Agent, and where
the status of that remote Agent was
Reporting.
The status of a device is
Reporting
if
Aternity is actively
receiving monitoring data from that device.
CPU_Cores
(Desktops, laptops and
mobile devices only) Displays the number of CPU cores of the
device.
CPU_Frequency
(Windows, Macs only) Displays the speed of the
CPU processors of the device.
CPU_Generation
(Windows on Intel only) Displays the generation
of the Intel Core micro-architecture. For example
6 represents the 6th generation architecture
processor, also known as Skylake.
CPU_Model
(Windows on Intel only) Displays the model and
speed of the Intel processor, as displayed in the
System control panel. For
example Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz
or Intel(R) Xeon(R) CPU E5620 @
2.40GHz.
CPU_Type
(Windows on Intel only) Displays the core type
of the Intel processor, for example i7,
E5, and so on).
Crashes
Displays the number of crashes during the time slot of this entry:
-
(Windows desktop
apps) Aternity registers an
application crash with Windows Event Log ID 1000 (a process or DLL ends
unexpectedly), event ID 1001 (.NET process ends unexpectedly), event ID 1002 (a
user stops a Not Responding process), or event ID 1026
(.NET runtime error).
(Mac desktop apps)
Aternity registers
an application crash on Mac applications if the crash is entered in the system
log.
-
(Mobile apps) The Aternity Mobile SDK
reports a crash if the app issues an unhandled exception, or if it receives an
abort signal from the operating system (Android or iOS).
For every mobile app crash, Aternity collects the exception's
code and type, and the app's stack trace, a summary of the crash information,
and offers you to download the dump file if needed. It also collects any breadcrumbs leading up to
the crash.
-
(Web applications)
Displays the number of browser crashes.
Critical_Status_Count_1h, Critical_Status_Count_1d,
Critical_Status_Count_5min
Display the number of times someone performed this activity
whose status was critical,
when you gather the performance data from the past five minutes, the past hour
or the past 24 hours.
Dashboard_Name
Displays the name of the dashboard, for example, EnterpriseSummary or
DeviceDetails.
Data_Center_Location
Data Center Locations in Aternity lists the locations of any virtual
application servers (like Citrix XenApp) and VDI hypervisors (like in VMWare
vSphere) which run the application. If the application is deployed both locally
and virtually, one of the locations displays as
Local.
Days_From_Last_Boot
Displays the number of days
since the last time the device was booted. If you think that
people experience slowdowns because they have not booted in
some time, you can compare their performance with users who
restart their devices frequently.Possible values are any of the following strings:
-
Less than 24 hours
-
24 - 48 hours
-
2 - 7 days
-
7 - 14 days
-
15 - 30 days
-
More than 30 days
Detection_Status
Device_Manufacturer
Displays the name of
the device manufacturer, for example, Samsung,
Apple,
Dell, Lenovo, and so on.
Device_Model
Displays the name of
the model of the device, for example iPhone 6s,
GalaxyTab8, MacBook Pro 12.1,
Dell Latitude D620.
Device_Name
Displays the hostname of
the monitored device. View it in the Windows
Control Panel > System > Computer
Name, or on Apple Macs in System
Preferences > Sharing > Computer Name.
Device_Type
Displays the type of device reporting performance to Aternity.
-
Desktops are
monitored Windows devices without a fitted battery, or for Macs, any monitored MacBook running
macOS or OS X.
-
Laptops are Windows devices with a battery and a
built-in keyboard (including all Windows hybrid tablet/laptop models), or for
Macs, any monitored laptop running
macOS or OS X.
-
Remote
Devices have applications accessed remotely via an RDP
protocol, for example, with Microsoft's Remote Desktop Connection.
-
Smartphones run
monitored mobile
apps on a small touch screen within a mobile operating system
environment.
-
Tablets have larger
touch screens, and no built-in keyboard, running iOS or Android. If it runs
Windows, it is defined as a tablet if it is a known model of a Windows pure
tablet (like Microsoft Surface models).
-
Virtual App
Servers offer multiple users access to a single instance of
an application, for example, with Citrix XenApp.
-
Virtual
Desktops offer the ability to run an application within a
VDI environment, which is a virtual instance of the entire desktop operating
system (usually Windows).
Diverse_Value_1 - 3
Diverse_Value fields display extra custom contextual data reported as part of your
custom activity which the system cannot aggregate, like an error message. Contextual attributes are descriptive properties of a measurement or
activity, like a username, window title or application name.
Duration
Displays the length of the boot time. The type of boot time is in the Type field.
Enforce_Privacy
Displays whether privacy mode is enabled on the device.
(For all devices except mobile) When True, it encrypts any
attributes which can identify a user, like username,
hostname, IP address, and so on. The default value is
False.
Entity_Type
Displays the type of user who performed this action in Aternity. Possible
values are LocalUser or SamlUser for an SSO user,
Event_Category
Displays the category of an error (or some other custom data) which you track
using an application event of type Application Error Event.
Event_Details
Displays the details of an error (or some other custom data) which you track
using an application event of type Application Error Event.
Event_Duration
Displays the response time of a non-typical business activity which you measure
with an application event of type Application Usage Duration.
Event_Type
Displays the type of application event:
-
Application Usage Duration is for measuring the
time to complete a non-typical complex business activity, like one which
includes application response times mixed with time waiting for the
user. For example, use this to measure the time required for a user to
identify a customer at the beginning of a call.
-
Application Usage Event is for counting the times
when an event occurred, or when it is not easy to identify the end event
of an activity.
For example, if you want to track the number of
times when people shared their desktop in Skype for Business, track this
as an application usage event, and assign a
Category to different types of usage
events.
-
Application Error Events are for tracking the
occurrence of errors. Each error has a Category,
or type of error, and a Details field, which
contains details of the event or error.
Hang_Time
Hang time measures the time when an application is listed as
Not responding in the Windows Task Manager while it
is in the foreground (in use). This measurement is used to calculate the wait time of an
application, and the overall UXI.
The time displays with the unit of
milliseconds.
HRC_CPU_Util
(Windows, Mac and
mobile) DIsplays the
percentage CPU utilization at a given time, measured as
a percentage of the total power available. For example,
if the device has four CPU cores, where one is at 100%
and the others are idle, it will display a value of
25%.
HRC_Disk_IO_Read
Displays the rate at which
the device reads from the hard disk in MB per second at any
given time.
For example, if a virus
scanner slows performance by issuing many disk read
requests, reschedule to off-peak times. Alternatively, if
the read rate falls to almost zero, the hard disk may be
failing, or its connection to the computer may be
unreliable.
HRC_Disk_IO_Write
DIsplays the rate at
which the device writes to the hard disk in MB per second at
any given time.
For example, a movie
editor can perform large disk writes, slowing down the
device's performance. Alternatively, if the write rate falls
to almost zero, the hard disk may be failing, or its
connection to the computer may be unreliable.
HRC_Disk_Queue_Length
(Windows only) Displays the number of
waiting I/O requests to read or write to the hard disk
or a logical disk at a given time during the activity.
A consistent queue for
the disk indicates a bottleneck in hard disk access, which
significantly impacts on system performance, either due to
excess system demands on the disk, or it can be a hardware
disk problem. To check if the problem is hardware, view if
the speed (rate of reads and writes to the disk) is
low
HRC_Network_IO_Read
Displays the data
downloads of this device in MB per second at any given
time.
For example, if its
throughput or usage of bandwidth is low, and the user
complains of slow network connections, consider checking the
NIC hardware.
HRC_Network_IO_Write
Displays the data
uploads from this device in MB per second at any given
time during the activity.
For example, if its
throughput or usage of bandwidth is low, and the user
complains of slow network connections, consider checking the
NIC hardware.
HRC_Physical_Memory_Util
(Windows, Macs,
mobile) Displays the percentage usage of the device's physical
RAM memory at a given time during the activity.
HRC_Virtual_Memory_Util
(Windows only)
Displays the current usage of a device's virtual memory as a
percentage of the device's total virtual memory (physical
RAM plus hard disk allocation for memory page faults) at a
given time during the activity.
Info1, Info2
IP_Address
(Windows, Mac) Displays the device's internal IP address (including IP
v6 if the device runs Agent 10 or later) which it uses to connect to Aternity.
(Mobile devices) Displays the IP of
the WiFi connection if the device is reporting data via
WiFi.
Is_Predefined
Displays whether the activity is predefined (True) or not
(False). Aternity comes with default
predefined activities out of the box, for popular business
applications. For example, there are many predefined activities for the
applications in Microsoft Office, like Outlook's open mail or send
mail. There are predefined activities for Acrobat Reader, Microsoft
Office 2007, 2010, 2013 and 2016 (Outlook, Word, PowerPoint, Excel, all in
English), Microsoft Skype for Business and Citrix WorxMail for mobile
devices.
Last_Reported_Date
Displays the last date and time when Aternity received this
data in ISO 8601 format. For example, July 20th 2016
at 03:15am in the UTC time zone appears as
2016-07-20T03:15:00Z
or
2016-07-20T03:15:00+00:00
.
Location_City
Location_Country
Location_Region
You can optionally define a region in Aternity to group together several
locations under a
single label, like the geographical region of EMEA, North America
or even Southern Europe, South-Western US any other grouping you
choose.
Location_State
Displays the
geographical state of the current location of the devices (or area, if state is
not applicable).
Major_Status_Count_1h,
Major_Status_Count_1d, Major_Status_Count_5min
Displays the number of times someone performed this
activity whose status
was major, when you gather the performance data
from the past five minutes, the past hour or the past 24
hours..
Max_Timestamp
Displays the last timestamp for all fields in this
entry, in ISO 8601 format. For example, July 20th 2016
at 03:15am in the UTC time zone appears as
2016-07-20T03:15:00Z
or
2016-07-20T03:15:00+00:00
.
Measurement_Time
An activity's measurement time is the time stamp when the
Aternity Agent on the device noted
the occurrence of the activity. The time stamp is translated to the time zone of
the Aggregation Server.
Memory_Size
Displays the size of RAM of the device.
Method
Displays the type of user who signed in to Aternity:
-
LocalUser refers to a username which you defined locally inside
Aternity.
-
SamlUser refers to a user who signed in via SSO with the SAML
protocol.
-
LDAPUser refers to a user defined and managed in your Microsoft Active
Directory.
Minor_Status_Count_1h,
Minor_Status_Count_1d, Minor_Status_Count_5min
Displays the number of times someone performed this
activity whose status
was minor, when you gather the performance data
from the past five minutes, the past hour or the past 24
hours.
Minutes_Running
Displays the number of minutes that the process of this application has been running
on this device.
Mobile_Carrier
(Mobile devices only) Displays the name of the
cellular carrier to which the device is connected.
Mobile_Device_ID
For monitored Android apps, the Device ID is
made up of two parts: the first is the WiFi mac address, and the second is the
software-based ANDROID_ID
.
For monitored iOS apps the Device ID
is only unique per vendor ID. If your enterprise uses a
single vendor ID to create several apps, then whenever they are on the same
device, they report the same Device ID. But an app from a
different vendor ID (like Citrix WorxMail) on the same device would report a
different Device ID.
MS_Office_Version
Displays the high level
version of Microsoft Office, like MS Office 2016 or
MS Office 2013.
Network_Incoming_Traffic_Total, Network_Outgoing_Traffic_Total
Aternity reports the total
volume of network traffic in KB in both directions while an application
performs an activity.
Network_RTT_Average
Displays the average round
trip time (RTT) for this device. The time displays with the unit of
milliseconds.
A single message and its acknowledgment, before any server processing
Network_Time
Displays the network
time of this activity in milliseconds. Network time is the total time (union) taken for all
messages to cross the network in either direction, between the client and the
target server, while performing an activity. This does NOT include the time used for
processing the request on the server (server time).
The network time is calculated as the infra time minus the
server time.
Network time is the time for all messages to cross the network and back as
part of an activity response
Network_Time_Avg
Displays the network
time of this activity, or if the API delivers aggregated results, it
displays the average network time for this activity over the aggregation period. The time displays with the unit of
milliseconds.
Network time is the total time (union) taken for all
messages to cross the network in either direction, between the client and the
target server, while performing an activity. This does NOT include the time used for
processing the request on the server (server time).
The network time is calculated as the infra time minus the
server time.
Network time is the time for all messages to cross the network and back as
part of an activity response
Network_Type
(Devices with Agent 9.x or later) Displays
the type of network connection of the device:
Mobile or
WiFi, and also
LAN (for non-mobile devices
only).
Normal_Status_Count_1h,
Normal_Status_Count_1d, Normal_Status_Count_5min
Displays the number of times someone performed this
activity whose status
was normal, when you gather the performance data
from the past five minutes, the past hour or the past 24
hours.
On_Site
(Windows only) Displays
true when the device can identify and
connect to the Microsoft Active Directory site (either directly
or via VPN).
On_VPN
(For all devices except
mobile and Macs) Displays true when the
device is connected to the corporate network through VPN.
OS_Architecture
Displays whether the operating
system of the monitored device is 32-bit or 64-bit.
OS_Disk_Type
(Windows only, Agent 9.0.3 or later) Displays the type of hard disk containing
the operating system. Possible values are:
-
HDD for a traditional spinning
hard disk drive
-
SSD for a solid state drive
-
Virtual if this is not a physical
device.
OS_Family
Displays the broad
category of the operating system. Use this to differentiate
between different major operating system groups. For example, it displays all
releases of Microsoft Windows as MS Windows, all
releases of Windows Server as MS Windows Server or
all releases of iOS as iOS.
OS_Name
Displays the generic name and version of the operating
system (like MS Windows 10, MS Windows Server
2008 R2, MacOS 10.3, iOS 10 or
Android 6).
For example, it displays
Windows 10 Pro and Windows 10 Enterprise
all as MS Windows 10
OS_Version
Displays the full name,
the exact version number, and the service pack version of
the operating system. In Windows 10, it includes the release
ID (like Microsoft Windows 10 Enterprise 1507). Use
this to differentiate between details of the same operating
system. For example, it lists MS Windows Server 2008 R2
Enterprise SP 1.0 separately from MS Windows
Server 2008 R2 Enterprise SP 2.0.
Page_Load_Client_Time_Avg
(For web
applications only) Displays the average time spent for client side processing during the load time of
a web page.
The web page load time is the time required for a web page to load
and finish rendering in a browser, from sending a URL request to when the page's
events finish loading and it has a status of Completed. This measurement
does NOT include the time to load additional page elements which occur after the
main page has loaded, such as iframes that are embedded separate web pages, AJAX
calls after the page is complete, or bookmarks with # in
the URL). It does include AJAX calls that the page makes before it is
complete.
Client time is the time used by the device itself as part of an
activity to process
data before sending its first message request to the server and after the last
message response arrives back from the server.
Web page load time
Page_Load_Network_Time_Avg
(For web
applications only) Displays the average network time portion of the load time of a web page.
The web page load time is the time required for a web page to load
and finish rendering in a browser, from sending a URL request to when the page's
events finish loading and it has a status of Completed. This measurement
does NOT include the time to load additional page elements which occur after the
main page has loaded, such as iframes that are embedded separate web pages, AJAX
calls after the page is complete, or bookmarks with # in
the URL). It does include AJAX calls that the page makes before it is
complete.
Network time is the total time (union) taken for all
messages to cross the network in either direction, between the client and the
target server, while performing an activity. This does NOT include the time used for
processing the request on the server (server time).
Web page load time
Page_Load_Server_Time_Avg
(For web
applications only) Displays the average server time portion of the load time of a web page.
The web page load time is the time required for a web page to load
and finish rendering in a browser, from sending a URL request to when the page's
events finish loading and it has a status of Completed. This measurement
does NOT include the time to load additional page elements which occur after the
main page has loaded, such as iframes that are embedded separate web pages, AJAX
calls after the page is complete, or bookmarks with # in
the URL). It does include AJAX calls that the page makes before it is
complete.
Server time is the time required by
the server to process data on the server side, part of the overall response time of an
activity. It starts when the client sends a request to the target
server, when the last message of that request arrives at the target server
side. It ends when the server sends out the first message of its
response.
The server time for a single request-response pair is from the last
send to its first response minus the round trip time. If the
activity calls a server more than once, or several servers, the reported
time is the combination (union) of all the individual times together. If the
target server calls other back-end servers, Aternity's server time is the
total (union) of all network times and server times of all back end servers
in that chain, ending when the activity's target server sends its response
to the client. For more server-side visibility, view the transaction details
in SteelCentral AppInternals™.
Web page load time
Page_Load_Time_Avg
(For web
applications only) Displays the average load time of a web
page for this application.
The web page load time is the time required for a web page to load
and finish rendering in a browser, from sending a URL request to when the page's
events finish loading and it has a status of Completed. This measurement
does NOT include the time to load additional page elements which occur after the
main page has loaded, such as iframes that are embedded separate web pages, AJAX
calls after the page is complete, or bookmarks with # in
the URL). It does include AJAX calls that the page makes before it is
complete.
Web page load time
Page_Load_Volume
(For web
applications only) Displays the number of times a web page load took place during this time slot.
The web page load time is the time required for a web page to load
and finish rendering in a browser, from sending a URL request to when the page's
events finish loading and it has a status of Completed. This measurement
does NOT include the time to load additional page elements which occur after the
main page has loaded, such as iframes that are embedded separate web pages, AJAX
calls after the page is complete, or bookmarks with # in
the URL). It does include AJAX calls that the page makes before it is
complete.
Web page load time
Performance_Index
The performance index is a value (0-5) which measures the
application responsiveness. If users must wait frequently or for long periods
for the application to respond, the index is lower. It is made up of its usage time and wait time.
Definition of performance index
Performance_Weight
Use this weight to create an average of several measurements of the application's
performance
index.
To combine several readings into a single value, you
cannot take a simple average, since this is a cumulative measurement, not a spot
measurement, hence each reading relies on and contains those which came
beforehand. Therefore each measurement needs its own relative weight, which you
can use to include it as part of an overall average. Use this weight value (from
Aternity's
proprietary algorithm) to recreate the weighted average displayed in Aternity's
dashboards:
Sum(Performance_Index * Performance_Weight) /
Sum(Performance_Weight)
PRC_CPU
View the percentage CPU utilization of
this Windows process while it performs an activity, measured as a percentage of
the total power of all CPU cores available.
During an activity, if an application uses
resources (x% CPU or RAM), or sends x MB of network traffic, it is not the same
as saying that it is because of the activity. They happen at the same
time, so they are correlated (see Correlation vs. Causation). However, you can be
reasonably confident that these device measurements occurred because of the
activity.
PRC_CPU_Avg
Displays the average CPU
usage (in percent) of this managed application during the timeframe, which is part of the application's
process resource consumption (PRC).
PRC_CPU_Max
Displays the peak CPU
usage (in percent) of this managed application during the timeframe, which is part of the application's
process resource consumption (PRC).
PRC_GDI_Objects_Count
Displays a measure of the device's graphics resource usage in Windows. The
Agent
collects this value only if manually configured in your deployment.
PRC_Physical_Memory
View the amount of working set memory for
this Windows process while it performs an activity.
If the activity always coincides with a
spike in memory consumption, this is probably the cause of slow
performance.
During an activity, if an application uses
resources (x% CPU or RAM), or sends x MB of network traffic, it is not the same
as saying that it is because of the activity. They happen at the same
time, so they are correlated (see Correlation vs. Causation). However, you can be
reasonably confident that these device measurements occurred because of the
activity.
PRC_Physical_Memory_Avg
Displays the average
usage of a managed application's physical memory (known as
the total working set) in gigabytes during the timeframe, which is part of the PRC.
PRC_Physical_Memory_Max
Displays the peak
usage of a managed application's physical memory (known as
the total working set) in gigabytes during the timeframe, which is part of the PRC.
PRC_User_Objects_Count
Displays a measure of the device's usage of resources assigned to window
management. The Agent collects
this value only if manually configured in your deployment.
PRC_Virtual_Memory
View the amount of reserved memory
(commit size) for this Windows process, while it performs an activity.
If the activity always coincides with a
spike in memory consumption, this is probably the cause of slow
performance.
During an activity, if an application uses
resources (x% CPU or RAM), or sends x MB of network traffic, it is not the same
as saying that it is because of the activity. They happen at the same
time, so they are correlated (see Correlation vs. Causation). However, you can be
reasonably confident that these device measurements occurred because of the
activity.
PRC_Virtual_Memory_Avg
Displays the average
usage of a managed application's reserved memory (commit
size) in gigabytes during the timeframe, which is part of the application's
process resource consumption (PRC).
PRC_Virtual_Memory_Max
Displays the peak
usage of a managed application's reserved memory (commit
size) in gigabytes during the timeframe, which is part of the application's
process resource consumption (PRC).
Process_Name
Displays the name of the monitored
Windows process of the managed application, as displayed in the Windows
Task Manager.
Remote_Display_Latency
The remote display latency is the average time taken for the round
trip of a network data packet to travel between the front line user and a
virtual server (both ways).
Practically, it is the time between performing an action
in a virtual session on the front line user's machine, then sending that
action to the virtual desktop server (VDI) or virtual application server,
and then viewing that action back on the front line terminal again. This
does NOT measure the time for the application to respond.
For example, if a user types the character
'g' in a text editor which runs on a virtual
application server, when the remote session sends this action to the virtual
server, the remote display latency is the lag time between typing
'g' to seeing the 'g' on the
screen.
Remote display latency is the time in both directions from the front line
user to the virtual server
Reporting_Agents
Displays the number of devices of this Device_Type in this
location where the status of the Aternity Agent was
Reporting during the past seven days.
The status of a device is
Reporting
if
Aternity is actively
receiving monitoring data from that device.
Score_1d, Score_1h, Score_5min
Server_Hostname
Displays the actual
hostname of the server (NOT its DNS alias), when an
application on the device contacts a server. For example, on
a device using Outlook 365, the hostname might be
outlook-emeacenter.office365.com while its DNS
name is shortened to outlook.office365.com. This is a clearer
definition to replace Target
Server.
If you contact more
than one server during an activity, it reports the server
whose total server time was longest during that
activity.
Server_IP
Displays the IP address of
the server, when an application on the device contacts a
server. For example, on a device using Outlook, it displays
the IP address of the Exchange server. This is a clearer
definition to replace Target
Server.
If you contact more
than one server during an activity, it reports the server
whose total server time was longest during that
activity.
Server_Name
Displays the DNS alias
of the hostname of the server (not the computer's actual
hostname), when an application on the device contacts a
server. For example, on a device using Outlook 365, the DNS
name might be outlook.office365.com while its full
hostname might be
outlook-emeacenter.office365.com. This is a clearer
definition to replace Target
Server.
If you contact more
than one server during an activity, it reports the server
whose total server time was longest during that
activity.
Server_Time
(For managed
applications only) Displays the server time for a single activity. The server time for a single request-response pair is from the last
send to its first response minus the round trip time. If the
activity calls a server more than once, or several servers, the reported
time is the combination (union) of all the individual times together. If the
target server calls other back-end servers, Aternity's server time is the
total (union) of all network times and server times of all back end servers
in that chain, ending when the activity's target server sends its response
to the client. For more server-side visibility, view the transaction details
in SteelCentral AppInternals™.
Definition of server time in a client-server application
Server_Time_Avg
(For managed
applications only) Displays the server time for a single activity, or
the average server time if this entry covers several activities. The time displays with the unit of
milliseconds.
The server time for a single request-response pair is from the last
send to its first response minus the round trip time. If the
activity calls a server more than once, or several servers, the reported
time is the combination (union) of all the individual times together. If the
target server calls other back-end servers, Aternity's server time is the
total (union) of all network times and server times of all back end servers
in that chain, ending when the activity's target server sends its response
to the client. For more server-side visibility, view the transaction details
in SteelCentral AppInternals™.
Definition of server time in a client-server application
Serving_Device_Name
Displays the hostname of
the monitored device. View it in the Windows
Control Panel > System > Computer
Name, or on Apple Macs in System
Preferences > Sharing > Computer Name.
Note
In anonymized APIs, this field is empty. However, for virtual servers, it
displays the hostname of the server.
(Mobile) Displays the
Device Name field. You can customize the name of personal mobile
devices running
your enterprise's app, so the device's name appears in the
dashboards with a consistent naming policy. For example, you
can dynamically assign the device name according to the
enterprise username of the app.
Serving_Device_Type
Displays the type of the monitored
device:
-
Desktops are
monitored Windows devices without a fitted battery, or for Macs, any monitored MacBook running
macOS or OS X.
-
Laptops are Windows devices with a battery and a
built-in keyboard (including all Windows hybrid tablet/laptop models), or for
Macs, any monitored laptop running
macOS or OS X.
-
Remote
Devices have applications accessed remotely via an RDP
protocol, for example, with Microsoft's Remote Desktop Connection.
-
Smartphones run
monitored mobile
apps on a small touch screen within a mobile operating system
environment.
-
Tablets have larger
touch screens, and no built-in keyboard, running iOS or Android. If it runs
Windows, it is defined as a tablet if it is a known model of a Windows pure
tablet (like Microsoft Surface models).
-
Virtual App
Servers offer multiple users access to a single instance of
an application, for example, with Citrix XenApp.
-
Virtual
Desktops offer the ability to run an application within a
VDI environment, which is a virtual instance of the entire desktop operating
system (usually Windows).
Subnet
Displays
the subnet configuration of the device (including IP v6 if
the device runs Agent 10 or later) used to connect to Aternity.
Timeframe
Displays the earliest timestamp for all fields in this
entry, in ISO 8601 format. For example, July 20th 2016
at 03:15am in the UTC time zone appears as
2016-07-20T03:15:00Z
or
2016-07-20T03:15:00+00:00
.
Add this as a filter when you need to separate out an aggregated measurement into the
individual measurements with their time stamps. Alternatively, you can limit the scope of a query to the period between two
static times, by creating a filter of a timeframe greater than or equal to
(ge
) the start time and less than or equal to
(le
) the end time.
For example: $filter=((TIMEFRAME gt
2018-06-09T16:00:00+01:00 and TIMEFRAME lt 2018-06-11T18:00:00+01:00) or
(TIMEFRAME gt 2018-06-13T16:00:00+01:00 and TIMEFRAME lt
2018-06-15T18:00:00+01:00))
Tip
Alternatively you can filter for relative_time()
(recommended) which returns
the dynamic most recent data, to refresh your query without re-entering a new
static time. For example, $filter=relative_time(yesterday)
.
Title
Displays the activity's Title field, if the activity reported this as
one of its contextual fields.
For example, if an activity measures the time taken for a window to open, the
Title would refer to window or page title.
Type
Displays the type of boot, whose length is in the Duration
field. The choices are:
-
User Logon
: User logon measures a part
of the boot time, starting when you press OK at the
Windows sign in screen and ending when the Windows desktop Start button
appears.
The Agent queries
Windows Shell-Core (NOT the Event Log) for the
Explorer_StartMenu_Ready event to mark the end of
this time.
-
Total Boot Duration
: The total boot
time on a Windows device starts from the time the Windows logo appears until
the desktop appears and all components are loaded.
Agent queries
Windows Event Log (ID 100) for the BootTime parameter,
calculated as the sum of main path boot and post boot times, located in the
Diagnostics > Performance > Windows section of
the log.
-
Machine Boot
: Machine boot is part
of a device's boot time, starting a fraction of a second after the Windows
logo appears, and ending with the Windows sign in screen.
Agent queries
Windows Kernel-PnP (NOT the Event Log) for the BootStart >
Start event to mark the start of this time, and ends when
the Windows sign in screen appears (or the automatic sign in process
starts).
Tip
In some cases with a very fast boot, or when Windows bypasses the full boot
process, the Agent only reports
the user logon time.
Boot time definitions
Usage_Time
The usage time of an application is the
total time it is running, in the foreground, and being used. This includes
the wait time, the
time a user spends waiting for the application to respond.
For web applications, the usage time is when both the
browser window and the application's tab are in the
foreground.
The time displays with the unit of milliseconds.
Definition of usage time
User_Department
Displays the name of the department to which the user or the device
belongs.
(Windows) Agent 9.x or later
queries Windows network user information, accessing the Active Directory user >
Properties >
Department
.
(Mobile) Mobile apps can set this manually in the Aternity Mobile SDK.
User_Domain
Displays the LDAP domain name
for the user who is logged in to the device.
User_Email_Address
(Windows only) Displays the email address associated with
the current logged in user.
User_Full_Name
(Windows only)
Displays the full name of the person accessing the device
(not the username).
User_Name
Displays the Aternity
username of the person associated with the audited action inside Aternity. This is NOT
the operating system's username.
User_Office
(For all devices except mobile) Displays the office where the current user logged in to
this device.
For example, if a user
based in the Houston office is currently visiting the
Chicago office, the Office is
Houston, while the
Location would be
Chicago.
User_Role
Displays user role descriptions customized by your
organization, for example, Floor Sales, or Phone
Support.
Only displays if you defined a custom attribute
using this predefined name.
Username
Displays the username of the
person accessing each device.
Users_in_the_Last_7_Days
Displays the number of unique users who performed this activity
during the past seven days.
UXI
The User Experience Index (UXI) is a value
(0-5) which measures the overall performance and health of an application,
based on several inputs: the number of crashes per hour
out of the total usage time, the percentage of hang time out of
the total usage time, the percentage wait time out of
the total usage time. For web applications, it also uses the percentage of web page
errors out of all page loads, and the average page load time.
These ingredients come together to represent the overall experience of a
user.
UXI_Weight
Use this weight to create an average of several measurements of the application's
UXI.
To combine several readings into a single value, you cannot
take a simple average, since this is a cumulative measurement, not a spot
measurement, hence each reading relies on and contains those which came
beforehand. Therefore each measurement needs its own relative weight, which you
can use to include it as part of an overall average. Use this weight value (from
Aternity's
proprietary algorithm) to recreate the weighted average displayed in Aternity's
dashboards:
Sum(UXI * UXI_Weight) / Sum(UXI_Weight)
Virtual_App_Server_Edition
Displays the edition name of the product running virtual app server, like
XenApp Advanced or XenApp Platinum.
Virtual App
Servers offer multiple users access to a single instance of
an application, for example, with Citrix XenApp.
Virtual_App_Server_Farm
If the virtual app server belongs to a set of load balanced servers, known as a
farm, it displays the name of the farm.
Virtual App
Servers offer multiple users access to a single instance of
an application, for example, with Citrix XenApp.
Virtual_App_Server_Version
Displays the release or version number of the product running the virtual app
server.
Virtual App
Servers offer multiple users access to a single instance of
an application, for example, with Citrix XenApp.
Virtual_App_Server_Zone
Displays the name of zone within
the farm, where all servers
use the same data collector, which holds their settings
and acts as their load balancer.
Virtual App
Servers offer multiple users access to a single instance of
an application, for example, with Citrix XenApp.
Virtualization
Displays 1 if this took place on a VDI virtual machine or on a virtual
application server. Displays 0 if it took place on a physical
device.
Volume
Displays the number of times this activity was performed by this username on this
device during the aggregation time of this API.
Volume_1d, Volume_1h, Volume_5min
Volume_5min, Volume_1h, and
Volume_1d
display the total number of times someone
performed this activity in the past five minutes, the past hour or the
past 24 hours.
Volume_in_the_Last_7_Days
Displays the number of times anyone performed this activity
during the past seven days.
Wait_Time
The wait time of a Windows application is defined as
the time users spend waiting for the application to respond when it is actively
running and in use (part of the usage time).
The time displays with the unit of
milliseconds.
The total wait time is calculated as the
time covered by the following components (which may overlap): the hang time when an
application is not responding, or when the mouse pointer has a busy icon
(Windows devices). For web applications, the
wait time is the web page
load time when both the browser window and its tab are in the
foreground.
Definition of wait time on a Windows or web application(For
monitored
mobile apps only) , the wait time covers the following components which may overlap: the launch
time of the app, the time spent waiting for the app to switch from the
background to the foreground, the time required for a web page to load within
an app, and the time the user spends waiting for the app's main thread to
respond.
For Mac apps, wait time is the time during
which the app's main UI thread is not as responsive as it should be (slower
performance).
Wifi_BSSID
(From Agent 9.2 or Agent for Mac 2.3) Displays the
ID (MAC address) of the wireless access point, which the
device currently uses to connect to a WiFi
network.
Wifi_SSID
(From Agent 9.2, or Agent for Mac 2.0 and mobile) Displays the name of the WiFi network where the device
currently connects.