Monitor Service Schema

For the details of the Monitor Service schema, refer to the Monitor Service Schema diagram.

The preceding single page Monitor Service Schema diagram is divided into the following four categories. Each contains subcategories, related tables, descriptions, and their respective database schema diagrams.

Resource utilization

Session and application usage

Process utilization within sessions

Failures

Database schema diagrams

Resource utilization

Subcategory Related tables Description Collection Details
Single machine related Machine Indicates the details related to a specific machine. Raw data
  MachineMetrics Indicates metrics such as IOPS and latency for every hour for a particular machine. Raw data
  ResourceUtilization Indicates the utilization details of a machine. For example, CPU, memory, session count, and so on. Raw data
Single machine consolidated data MachineMetricDaySummaries Indicates the consolidated data per day for machine metrics. Day
  ResourceUtilizationSummaries Indicates the average of all metrics over time. Hour, Day
  ServerOSDesktopSummary Indicates the details related to usage duration and total launch count on multi-session machines. Minute, Hour, Day
  DesktopOSDesktopSummary Indicates the details related to usage duration and total launch count on single-session machines. Minute, Hour, Day
Consolidated data across machines in a desktop group. MachineSummary Indicates the total number of powered-on machines, registered machines, machines in maintenance mode, and so on under a desktop group. Hour, Day

Session and application usage

Subcategory Related tables Description Collection Details
Application related ApplicationInstanceSummary Indicates the details related to the total launch count on the application, usage duration, and so on. Hour, Day
Session related SessionActivitySummary Indicates the details related to total connected and disconnected sessions, total logons, and so on. Hour, Day
  SessionMetric Indicates the ICARTT duration for that session. Raw data
  LogOnMetric Indicates the details related to sessions’ UserInit start and end date. Raw data

Process utilization within sessions

Subcategory Related tables Description Collection Details
Process ProcessUtilization Indicates the CPU and memory consumption in a session. Raw data
  ProcessUtilizationMinuteSummary Indicates the minute-level summary on a process. Minute
  ProcessUtilizationHourSummary Indicates the hour-level summary on a process. Hour
  ProcessUtilizationDaySummary Indicates the day-level summary on a process. Day

Failures

Subcategory Related tables Description Collection Details
Application related ApplicationError Indicates a problem that is not immediately relevant. Signifies conditions that might cause future problems. Raw Data
  ApplicationFault Indicates a significant problem, usually a loss of functionality or data. Raw data
Session Related ConnectionFailureLog Indicates the reasons for failure of the session along with the date. Raw data
  FailureLogSumamary Indicates details related to the number of failures within each failure category under a desktop group. Hour, Day
Machine related MachineFailureLog Indicates the reasons for deregistration and fault state. Raw data

Database schema diagrams

To determine the values returned by the Monitor Service OData API, see: API Exploration

Resources
Citrix Monitor Service API OpenAPI Specification
Copy Download
Monitor Service Schema