In this post I will go over what data can be recovered using the Monitor Service a quick overview of what is the URL? and some examples of access to the database using a browser.
The API OData Service Monitor includes some data. Most of it falls into the category of XenDesktop session information (including the use and errors). These are historically tracked and the length of time data is retained is based on both the license and the user configuration. These settings can be changed with the set-monitorconfiguration cmdlet. Please note - changing these settings must be done very carefully as you could end up with missing data in Director
Use OData in a Web browser
During the development of these APIs. - We found that a Web browser is first the best way to see the output of the query. To effectively work with the data, you'll quickly want to move on as Microsoft Excel PowerPivot, LINQPad or programmatic access.
Chrome has an extension called Advanced REST client that we found useful. If you choose to display the URL in Internet Explorer, you must make sure to disable the read RSS view. This can be changed in Internet Options -> Content -> Wire and Web Slices -> Settings. Once in this dialog box, clear the Turn on feed reading view check box and once you save these settings by clicking OK, you need to restart IE.
The documentation describes how to access the URL is a few different ways here: http://support.citrix.com/proddocs/topic/xendesktop-7/cds-ms-odata-example.html
of [DiscoveringODataAPI
the Monitor service exposes two main APIs for data recovery. In all the examples below, please replace localhost with the name of the XenDesktop controller you ask (if you are not on the machine itself). These API 's also require a XenDesktop administrator to successfully recover data so that you may be prompted for a username / password
- Methods :. Http: // localhost / Citrix / Monitor / OData / v1 / Methods / $ metadata
- Data: http: // localhost / Citrix / Monitor / OData / v1 / Data / $ metadata
The $ url metadata should be used to find out what is available. this document is very important because it not only describes what is available from the URL, but it can also be used by programs that can read the OData and syntax allows them to programmatically generate client code that can be used to query the API You can learn more about the site OData.org describing the metadata format here. http://www.odata.org/documentation/odata-v2 -Documentation / overview / # 3_Metadata_for_OData_Services
Documentation of the methods available to access these endpoints is here. http://support.citrix.com/proddocs/topic/xendesktop-7/cds-ms -odata-methods.html
API method
This API is primarily used by the director to recover historical chart data displayed.
Data API
This API is much more flexible and provides access to all data collected by the Monitor service. The documentation includes a schematic diagram I have included below. The lines between the boxes are also very useful in understanding the relationships that the objects.
Our goal in the appointment was to make the most self-explanatory items. A basic description of each object is here:
system information tables
- DesktopGroup - Matches Delivery Groups in Studio
- catalog - These are machinery Catalogues studio
- machine - these are the machines added to a group Delivery studio
- hypervisor - If a machine is managed hypervisor, very basic information of hypervisor is stored in this table
- user - it is the users who threw sessions - they are added as new sessions are created, so if a user has never used XenDesktop, their information will will not in this table
- session - This is the information of the high-level session, if a user starts a new session of the trademark, registration will be here, the initial logon time and the session connection information being also present. logoff session is captured here as well, actually enter the information in this sheet
- Log -. This is a child of a session record for each new connection for the session, this information is followed in these cases. There may be multiple connections per session, depending on the number of disconnect / reconnect the user launched the duration of a session. This table also includes information from client version and newspaper on the breakdown time stamps for the session log on
- SessionActivitySummary -. This table includes data that has been aggregated from the session tables and connection. Counts of logons and number of sessions connected / disconnected are also included in this table. This table is widely used for the director of trend data, but can also be used to watch the session numbers for a group (XenDesktop Desktop Delivery Group) over time.
- LoadIndexSummary - This captures the load index for the OS Server machines. This information can provide valuable information on the overall system utilization and load
- ConnectionFailureLog - . Whenever there is a connection error, a record is added to this table
- ConnectionFailureCategory -. This table includes the categorization of connection failures - it is used for categorization director error and does not include details of granular error. It is a static table that does not change that errors occur
- MachineFailureLog -. This includes the failure of the state monitoring machine. As machines move in and out of state failure and become available for use again, this table includes the start / end times and reasons for the failure
- FailureLogSummary -. These are aggregated data from ConnectionFailureLog MachineFailureLog and tables. It includes the class / codes for chess and are aggregated by group (XenDesktop Desktop Delivery Group) over time. If this level of granularity is all you need, this is a good table for you
A few examples of applications that you can run in a track Web browser .:
- To retrieve all users: http: // localhost / Citrix / monitor / OData / v1 / data / users
- To recover all sessions: http : // localhost / Citrix / monitor / OData / v1 / Data / sessions
- to recover all sessions for all users in a specific field: http: // localhost / citrix / monitor / OData / v1 / data / Sessions () $ filter = user / 'QALAB eq domain
0 Komentar