Citrix Hypervisor

Supported OS Linux Windows

Integrationv2.2.0

Overview

This check monitors Citrix Hypervisor through the Datadog Agent.

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 for guidance on applying these instructions.

Installation

The Citrix Hypervisor check is included in the Datadog Agent 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

The Citrix Hypervisor integration requires a user with at least read-only access to monitor the service.

Configuration

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 for all available configuration options.

  2. Restart the Agent.

Log collection

Available for Agent versions >6.0

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

    logs_enabled: true
    
  2. Add this configuration block to your citrix_hypervisor.d/conf.yaml file to start collecting your Citrix Hypervisor logs:

    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 for all available configuration options.

  3. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for citrix_hypervisor under the Checks section.

Data Collected

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

The Citrix Hypervisor integration does not include any events.

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

Need help? Contact Datadog support.

Further reading

Additional helpful documentation, links, and articles: