- Introduction
- Guidelines
- Share the Love
- Contributing
- Bug Reports and Feature Requests
- Developing
- About uberAgent and ElasticSearch
- Configure uberAgent for ElasticSearch/OpenSearch
- Dashboards
Experimental support for Elasticsearch was added to uberAgent in version 3.6.0. This allows uberAgent to send data to Elasticsearch, which can then be visualized in Kibana. This repository contains community dashboards for Kibana and OpenSearch.
It is part of our XOAP Automation Forces Open Source community library to give you a quick start into Infrastructure as Code deployments with Terraform.
You can read about the details here: https://uberagent.com/blog/uberagent-3-6-brings-support-elasticsearch/
We have a lot of Terraform modules, PowerShell DSC and Packer configurations that are Open Source and maintained by the XOAP staff.
Please check the links for more information:
We are using the following guidelines to write code and make it easier for everyone to follow a distinctive guideline. Please check these links before starting to work on changes.
Git Naming Conventions are an important part of the development process. They describe how Branches, Commit Messages, Pull Requests and Tags should look like to make them easily understandable for everybody in the development chain.
He Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.
The better a Pull Request description is, the better a review can understand and decide on how to review the changes. This improves implementation speed and reduces communication between the requester, and the reviewer is resulting in much less overhead.
Writing A Great Pull Request Description
Versioning is a crucial part for Terraform Stacks and Modules. Without version tags you cannot clearly create a stable environment and be sure that your latest changes will not crash your production environment (sure it still can happen, but we are trying our best to implement everything that we can to reduce the risk)
Like this project? Please give it a ★ on our GitHub! It helps us a lot.
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project, we would love to hear from you! Email us.
PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
The uberAgent does not deliver dashboards for Kibana or OpenSearch. So we at XOAP thought it would be a good idea to start with it. We implemented a lot of dashboards in the past months and have decided to make those available to the community. This way the community can collaborate on them and bring them to the next level together.
The configuration for an Elasticsearch OpenSearch connection is done in the uberAgent configuration file. The default location for the configuration file is:
[Receiver]
Name = Default
Type = Elasticsearch
Protocol = HTTP
Servers = http://servername:9200
# The setting RESTToken is required if X-Pack security is enabled. It is enabled by default since Elasticsearch version 8.
RESTToken = username:password
Read more about the ElasticSearch installation here: https://uberagent.com/docs/uberagent/latest/installation/backend/installing-elasticsearch/
uberAgent uses libCurl for communication/transfer.
So if you are using a proxy inside your company, you need to configure the client as below:
-
Two system variables have to be set in order to make uberAgent work with a proxy
- http_proxy address:port
- https_proxy address:port
You can set them easily with PowerShell:
[Environment]::SetEnvironmentVariable("http_proxy", "$null", "Machine")
[Environment]::SetEnvironmentVariable("https_proxy", "$null", "Machine")This is the list of available dashboards.
These dashboards are meant to be used in a local Kibana or a hosted OpenSearch instance.
This dashboard lets you interactively analyze any filtered subset of your data over time.
We created more than one dashboard in OpenSearch to show all the available data.
This dashboard displays information about application errors (crashes and hangs).
This dashboard displays inventory information about the installed applications.
This dashboard displays information about reconnections, retransmissions and failed TCP network connections. It can be used to identify application misconfigurations, missing firewall rules or network and service outages.
This dashboard displays information about times of unresponsiveness, i.e. when application user interfaces do not react to user input. Events are generated every time applications do not process window messages for 200 ms (or longer).
This dashboard displays information about actual application usage.
This dashboard displays information about applications, services and drivers that caused boot delays. The events that are processed here are generated only when a delay occurs. The data displayed here does not reflect typical boot processes.
This dashboard displays information about the duration of system boots. A boot process starts when Windows is loading and is finished when the desktop is displayed and the load has dropped to 20%.
This dashboard displays detailed information about Chrome's resource usage by process type. The most common process types are: browser (main process), tab (rendering), GPU (GPU acceleration), extension (runs extensions), flash (runs Flash).
This dashboard displays the resources consumed per website. Each site's performance is calculated across all user sessions and instances of Internet Explorer.
This dashboard displays detailed information for page loads and background data transfers (XMLHttpRequests and web socket handshake requests). Data is collected via browser extensions, which must be installed in addition to the endpoint agent. "Tab URL" stands for the URL entered in the browser's address bar; "Request URL" stands for an address the browser exchanged data with.
This dashboard displays information about web app as well as browser usage. Data is collected via browser extensions, which must be installed in addition to the endpoint agent.
This dashboard displays performance information about Citrix ADC appliances monitored with uberAgent. uberAgent only collects performance data from the primary Citrix ADC.
This dashboard displays information about gateways on Citrix ADCs monitored with uberAgent. uberAgent only collects performance data from the primary Citrix ADC.
This dashboard displays inventory information about the Citrix ADCs monitored with uberAgent. uberAgent collects inventory data from the primary as well as secondary Citrix ADC.
This dashboard displays performance information about virtual servers on Citrix ADCs monitored with uberAgent. uberAgent only collects performance data from the primary Citrix ADC.
This dashboard displays detailed information about published applications and desktops in Citrix XenApp/XenDesktop. It requires uberAgent to be installed on at least one delivery controller per site (XA/XD 7.6 or newer).
This dashboard displays detailed information about Citrix XenApp/XenDesktop databases. It requires uberAgent to be installed on at least one delivery controller per site (XA/XD 7.6 or newer).
This dashboard displays detailed information about Citrix XenApp/XenDesktop licensing. It requires uberAgent to be installed on at least one delivery controller per site (XA/XD 7.6 or newer).
This dashboard displays detailed information about machines in Citrix XenApp/XenDesktop sites. It requires uberAgent to be installed on at least one delivery controller per site (XA/XD 7.6 or newer).
This dashboard displays information about the volume of data generated by uberAgent. It is based on data from license_usage.log, stored in the _internal index on the Splunk license master. If this dashboard is empty, configure forwarding of the license master's _internal index to your indexers. In larger implementations the data volume cannot be determined per individual host due to squashing. Please note that enabling ESA also increases the UXM data volume because additional fields are populated in UXM sourcetypes, too.
This dashboard displays a high level overview of your environment. The lowest score is 0.0. The highest score is 10.0. The higher, the better. The data is updated every full and half hour. Click on a value of interest, to get a drilldown.
This dashboard displays information about the licensing status of uberAgent. It can only display information about licenses that are in use. If you have licenses on your machines that are not currently used they will not appear here.
This dashboard displays detailed information about GPU usage per machine.
This dashboard displays inventory information about the endpoints monitored with uberAgent.
This dashboard displays network configuration information about the endpoints monitored with uberAgent.
This dashboard displays detailed information about machine performance. The terms 'machine' and 'host' are used interchangeably.
This dashboard displays information about disk drives and volumes.
This dashboard shows each host's uptime (days since last boot).
This dashboard displays detailed information about network communication per application, process, host, target or user.
This dashboard displays information about the load performance of Microsoft Outlook plugins.
This dashboard displays detailed information about GPU usage per application or process.
This dashboard displays detailed information about process performance.
This dashboard displays detailed information about process startup performance.
This dashboard displays relevant information for sizing server-based computing farms (RDS/XenApp).
This dashboard displays detailed information about session 0 on all machines. Sesssion 0 is the session that is used for services and user-mode drivers.
This dashboard displays detailed information about Citrix ICA/HDX sessions.
This dashboard displays detailed information about VMware RDP/PCoIP sessions.
This dashboard displays information about applications, services and drivers that caused shutdown delays. The events that are processed here are generated only when a delay occurs. The data displayed here does not reflect typical shutdown processes.
This dashboard displays information about the duration of system shutdowns. The events that are processed here are generated only when a delay occurs. The data displayed here does not necessarily reflect typical shutdown processes.
This dashboard displays the installed versions of a specific application over time. It also shows detailed information about each installation. Please note that inventory information is only collected once per 24 hour period by default.
This dashboard displays detailed information about a specific application's performance.
This dashboard displays information about a specific boot process.
This dashboard displays details for a Citrix ADC. Please note that inventory information is only collected once per 24 hour period by default. uberAgent collects inventory data from the primary as well as secondary Citrix ADC.
This dashboard displays all available information about one specific logoff.
This dashboard displays all available information about one specific logon.
This dashboard displays the number of application installations over time. It also shows detailed information about each installed application and each installed software update. Please note that inventory information is only collected once per 24 hour period by default.
This dashboard displays the install count of a specific update over time. It also shows detailed information about each installation. Please note that inventory information is only collected once per 24 hour period by default.
This dashboard displays detailed information about a specific user account.
This dashboard displays performance information about virtual servers and bound services as well as service groups. uberAgent only collects performance data from the primary Citrix ADC.
This dashboard displays information about the performance of SMB connections to shares on the network.
This dashboard displays information about applications, services and drivers that caused delays while entering or resuming from standby. The events that are processed here are generated only when a delay occurs. The data displayed here does not reflect typical standby or resume processes.
This dashboard displays information about the duration of system standby and resume processes.
This dashboard displays detailed information about three different types of stop errors: blue screen of death, hard power off and random restart. A blue screen is displayed when the system detects it cannot continue due to an error condition and stops after collecting rudimentary information. A hard power off happens when the user presses and holds the power button for at least 4 seconds. A random restart may be due to power loss or a hard hang; in either case the system cannot generate a blue screen any more.
This dashboard shows which uberAgent versions are active on the endpoints.
This dashboard displays inventory information about the installed software updates. The Windows 10 OS build number reflects a machine's update state in a single number.
This dashboard displays information about the duration of user logoffs.
This dashboard displays information about the duration of user logons.
This dashboard displays detailed group policy processing times.
This dashboard displays a session status overview. Many more detailed dashboards can be accessed through the menu above.
This dashboard displays detailed information about user sessions.
