Documentation

Contents
Contents

Citrix XenApp/XenDesktop Site Metrics

Citrix site monitoring requires uberAgent on at least one delivery controller per site. See the documentation for details.

Applications

uberAgent collects metrics like application name, site name as well as several application properties (is enabled, creation date, modification date, type) for each published application.

Details

  • Source type: uberAgent:Citrix:Applications
  • Used in dashboards: Citrix XA/XD Applications & Desktops
  • Enabled through configuration setting: CitrixDCApplication
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
Id Application ID String 10
Name Application name String GoogleChrome
PublishedName Application published name String Google Chrome
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
DesktopGroupId Desktop group ID String 05bddbe7-cf12-4ee2-ab02-93d0428d3847
DesktopGroupName Desktop group name String Finance users
ApplicationType Application type. Possible values: 0 ,1 Number 0
Enabled Indicates if application is enabled. Possible values: 0, 1 String 1
AdminFolder Application admin folder String Finance
LifecycleState Lifecycle state. Possible values: 0, 1, 2 ,3 Number 0
CreatedDate Application creation date String 2018-03-16 14:16:07.008 +0200
ModifiedDate Application modification date String 2018-03-16 14:16:07.008 +0200
Tags Configured tags String Germany
France

List of Calculated Fields

Field Description Data type Unit Example Where available
ApplicationTypeDisplayName Application type name. Possible values: HostedOnDekstop, InstalledOnClient String HostedOnDekstop Splunk data model, Splunk SPL
LifecycleStateDisplayName Lifecycle state name. Possible values: Active, Deleted, RequiresResolution, Stub String Active Splunk data model, Splunk SPL
TagsSplit Tags splitted by semicolon Number Germany;France Splunk data model

Databases

Enabled through configuration setting: CitrixDCGeneralInformation

Details

  • Source type: uberAgent:Citrix:Databases
  • Used in dashboards: Citrix Databases
  • Enabled through configuration setting: CitrixDCGeneralInformation
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
DataStore Datastore type. Possible values: 1, 2, 3 (1 = Site, 2 = Logging, 3 = Monitor) Number 1
IntegratedSecurity Database authentication method. Possible values: 1 (1 = true) String 1
MirrorServerAddress Mirror database server address String DB2.domain.ad
Name Database name String CitrixSiteDB
ServerAddress Database server address String DB1.domain.ad

Desktops

uberAgent collects metrics like desktop name, site name as well as tags for each published desktop.

Details

  • Source type: uberAgent:Citrix:PublishedDesktops
  • Used in dashboards: Citrix XA/XD Applications & Desktops
  • Enabled through configuration setting: CitrixDCPublishedDesktops
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
Id Published desktop ID String 10
Name Published desktop name (internal) String Finance Desktop
PublishedName Published desktop name (published) String Finance Desktop
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
DesktopGroupId Related desktop group ID String 05bddbe7-cf12-4ee2-ab02-93d0428d3847
DesktopGroupName Related desktop group name String Finance users
BrowserName Unique publishe desktop name in a site String FinanceDesktop
ColorDepth Color depth. Possible values: 0, 1, 2, 3 Number 3
Description Description String Desktop for finance users
Enabled Indicates if the published desktop is enabled. Possible values: 0, 1 String 1
ExcludedUserFilterEnabled Indicates if the excluded user filter is enabled. Possible values: 0 ,1 String 1
ExcludedUsers Excluded users String AD\Marketing
AD\HR
IncludedUserFilterEnabled Indicated if the included user filter is enabled. Possible values: 0 ,1 String 1
IncludedUsers Included users String AD\Finance
LeasingBehavior Leasing behaviour. Possible values: 0, 1 Number 1
RestrictToTag Indicates if published desktop is restricted to machines with specific tags String Finance
SecureIcaRequired Indicates if SecureICA is required. Possible values: 0 ,1 String 1
SessionReconnection Indicates the session reconnection behaviour. Possible values: 0, 1 ,2 Number 2
Tags Configured tags String Germany
France

List of Calculated Fields

Field Description Data type Unit Example Where available
ColorDepthBits Color depth. Possible values: 4, 8, 16, 24 Number 24 Splunk data model, Splunk SPL
ColorDepthDisplayName Color depth. Possible values: FourBit, EightBit, SixteenBit, TwentyFourBit String TwentyFourBit Splunk data model, Splunk SPL
ExcludedUsersSplit Excluded user splitted by semicolon String AD\Marketing;AD\HR Splunk data model
IncludedUsersSplit Included users splitted by semicolon String AD\Finance Splunk data model
LeasingBehaviorDisplayName Leasing behaviour. Possible values: Allowed, Disallowed String Allowed Splunk data model, Splunk SPL
SessionReconnectionDisplayName Indicates the session reconnection behaviour. Possible values: Always, DisconnectedOnly, SameEndpointOnly String SameEndpointOnly Splunk data model, Splunk SPL
TagsSplit Tags splitted by semicolon String Germany;France Splunk data model

Desktop Groups

uberAgent collects metrics like desktop group name and tags for each desktop group in a site.

Details

  • Source type: uberAgent:Citrix:DesktopGroups
  • Used in dashboards: Citrix XA/XD Applications & Desktops, Citrix XA/XD Machines
  • Enabled through configuration setting: CitrixDCDesktopGroup
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
Id Desktop group ID String 10
Name Desktop group name String Finance
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
IsRemotePC Indicates if desktop group is configured for Remote PC. Possible values: 0, 1 String 0
DesktopKind Kind of contained desktops. Possible values: 0 ,1 Number 1
LifecycleState Lifecycle state. Possible values: 0, 1, 2 ,3 Number 1
SessionSupport Indicates a desktop group’s session support. Possible values: 0, 1, 2 Number 1
DeliveryType Desktop group delivery type. Possible values: 0, 1, 2 Number 2
Tags Configured tags String Germany
France
CreatedDate Desktop group creation date String 2018-03-16 14:16:07.008 +0200
ModifiedDate Desktop group modification date String 2018-03-16 14:16:07.008 +0200

List of Calculated Fields

Field Description Data type Unit Example Where available
DesktopGroupId Content of field Id String 05bddbe7-cf12-4ee2-ab02-93d0428d3847 Splunk data model, Splunk SPL
DesktopKindDisplayName Kind of contained desktops. Possible values: Private, Shared String Shared Splunk data model, Splunk SPL
LifecycleStateDisplayName Lifecycle state name. Possible values: Active, Deleted, RequiresResolution, Stub String Active Splunk data model, Splunk SPL
SessionSupportDisplayName Indicates a desktop group’s session support. Possible values: Unknown, SingleSession, MultiSession String SingleSession Splunk data model, Splunk SPL
DeliveryTypeDisplayName Desktop group delivery type. Possible values: DesktopsOnly, AppsOnly, DesktopAndApps String DesktopAndApps Splunk data model, Splunk SPL
TagsSplit Tags splitted by semicolon String Germany;France Splunk data model

Hypervisors

uberAgent collects information like name and lifecycle state about hypervisors configured in a site.

Details

  • Source type: uberAgent:Citrix:Hypervisors
  • Used in dashboards: n/a
  • Enabled through configuration setting: CitrixDCHypervisor
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
Id Hypervisor ID String 10
Name Hypervisor name String XenServer1
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
LifecycleState Lifecycle state. Possible values: 0, 1, 2 ,3 Number 2

List of Calculated Fields

Field Description Data type Unit Example Where available
LifecycleStateDisplayName Lifecycle state name. Possible values: Active, Deleted, RequiresResolution, Stub String Active Splunk data model, Splunk SPL

Licenses

uberAgent collects metrics like site name and ID as well as license server for each active license in a site.

Details

  • Source type: em>uberAgent:Citrix:Licenses
  • Used in dashboards: Citrix Licensing
  • Enabled through configuration setting: CitrixDCLicenseInformation
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
LicenseServer License server String licsrv1
LicenseProductName License product name. Possible values: XDS, XDT, MPS String XDT
LicenseEdition License edition. Possible values: PLT, ENT, APP, STD, ADV String PLT
LicenseExpirationDate License expiration date String 2019-04-16 02:00:00.000 +0200
LicenseSubscriptionAdvantageDate License subscription advantage date String 2019-03-16 02:00:00.000 +0200
LicenseType License type String NFR
LicenseTypeLocalized License type localized String Not For Resale
LicensesInUse Indicates how many licenses were in use Number 5
LicensesAvailable Indicates how many licenses were available Number 100
LicenseOverdraft Indicates how many overdraft licenses were in use Number 0
LicenseModel License model. Possible values: CCS, UD, CCU String UD

List of Calculated Fields

Field Description Data type Unit Example Where available
LicenseProductDisplayName License product name. Possible values: XenDesktop (Legacy), XenDesktop, XenApp String XenDesktop Splunk data model, Splunk SPL
LicenseEditionDisplayName License edition. Possible values: Platinum Edition, Enterprise Edition, App Edition, VDI Edition, Advanced Edition String Platinum Edition Splunk data model, Splunk SPL
LicenseModelDisplayName License model. Possible values: Concurrent, User/Device, Concurrent String User/Device Splunk data model, Splunk SPL

Machines

uberAgent collects metrics like machine name and ID as well as the load index for each machine in a site. The terms “desktop group” and “delivery group” are used interchangeably.

Details

  • Source type: uberAgent:Citrix:Machines
  • Used in dashboards: Citrix Machines, Citrix XA/XD Applications & Desktops
  • Enabled through configuration setting: CitrixDCMachine
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
Id Machine ID String 10
Sid Machine SID String S-1-5-21-3286265390-2319899195-874027928-2628
Name Machine name with Active Directory domain String Domain\VM1
NameHost Machine name without Active Directory domain String VM1
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
EffectiveLoadIndex Effiective load index Number 10000
DnsName Machine name with full qualified domain name String VM1.domain.ad
LifecycleState Lifecycle state. Possible values: 0, 1, 2 ,3 Number 1
IPAddress IP address String 10.1.1.100
HostedMachineId Hypervisor identifier for this Machine String F8143B4F-7371-4efa-868A-54787EF9F64E
HostingServerName DNS name of the hypervisor that is hosting the machine if managed String XenServer1.domain.ad
HostedMachineName The friendly name of a hosted machine as used by its hypervisor. This is not necessarily the DNS name of the machine String XenServer1
IsAssigned Indicates if machine is assigned. Possible values: 0, 1 String 1
IsInMaintenanceMode Indicates if machine is in maintenance mode. Possible values: 0, 1 String 0
IsPendingUpdate Indicates if machine is in pending update state. Possible values: 0, 1 String 0
AgentVersion Citrix VDA version String 7.15.1000.150
AssociatedUserFullNames Full names of the users that have been associated with the machine. Associated users are the current user(s) for shared machines and the assigned users for private machines String Testuser 1
AssociatedUserNames Usernames of the users that have been associated with the machine. Associated users are the current user(s) for shared machines and the assigned users for private machines String AD\Testuser1
AssociatedUserUPNs The User Principal Names of the users associated with the machine. Associated users are the current user(s) for shared machines and the assigned users for private machines String Testuser1@domain.ad
CurrentRegistrationState Current registration state. Possible values: 0, 1, 2 Number 1
RegistrationStateChangeDate Date when the registration state changed String 2018-07-29 03:03:43.953 +0200
LastDeregisteredCode Machine’s last deregistration code. Possible values: too much to list here. Please have a look at the citrix_deregistrationreasoncode lookup. Number 207
LastDeregisteredDate Machine’s last deregistration date String 2018-07-29 02:33:34.037 +0200
CurrentPowerState Current power state. Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Number 9
CurrentSessionCount Current session count Number 20
ControllerDnsName Controller name String DDC1.domain.ad
PoweredOnDate Date when machine was powered on String 2018-03-16 15:18:27.407 +0200
PowerStateChangeDate Date when power state changed String 2018-03-16 15:18:27.407 +0200
FunctionalLevel Functional level. Possible values: 0, 1, 2, 3, 4, 5, 6 Number 6
FailureDate Date when machine failed String 2018-03-16 15:18:27.407 +0200
WindowsConnectionSetting Windows connection setting. Possible values: 0, 1, 2, 3, 4 Number 1
IsPreparing Indicates if the machine is in preparing state. Possible values: 0, 1 String 0
FaultState Fault state. Possible values: 0, 1, 2, 3, 4, 5 Number 1
CatalogId Related catalog ID String 10
DesktopGroupId Related desktop group ID String 05bddbe7-cf12-4ee2-ab02-93d0428d3847
HypervisorId Related hypervisor ID. String 10
Hash Hash String CC7380E01A5FD3403708B7D348FA218CC89E56C87F790457076D6CF408D93FC2
MachineRole Machine role. Possible values: 0, 1, 2 Number 2
HypervisorDisplayName Related hypervisor name String XenServer1
CatalogDisplayName Related catalog name String Finance machines
DesktopGroupDisplayName Related desktop group name String Finance
CreatedDate Machine creation date String 2018-03-16 14:16:07.008 +0200
ModifiedDate Machine modification date String 2018-03-16 14:16:07.008 +0200
Tags Configured tags String Germany
France

List of Calculated Fields

Field Description Data type Unit Example Where available
LifecycleStateDisplayName Lifecycle state name. Possible values: Active, Deleted, RequiresResolution, Stub String Active Splunk data model, Splunk SPL
IsVDA Indicates if machine is a VDA. Possible values: 0, 1. Is 1 if field MachineRoleDisplayName is either “Vda” or “Both” String 1 Splunk data model
IsVDANumber Indicates if machine is a VDA. Possible values: 0, 1. Is 1 if field MachineRoleDisplayName is either “Vda” or “Both” Number 1 Splunk data model
IsDDC Indicates if machine is a DDC. Possible values: 0, 1. Is 1 if field MachineRoleDisplayName is either “Ddc” or “Both” String 1 Splunk data model
IsRegistered Indicates if machine registered. Possible values: 0, 1,. Is 1 if field CurrentRegistrationState is 1. String 1 Splunk data model
IsRegisteredNumber Indicates if machine registered. Possible values: 0, 1,. Is 1 if field em>CurrentRegistrationState is 1. Number 1 Splunk data model
CurrentRegistrationStateDisplayName Current registration state. Possible values: Unknown, Registered, Unregistered String Registered Splunk data model, Splunk SPL
LastDeregisteredCodeDisplayName Machine’s last deregistration code. Possible values: too much to list here. Please have a look at the citrix_deregistrationreasoncode lookup. String ContactLost Splunk data model, Splunk SPL
CurrentPowerStateDisplayName Current power state. Possible values: Unknown, Unavailable, Off, On, Suspended, TurningOn, TurningOff, Suspending, Resuming, Unmanaged, NotSupported String Unmanaged Splunk data model, Splunk SPL
FunctionalLevelDisplayName Functional level. Possible values: Unknown, L5, L7, L7_6, L7_7, L7_8, L7_9 / MAX String L7_9 / MAX Splunk data model, Splunk SPL
WindowsConnectionSettingDisplayName Windows connection setting. Possible values: Unknown, LogonEnabled, Draining, DrainnigUntilRestart, LogonDisabled String Unknown Splunk data model, Splunk SPL
FaultStateDisplayName Fault state. Possible values: Unknown, None, FailedToStart, StuckOnBoot, Unregistered, MaxCapacity String None Splunk data model, Splunk SPL
MachineRoleDisplayName Machine role. Possible values: Vda, Ddc, Both String Both Splunk data model, Splunk SPL
TagsSplit Tags splitted by semicolon String Germany;France Splunk data model

Machine Catalogs

uberAgent collects metrics like catalog name and ID as well as site name for each machine catalog in a site.

Details

  • Source type: uberAgent:Citrix:Catalogs
  • Used in dashboards: Citrix Machines
  • Enabled through configuration setting: CitrixDCCatalog
  • Related configuration settings: n/a

List of Fields in the Raw Agent Data

Field Description Data type Unit Example
Id Machine catalog ID String 10
Name Machine catalog name String Finance machines
SiteName Related Citrix site name String vl-Site
SiteGuid Related Citrix site GUID String 0a0fda60-aebf-4ac0-920d-44bd509ca927
LifecycleState Lifecycle state. Possible values: 0, 1, 2 ,3 Number 0
ProvisioningType Provisioning type. Possible values: 0, 1, 2, 3 Number 1
PersistentUserChanges Indicates if and where user changes should be saved. Possible values: 0, 1, 2, 3 Number 1
IsMachinePhysical Indicates if machine catalog contains physical machines. Possible values: 0, 1 String 0
AllocationType Allocation type. Possible values: 0, 1, 2, 3 Number 2
SessionSupport Indicates a machine catalog’s session support. Possible values: 0, 1, 2 Number 1
CreatedDate Machine catalog creation date String 2018-03-16 14:16:07.008 +0200
ModifiedDate Machine catalog modification date String 2018-03-16 14:16:07.008 +0200

List of Calculated Fields

Field Description Data type Unit Example Where available
CatalogId Content of field Id String 10 Splunk data model
LifecycleStateDisplayName Lifecycle state name. Possible values: Active, Deleted, RequiresResolution, Stub String Active Splunk data model, Splunk SPL
ProvisioningTypeDisplayName Provisioning type. Possible values: Unknown, MCS, PVS, Manual String MCS Splunk data model, Splunk SPL
PersistentUserChangesDisplayName Indicates if and where user changes should be saved. Possible values: Unknown, Discard, OnLocal, OnPvd String Discard Splunk data model, Splunk SPL
AllocationTypeDisplayName Allocation type. Possible values: Unknown, Static, Random, Permanent String Random Splunk data model, Splunk SPL
SessionSupportDisplayName Indicates a machine catalog’s session support. Possible values: Unknown, SingleSession, MultiSession String SingleSession Splunk data model, Splunk SPL