Product Documentation

Examples

Jan 06, 2015

The following examples show how to export Monitor Service data using the OData API. This topic also provides a list of URLs for available data sets.

Example 1 - Raw XML

  1. Place the URL for each data set into a web browser that is running with the appropriate administrative permissions for the XenApp or XenDesktop Site. Citrix recommends using the Chrome browser with the Advanced Rest Client add-in.
  2. View the source.

Example 2 - PowerPivot with Excel

  1. Install Microsoft Excel.
  2. Follow the instructions here to install PowerPivot (depending on whether or not you are using 2010 or 2013): https://support.office.com/en-us/article/Start-Power-Pivot-in-Microsoft-Excel-2013-add-in-a891a66d-36e3-43fc-81e8-fc4798f39ea8.
  3. Open Excel (running with the appropriate administrative permissions for the XenApp or XenDesktop Site).
  • Using Excel 2010
  1. Click the PowerPivot tab.
  2. Click PowerPivot Window.
  3. Click From Data Feeds in the ribbon.
  4. Choose a Friendly Connection Name (for example: XenDesktop Monitoring Data) and enter the data feed url: http://{dc-host}/Citrix/Monitor/OData/v1/Data (or https: if you are using SSL).
  5. Click Next.
  6. Select the tables you want to import into Excel and click Finish. The data is retrieved.
  • Using Excel 2013
  1. Click the Data tab.
  2. Choose From Other Sources > From OData Data Feed
  3. Enter the data feed url: http://{dc-host}/Citrix/Monitor/OData/v1/Data (or https: if you are using SSL) and click Next.
  4. Select the tables you want to import into Excel and click Next.
  5. Accept name defaults or customize names and click Finish.
  6. Choose Connection Only or Pivot Report. The data is retrieved.

You can now use PowerPivot to view and analyze the data with PivotTables and PivotCharts. For more information, see the Learning Center: http://www.microsoft.com/en-us/bi/LearningCenter.aspx

Example 3 - LinqPad

  1. Download and install the latest version of LinqPad from http://www.linqpad.net.
  2. Run LinqPad with the appropriate administrative permissions for the XenApp or XenDesktop Site.
    Tip: the easiest way is to download, install and run on the Delivery Controller.
  3. Click the Add connection link.
  4. Choose WCF Data Services 5.1 (OData 3) and click Next.
  5. Enter the data feed URL: http://{dc-host}/Citrix/Monitor/OData/v1/Data (or https: if you are using SSL). If necessary, enter the username and password to access the Delivery Controller. Click OK.
  6. You can now run LINQ queries against the data feed and export the data as needed. For example, right-click Catalogs and choose Catalogs.Take(100). This returns the first 100 Catalogs in the database. Choose Export>Export to Excel with formatting.

URLs for Available Data Sets

URL Description
http://{dc-host}/Citrix/Monitor/OData/v1/Data/Catalogs Catalog images in the site
http://{dc-host}/Citrix/Monitor/OData/v1/Data/ConnectionFailureCategories Grouping for connection failure types
http://{dc-host}/Citrix/Monitor/OData/v1/Data/ConnectionFailureLogs Log of each connection failure in the site
http://{dc-host}/Citrix/Monitor/OData/v1/Data/Connections Represents an initial connection or reconnect for a session
http://{dc-host}/Citrix/Monitor/OData/v1/Data/DesktopGroups Delivery Groups in the site
http://{dc-host}/Citrix/Monitor/OData/v1/Data/FailureLogSummaries Failures (connection/machine) counts by time period and Delivery Group
http://{dc-host}/Citrix/Monitor/OData/v1/Data/Hypervisors Hosts (hypervisors) in the site
http://{dc-host}/Citrix/Monitor/OData/v1/Data/LoadIndexes Load Index data received from the Virtual Delivery Agent (VDA)
http://{dc-host}/Citrix/Monitor/OData/v1/Data/LoadIndexSummaries Load Index averages by time period and machine
http://{dc-host}/Citrix/Monitor/OData/v1/Data/MachineFailureLogs Log of each machine failure by start and end date in the site
http://{dc-host}/Citrix/Monitor/OData/v1/Data/Machines Machines in the site
http://{dc-host}/Citrix/Monitor/OData/v1/Data/SessionActivitySummaries Session counts and logon data by time period and delivery group
http://{dc-host}/Citrix/Monitor/OData/v1/Data/Sessions Represents a user connected to a desktop
http://{dc-host}/Citrix/Monitor/OData/v1/Data/TaskLogs Log of all tasks and their status that have been run as part of the internal Monitoring Service
http://{dc-host}/Citrix/Monitor/OData/v1/Data/Users Users that have launched a session in the site