---
title: Citrix Hypervisor
description: Monitor the health and performance of a Citrix Hypervisor host.
breadcrumbs: Docs > Integrations > Citrix Hypervisor
---

# Citrix Hypervisor
Supported OS Integration version6.4.0
## Overview{% #overview %}

This check monitors [Citrix Hypervisor](https://www.citrix.com/products/citrix-hypervisor/) through the Datadog Agent.

**Minimum Agent version:** 7.32.0

## Setup{% #setup %}

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the [Autodiscovery Integration Templates](https://docs.datadoghq.com/agent/kubernetes/integrations.md) for guidance on applying these instructions.

### Installation{% #installation %}

The Citrix Hypervisor check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package. No additional installation is needed on your server.The recommended way to monitor Citrix hypervisors is to install one Datadog Agent on each hypervisor.

#### Datadog user{% #datadog-user %}

The Citrix Hypervisor integration requires a user with at least [`read-only`](https://docs.citrix.com/en-us/xencenter/7-1/rbac-roles.html) access to monitor the service.

### Configuration{% #configuration %}

#### Host{% #host %}

1. Edit the `citrix_hypervisor.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Citrix Hypervisor performance data. See the [sample citrix_hypervisor.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/citrix_hypervisor/datadog_checks/citrix_hypervisor/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent).

#### Log collection{% #log-collection %}

*Available for Agent versions >6.0*

1. Collecting logs is disabled by default in the Datadog Agent. Enable it in `datadog.yaml`:

   ```yaml
   logs_enabled: true
   ```

1. Add this configuration block to your `citrix_hypervisor.d/conf.yaml` file to start collecting your Citrix Hypervisor logs:

   ```yaml
   logs:
   - type: file
     path: /var/log/xensource.log
     source: citrix_hypervisor
   ```

Change the `path` value and configure it for your environment. See the [sample `citrix_hypervisor.d/conf.yaml` file](https://github.com/DataDog/integrations-core/blob/master/citrix_hypervisor/datadog_checks/citrix_hypervisor/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent).

### Validation{% #validation %}

[Run the Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `citrix_hypervisor` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #metrics %}

|  |
|  |
| **citrix\_hypervisor.host.cache\_hits**(gauge)             | IntelliCache hits on storage repository*Shown as hit*    |
| **citrix\_hypervisor.host.cache\_misses**(gauge)           | IntelliCache misses on storage repository*Shown as miss* |
| **citrix\_hypervisor.host.cache\_size**(gauge)             | IntelliCache size storage repository                     |
| **citrix\_hypervisor.host.cpu**(gauge)                     | Average CPU usage*Shown as percent*                      |
| **citrix\_hypervisor.host.memory.free\_kib**(gauge)        | Memory available on hypervisor*Shown as kibibyte*        |
| **citrix\_hypervisor.host.memory.reclaimed**(gauge)        | Reclaimed memory on hypervisor                           |
| **citrix\_hypervisor.host.memory.reclaimed\_max**(gauge)   | Max reclaimed memory on hypervisor                       |
| **citrix\_hypervisor.host.memory.total\_kib**(gauge)       | Total memory on hypervisor*Shown as kibibyte*            |
| **citrix\_hypervisor.host.pif.rx**(gauge)                  | Network interface kib received*Shown as kibibyte*        |
| **citrix\_hypervisor.host.pif.tx**(gauge)                  | Network interface kib sent*Shown as kibibyte*            |
| **citrix\_hypervisor.host.pool.session\_count**(gauge)     | Number of sessinon in resource pool*Shown as session*    |
| **citrix\_hypervisor.host.pool.task\_count**(gauge)        | Number of task in resource pool*Shown as task*           |
| **citrix\_hypervisor.host.xapi.allocation\_kib**(gauge)    | XAPI memory allocation*Shown as kibibyte*                |
| **citrix\_hypervisor.host.xapi.free\_memory\_kib**(gauge)  | XAPI memory available*Shown as kibibyte*                 |
| **citrix\_hypervisor.host.xapi.live\_memory\_kib**(gauge)  | XAPI live memory*Shown as kibibyte*                      |
| **citrix\_hypervisor.host.xapi.memory\_usage\_kib**(gauge) | XAPI memory usage*Shown as kibibyte*                     |
| **citrix\_hypervisor.host.xapi.open\_fds**(gauge)          | XAPI opened file descriptors                             |
| **citrix\_hypervisor.vm.cpu**(gauge)                       | VM CPU usage*Shown as percent*                           |
| **citrix\_hypervisor.vm.memory**(gauge)                    | VM memory usage*Shown as kibibyte*                       |

### Events{% #events %}

The Citrix Hypervisor integration does not include any events.

### Service Checks{% #service-checks %}

**citrix\_hypervisor.can\_connect**

Returns `CRITICAL` if the Agent is unable to reach the RRD endpoint. Returns `OK` otherwise.

*Statuses: ok, critical*

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).

## Further Reading{% #further-reading %}

- [Monitor Citrix Hypervisor performance with Datadog](https://www.datadoghq.com/blog/monitor-citrix-hypervisor-datadog/)