uberAgent
-
-
-
-
-
Citrix Session Metrics
This content has been machine translated dynamically.
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Citrix Session Metrics
July 19, 2024
Contributed by:
C
Virtual Channel Detail
uberAgent collects the input and output data volume for every virtual channel per Citrix session.
Details
- Source type:
uberAgent:CitrixSession:VirtualChannelDetail -
Used in dashboards: Citrix Session Protocol Insights, Single User Detail, Analyze data over time
- Enabled through configuration setting:
CitrixSessionVirtualChannelDetail - Related configuration settings: CitrixSessionConfig
List of Fields in the Raw Agent Data
| Field | Description | Data type | Unit | Example | Platform |
|---|---|---|---|---|---|
| SessionGUID | Unique identifier that is generated by uberAgent when the session is created. Valid for this session only. | String | 00000002-f295-9109-e7c7-c964011dd401 | Windows | |
| SessionUser | User name. | String | Domain\JohnDoe | Windows | |
| VirtualChannelVendorName | A unique identifier for a virtual channel. | String | CTXTW | Windows | |
| VirtualChannelDataVolumeInputMB | Amount of data volume received by the session per virtual channel. | Number | MB | 1 | Windows |
| VirtualChannelDataVolumeOutputMB | Amount of data volume sent by the session per virtual channel. | Number | MB | 10 | Windows |
List of Calculated Fields
| Field | Description | Data type | Unit | Example | Where available |
|---|---|---|---|---|---|
| VirtualChannelDataVolumeInputOutputMB | Total virtual channel data volume. | Number | MB | 11 | Splunk data model |
| VirtualChannelDisplayName | Descriptive virtual channel name. Possible values: too many to list here. Please check the lookup file citrixsession_virtualchannels.csv. |
String | Thinwire Graphics | SPL | |
| VirtualChannel | Content of VirtualChannelDisplayName. If VirtualChannelDisplayName is not filled, VirtualChannelVendorName is used instead. |
String | Thinwire Graphics | Splunk data model |
Session Config
uberAgent collects detailed information about applied Citrix HDX policies and important active session settings.
Details
- Source type:
uberAgent:CitrixSession:SessionConfig - Used in dashboards: Citrix Session Configuration Details, Single User Detail
- Enabled through configuration setting:
CitrixSessionConfig - Related configuration settings: CitrixSessionVirtualChannelDetail, TriggerCitrixSessionConfig
List of Fields in the Raw Agent Data
| Field | Description | Data type | Unit | Example | Platform |
|---|---|---|---|---|---|
| SessionGUID | Unique identifier that is generated by uberAgent when the session is created. Valid for this session only. | String | 00000002-f295-9109-e7c7-c964011dd401 | Windows | |
| SessionUser | User name. | String | Domain\JohnDoe | Windows | |
| AudioActualPriority | Applied virtual channel priority for audio. | String | RealTime | Windows | |
| AudioPolicyAllowMicrophoneRedirection | Citrix policy to allow/deny microphone redirection. | String | 1 | Windows | |
| AudioPolicyAllowRedirection | Citrix policy to allow/deny audio redirection. | String | 1 | Windows | |
| AudioPolicyPriority | Citrix policy to set the virtual channel priority. | String | RealTime | Windows | |
| AudioPolicySoundQuality | Citrix policy to configure the sound quality. | String | High | Windows | |
| CdmActualPriority | Applied virtual channel priority for client drive mapping. | String | Medium | Windows | |
| CdmVolumes | Volumes the client mapped into the session. | String | Local Disk (C: on MACHINE1) | Windows | |
| CdmPolicyAllowDriveRedirection | Citrix policy to allow/deny client drive mapping. | String | 1 | Windows | |
| CdmPolicyPriority | Citrix policy to set the virtual channel priority. | String | Medium | Windows | |
| CdmPolicyReadOnly | Citrix policy to allow/deny read-only client drive access. | String | 1 | Windows | |
| DisplayMode | Active display mode. See DisplayModeName for details. |
Number | 4 | Windows | |
| ThinwireActualPriority | Applied virtual channel priority for this display mode. | String | High | Windows | |
| ThinwireColorDepth | Applied session color depth. | Number | bit | 24 | Windows |
| ThinwireComponentEncoder | Applied video component encoder. | String | DeepCompressionV2Encoder | Windows | |
| ThinwireHardwareEncodeInUse | See if hardware encode is actually in use. | String | 1 | Windows | |
| ThinwireVideoCodecType | Applied video codec type. | String | H264 | Windows | |
| ThinwireColorspace | Applied session color space. | String | Yuv420 | Windows | |
| ThinwireVideoCodecUse | Applied video codec usage setting. | String | For actively changing regions | Windows | |
| ThinwirePolicyFps | Citrix policy to configure the maximum session FPS. | Number | 30 | Windows | |
| ThinwirePolicyPriority | Citrix policy to set the virtual channel priority. | String | High | Windows | |
| ThinwirePolicyUseHardwareEncoding | Citrix policy to enable/disable hardware encoding. | String | 1 | Windows | |
| ThinwirePolicyUseVideoCodec | Citrix policy to configure the video codec. | String | UseVideoCodecIfPreferred | Windows | |
| ThinwirePolicyVisualQuality | Citrix policy to configure the visual quality. | String | Medium | Windows | |
| FramehawkActualPriority | Applied virtual channel priority for this display mode. | String | High | Windows | |
| FramehawkPolicyPriority | Citrix policy to set the virtual channel priority. | String | High | Windows | |
| D3DActualPriority | Applied virtual channel priority for this display mode. | String | High | Windows | |
| D3DPolicyAeroRedirection | Citrix policy to enable/disable DCR aero redirection. | String | 1 | Windows | |
| D3DPolicyGraphicsQuality | Citrix policy to configure the DCR graphics quality. | String | Medium | Windows | |
| D3DPolicyPriority | Citrix policy to set the virtual channel priority. | String | High | Windows | |
| GraphicsActualPriority | Applied virtual channel priority for this display mode. | String | High | Windows | |
| GraphicsPolicyDisplayDegradeNotifyUser | Citrix policy to notify the user about display quality degradation. | String | 1 | Windows | |
| GraphicsPolicyDisplayDegradePolicy | Citrix policy to configure the display quality degradation. | String | DEGRADE_RESOLUTION_FIRST | Windows | |
| GraphicsPolicyPriority | Citrix policy to set the virtual channel priority. | String | High | Windows | |
| NetworkConnectedVia | IP address the session connected from. This is the same information as shown in Citrix Director. | String | 10.1.1.150 | Windows | |
| NetworkEdtMtu | Applied Enlightened Data Transport MTU size. | Number | 1400 | Windows | |
| NetworkPolicyAcceptSessionReliabilityConnections | Citrix policy to enable/disable session reliability. | String | 1 | Windows | |
| NetworkPolicyICAListenerPortNumber | Citrix policy to configure the ICA listener port. | Number | 1494 | Windows | |
| NetworkPolicySessionReliabilityPort | Citrix policy to configure the session reliability port. | Number | 2598 | Windows | |
| NetworkPolicySessionReliabilityTimeout | Citrix policy to configure the session reliability timeout. | Number | s | 180 | Windows |
| PrinterActualPriority | Applied virtual channel priority for printing. | String | Low | Windows | |
| PrinterSessionPrinter | All mapped session printers. | String | Microsoft Print to PDF (from MACHINE1) in session 9 | Windows | |
| PrinterPolicyAllowRedirection | Citrix policy to allow/deny printer redirection. | String | 1 | Windows | |
| PrinterPolicyAllowRedirection | Citrix policy to allow/deny printer redirection. | String | Allowed | Windows | |
| PrinterPolicyAutoCreateClientPrinters | Citrix policy to configure printer auto-creation. See PrinterPolicyAutoCreateClientPrintersDisplayName for details. |
Number | 3 | Windows | |
| PrinterPolicyPriority | Citrix policy to set the virtual channel priority. | String | Low | Windows | |
| USBActualPriority | Applied virtual channel priority for USB devices. | String | Medium | Windows | |
| USBPolicyAllowPNPRedirection | Citrix policy to allow/deny PNP redirection. | String | 1 | Windows | |
| USBPolicyAllowUSBSupport | Citrix policy to allow/deny USB support. | String | 1 | Windows | |
| USBPolicyPriority | Citrix policy to set the virtual channel priority. | String | Medium | Windows |
List of Calculated Fields
| Field | Description | Data type | Unit | Example | Where available |
|---|---|---|---|---|---|
| DisplayModeName | Descriptive display mode name. Possible values: Thinwire, Framehawk, DCR, Legacy Graphics. |
String | Thinwire | SPL | |
| PrinterPolicyAutoCreateClientPrintersDisplayName | Descriptive name of how client printer creation is configured. Possible values: Do not auto-create client printers, Auto-create the client's default printer only, Auto-create local (non-network) client printers only, Auto-create all client printers. |
String | Auto-create the client’s default printer only | SPL |
The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.
DIESER DIENST KANN ÜBERSETZUNGEN ENTHALTEN, DIE VON GOOGLE BEREITGESTELLT WERDEN. GOOGLE LEHNT JEDE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG IN BEZUG AUF DIE ÜBERSETZUNGEN AB, EINSCHLIESSLICH JEGLICHER GEWÄHRLEISTUNG DER GENAUIGKEIT, ZUVERLÄSSIGKEIT UND JEGLICHER STILLSCHWEIGENDEN GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT, DER EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND DER NICHTVERLETZUNG VON RECHTEN DRITTER.
CE SERVICE PEUT CONTENIR DES TRADUCTIONS FOURNIES PAR GOOGLE. GOOGLE EXCLUT TOUTE GARANTIE RELATIVE AUX TRADUCTIONS, EXPRESSE OU IMPLICITE, Y COMPRIS TOUTE GARANTIE D'EXACTITUDE, DE FIABILITÉ ET TOUTE GARANTIE IMPLICITE DE QUALITÉ MARCHANDE, D'ADÉQUATION À UN USAGE PARTICULIER ET D'ABSENCE DE CONTREFAÇON.
ESTE SERVICIO PUEDE CONTENER TRADUCCIONES CON TECNOLOGÍA DE GOOGLE. GOOGLE RENUNCIA A TODAS LAS GARANTÍAS RELACIONADAS CON LAS TRADUCCIONES, TANTO IMPLÍCITAS COMO EXPLÍCITAS, INCLUIDAS LAS GARANTÍAS DE EXACTITUD, FIABILIDAD Y OTRAS GARANTÍAS IMPLÍCITAS DE COMERCIABILIDAD, IDONEIDAD PARA UN FIN EN PARTICULAR Y AUSENCIA DE INFRACCIÓN DE DERECHOS.
本服务可能包含由 Google 提供技术支持的翻译。Google 对这些翻译内容不做任何明示或暗示的保证，包括对准确性、可靠性的任何保证以及对适销性、特定用途的适用性和非侵权性的任何暗示保证。
このサービスには、Google が提供する翻訳が含まれている可能性があります。Google は翻訳について、明示的か黙示的かを問わず、精度と信頼性に関するあらゆる保証、および商品性、特定目的への適合性、第三者の権利を侵害しないことに関するあらゆる黙示的保証を含め、一切保証しません。
ESTE SERVIÇO PODE CONTER TRADUÇÕES FORNECIDAS PELO GOOGLE. O GOOGLE SE EXIME DE TODAS AS GARANTIAS RELACIONADAS COM AS TRADUÇÕES, EXPRESSAS OU IMPLÍCITAS, INCLUINDO QUALQUER GARANTIA DE PRECISÃO, CONFIABILIDADE E QUALQUER GARANTIA IMPLÍCITA DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM PROPÓSITO ESPECÍFICO E NÃO INFRAÇÃO.
Was this helpful
This content has been machine translated dynamically.
July 19, 2024
Contributed by:
C
Share
July 19, 2024
Contributed by:
C
Share
In this article
Was this helpful
Citrix
Preview Documentation
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.
Send us your feedback
Machine Translation Feedback Form
YES
NO
Copied!
Failed!