The latest version of CDFMonitor 2.1.0.101 has been checked in for internal review and will be released officially as an update to CTX129537. This version has many new features and improvements, but the main one is now there is a GUI to set all configurations and perform activities. As in prior versions, command line use is still available.

Please note since this utility is currently under review, it has NOT been officially approved by Citrix.

Consider this an early release that may or may not change from the official version in CTX129537.

Use only until the engineering review is complete and CTXs are published externally.

New in 2.1 :

  • multiple bug fixes from prior release.
  • better performance.
  • built-in TMF ‘archive’ search to minimize ‘missing id in existing tmf’.
  • much smaller memory footprint in most configurations including parsing.
  • ability to monitor process creation and deletion by enabling option on ‘logging’ tab.
  • additional fields on ‘network’ tab to help properly configure and monitor remote tracing.

Documentation and binary for early release are available here:

https://citrix.sharefile.com/d/se947ef6c9534e8ca

Two CTX documents will be published:

CTX129537 for tool download

CTX139593 for tool documentation

CDFMonitor

Created Date: July 2011

Updated Date: February 2014

Description

CDFMonitor is a small, lightweight, multipurpose utility used in conjunction with Citrix Diagnostics Facility (CDF) tracing to troubleshoot as well as monitor Citrix products. Some of the features are the ability to monitor for a certain trace message, execute an action for a certain trace message, and notify when a message occurs. It can run as a user process or as a service from either a console or from a GUI. Built-in to the utility is the ability to parse and view captured trace files saved in .etl native format using Citrix TMF’s. For viewing trace messages real-time or post capture, the Output tab optionally displays all messages and can be filtered.

All configuration information is stored in a .net exe.config file for ease of setup and deployment. The utility has many possible configurations but only the appropriate ones are enabled based on the activity that is currently selected. There are two views, simple and advanced, as depending on the activity not all options are necessary.

For logging of traces, there are many options including local, remote, or network. A permanent service can be installed using a ring buffer as a long term logging solution for example. Some configurations have requirements that restrict or prohibit data logging on the local device. Using CDFMonitor can alleviate these issues by filtering what data gets logged in addition to sending trace information directly over the network to a ‘server’ instance.

Prerequisites

  • Windows OS
  • .Net 3.5+
  • WMI (for remote management only)
  • Access to administrative shares (for remote management only)
  • An installed Citrix product that uses CDF tracing

Installing CDFMonitor

By default CDFMonitor is not installed. It is an executable with a configuration file that can be started directly. Optionally CDFMonitor can be installed as a service and file type association can be configured for .etl files.

To install CDFMonitor as a service (after configuring applicable settings):

  1. Start CDFMonitor.exe
  2. Select ‘Options’ tab
  3. Select ‘Install Service’

To register File Type Association

  1. Start CDFMonitor.exe
  2. Select ‘Options’ tab and maximize window
  3. Select ‘FTA Config’
  4. Select ‘Register FTA’

 

How to Use CDFMonitor

See pdf in download.

 

Security Permissions Required by CDFMonitor

CDF tracing is based on Event Tracing for Windows (ETW) which requires administrative privilege’s to use and manage.

Data Modified by CDFMonitor

List all changes to files/file systems. – none

List all changes to any registry values. – none

List all changes to database information. – none

How to Undo the Changes Made by CDFMonitor

CDFMonitor does not modify anything on the OS aside from what is stated in section ‘Installing CDFMonitor’. See ‘Uninstalling CDFMonitor’ for additional information.

Uninstalling CDFMonitor

By default CDFMonitor is not installed. It is an executable with a configuration file that can be started directly. Optionally CDFMonitor can be installed as a service and file type association can be configured for .etl files.

To uninstall CDFMonitor as a service:

  1. Start CDFMonitor.exe
  2. Select ‘Options’ tab
  3. Select ‘Uninstall Service’

To unregister File Type Association

  1. Start CDFMonitor.exe
  2. Select ‘Options’ tab and maximize window
  3. Select ‘Unregister FTA’