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!
uberAgent Config & Support Tool
The uberAgent Config & Support Tool simplifies the configuration process for uberAgent, allowing you to set up a proof-of-concept installation with minimal effort.
System Requirements
- Windows 10, build 1607 or later
Download and Installation
- Install uberAgent before proceeding.
- Download the uberAgent Config & Support Tool from the Citrix Observability website.
- Once the download has finished, launch the tool.
Creating a Support Bundle
To generate an uberAgent support bundle, select the “Create Support Bundle” button. Upon completion, you’ll receive a notification, and the bundle will be saved to your desktop.
Configuring uberAgent
The Configuration Dialog can be used to configure a local uberAgent installation or to create configuration archives that can be used for Central Config File Management (CCFM).
1. Open the Configuration Dialog
Click on the “Configure uberAgent” button in the main window to open the configuration dialog.
2. Select the Configuration Source
-
Web/GitHub: the tool downloads the configuration templates from the specified URL.
- By default, it downloads the corresponding version from the uberAgent config GitHub repository.
-
Local: Uses a template archive from the local disk.
- When using Local, click Browse to locate and select a configuration archive.
3. (Optional) Enable Data Volume Optimization
The “Use Data Volume Optimized Config” option activates an optimized configuration designed to minimize data transmission volume. This is especially beneficial when reducing costs is a priority.
However, this optimization comes with a trade-off: instead of sending data for all processes, only the top five processes per category are transmitted. Additionally, data collection intervals are extended, leading to greater smoothing of peaks, making them less visible.
For more information, see Reducing the Data Volume.
4. Select a Receiver Type
The Receiver Type specifies the backend to which uberAgent sends the collected data. The available options are:
- Splunk
- Elasticsearch
- OMS Log Analytics
- Kafka
- Azure Event Hubs
Configuration for each Receiver Type
Splunk
-
Protocol: Choose either
HTTPorTCP. -
Servers: Specify the Splunk server address (e.g.,
https://server1:portfor HTTP, orserver1:portfor TCP). - REST Token: Enter the Splunk HTTP Event Collector (HEC) token (required for HTTP).
- Disable Certificate Validation: Enable this option if you are using a Splunk Cloud trial instance, as the HEC certificate will likely not be trusted on your machines (not recommended for production use).
- Use Default uberAgent Index: If you want to use a different Splunk index than the default, uncheck this option.
For more details, see Configuring Splunk’s HTTP Event Collector.
Elasticsearch
-
Servers: Enter the Elasticsearch endpoint (e.g.,
https://server1:port). -
REST Token: Provide the authentication token in the format
username:password.
For more details, see Installing and Configuring Elasticsearch & Kibana.
Azure Monitor (OMS Log Analytics)
- Servers: Enter the Log Analytics workspace endpoint.
- REST Token: Provide the workspace key for authentication.
For more details, see Configuring Microsoft Azure Monitor.
Kafka
-
Servers: Enter the Kafka broker addresses (e.g.,
https://server1:port). -
TLS Client Certificate: Specify the certificate path in the format
<store location>\<store name>\<thumbprint>.
For more details, see Configuring Apache Kafka & Confluent REST Proxy.
Azure Event Hubs
- Event Hubs Namespace: Enter the namespace.
- Hub Name: Specify the hub name.
- Tenant ID: Enter the Azure Tenant ID.
- Client ID: Provide the Client ID for authentication.
- Client Secret: Enter the authentication secret.
For more details, see Configuring Microsoft Azure Data Explorer (ADX) & Azure Event Hubs.
5. (Optional) Select License File
When a license file is selected, the tool automatically copies it to the uberAgent installation directory. This ensures that the service can start immediately after applying the configuration.
If you only plan to create a configuration archive for Central Config File Management (CCFM), it is not necessary to specify a license file. The generated archive does not include a license. The target machines must have a valid license file in their uberAgent installation directory for the service to work.
6. Apply and Save the Configuration
Once the configuration has been defined, you have two options for applying or saving it:
Apply the Configuration
Selecting Apply immediately applies the configuration to the locally installed uberAgent installation.
-
If a valid license file is already present in the installation directory or has been specified within the tool’s UI, the tool will also automatically start the uberAgent service.
-
If no valid license file is found or specified, the service will not start. In this case, you must manually copy a valid license file to the uberAgent installation directory before the service can be started.
Create Config Archive
Selecting Create Config Archive generates a configuration archive without applying it to the local system. This is especially useful for Central Config File Management (CCFM) deployments, where configurations are distributed to multiple machines.
No license file is required when creating the archive. However, for uberAgent to function on the target machines, a valid license file must be present in the installation directory of each system where it is deployed.
For more details, see Central Config File Management (CCFM).
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.