VMware Horizon View Events Database Export Utilty

Update 4/29/15 

This utility is now available for download as a VMware Fling!

https://labs.vmware.com/flings/horizon-view-events-database-export-utility

Update 2/9/15 – Version 1.5 available for download.

New Features:

  • Added pool filtering
  • Added Client IP address output (from BROKER_USERLOGGEDIN event type)
  • Additional fixes, debugging and error trapping

Download and try it out today!  As always, please reach out to me with issues and suggestions.

Also check out a great article on this utility from my friend and EUC Rockstar Stephane Asselin:   http://myeuc.net/2015/01/29/the-big-easy-button/


Background:

The VMware View Events Database is used to record all events that happen in a View environment.   There is a ton of great information in the database, but it can be difficult to extract.   I wrote the View Event Notifier  last year which provides for real-time alerting, but it doesn’t allow for a lot of filtering.  I wrote this utility to allow administrators to easily apply very detailed filtering to the data and export it to .csv.  You can filter on time range,  event severity, event source, session type (Application or Desktop), Usernames and Event Types.   The application allows for extremely granular export of data.   The exported columns can also be customized and the application will export data from both the live and the historical tables in the View Events Database.

Prerequisites:

  • Single application .exe that only requires the Microsoft .NET 3.5 Framework
  • At least DB Reader access to the View Events DB via SQL or Windows authentication

Usage:

When you open the application the first time you will need to establish a connection to an existing View Events DB.  You can choose to authenticate via SQL or Windows authentication, depending on what your SQL server is currently configured for.  This connection data is stored in the registry under HKCU\Software dynamically as you type in the settings.   The password if using SQL Authentication is encrypted in the registry.

SQL Auth Type:  Choose Windows or SQL.  Windows will pass through the credentials of the currently logged in user.

DB Server:  The address to the SQL server along with the instance name if required.  server\instance

Database:  The name of the View Events Database

Username:  The SQL username with at least read access to the DB if using SQL Authentication.

Password:  The SQL password if using SQL Authentication.   The password is encrypted when stored.

Table Prefix:  View allows the use of a table prefix so you can monitor multiple view instances from the same database.   If table prefix is used, type it in.

Click “Test Connection”  – this will initiate a connection to the database and indicate success or any connection issues.  If any required data is missing you will be notified as to what information must be entered in order to connect to the SQL DB.

Screen Shot 2015-02-09 at 2.54.37 PM

Screen Shot 2015-02-09 at 3.15.50 PM

Screen Shot 2015-02-09 at 3.15.35 PM

When you are able to connect to the database successfully, click the “Connect to DBServer” button at the bottom of the form.  You are now connected to the View Events DB.  The button will indicate connection state.  You can click the button again to disconnect from the DB server.

Screen Shot 2015-01-26 at 10.47.48 AM

Filtering Data:

As mentioned earlier the application allows for many layers of filtering of the View Event data before export.

General Filtering

The general filtering tab allows for high-level filters to be set that will apply to the data as it is queried and exported.

Query Historical Data:  By checking the “Query Historical Data” checkbox, the application will use the historical tables in the View Events DB to query older data.

Time Range:  The time range will automatically be populated with the time of the first and last event in the View Events DB.  You can click the date/time picker to choose a specific start and end date range to query.

Screen Shot 2015-01-26 at 10.42.59 AM

Query on Severity:  The “Audit Fail”, “Warning”, “Informational” and “Error” checkboxes control what severity of events you want to query and export.  They are all selected by default.

Screen Shot 2015-01-26 at 10.42.39 AM

Query on Module: The “Broker”, “Admin”, “Agent” and “Vlsi” checkboxes allow you to determine what modules you want events to be exported for.

  • Broker –  All brokering activity
  • Admin –  Administrative actions, typically through the GUI
  • Agent –  View Agent events
  • Vlsi – VMOMI Leveraged Server Infrastructure – These are API related calls.

Screen Shot 2015-01-26 at 10.42.46 AM

Session Type:  You can query if you want to return only desktop or application session types.  NOTE:  This entry is only populated for specific events, so use sparingly to avoid limiting search results too much.

User Filtering:

By default the application will return data for all usernames when running a query.  The user filtering tab allows you to filter the results returned on specific usernames.  The usernames are populated dynamically out of the Events Database, so there is no need to type them in.

To filter on usernames do the following:

  • Click the “Refresh Users” button to populate the list of usernames.
  • Select the users you want to filter on and click the down arrow to add to the “Users to Export Data For” list box.
  • You can de-select a user by selecting it in the “Users to Export Data For” listbox and clicking the Up Arrow.
  • If you want to reset the filter to all users, click the “Return Data for All Users” checkbox.
  • NOTE: If you choose to filter on usernames, the application will automatically filter the items in the “Event Filtering” and “Pool Filtering” tabs based on records for those specific users.  That way you will see the only records that actually apply to those users.

Screen Shot 2015-02-09 at 3.06.08 PM

Pool Filtering:

The application allow filtering of specific desktop pools,  you can select as many pools as you want to return.   If you filter on any users, you will only see the pools that apply to those specific users.

  • Select the pool names you want to query on and click the Down Arrow to add to the “Pools to Export Data For” listbox.
  • Selected Pools can be removed by selecting them in the “Pools to Export Data For” listbox and clicking the Up Arrow.

Screen Shot 2015-02-09 at 3.39.22 PM

Event Filtering:

The application allow filtering of specific event types, you can select as many event types as you want to return.   These events are also filtered by selecting the “Module” checkboxes on the “General Settings” tab as shown above (Broker, Agent, Admin, Vlsi).  In addition, if you filter on any users, you will only see the event types that apply to those specific users.

  • Select the event types you want to query on and click the Down Arrow to add to the “Events to Export Data For” listbox.
  • Notice in the screenshot below how events are filtered based on selected users and the label indicates this filtering.
  • Selected Event Types can be removed by selecting them in the “Events to Export Data For” listbox and clicking the Up Arrow.

All Event Types:
Screen Shot 2015-02-09 at 3.21.29 PM

Event Types Filtered by Users:
Screen Shot 2015-02-09 at 3.06.24 PM

Exporting Data:

At this point, you are ready to export data based on the filters you selected.  Click on the “Export Data” tab.

Columns to Export
You can choose which columns to export into the .CSV file.   Simply check or uncheck the column name to add or remove it from the output.  NOTE:  certain columns are specific to user events (Pool Name, Username, Session Type and Desktop Name), and the Server Name column is only available when no users are selected.  Client IP Address is only available when the BROKER_USERLOGGEDIN event type is selected or All Events are returned.
Screen Shot 2015-02-09 at 3.48.21 PM

Select File to Export Data Into

At this point you will select a .csv file to export the data into.  You need to use the built-in file save dialog to select the file.   Click the Screen Shot 2015-01-26 at 11.13.18 AM button to open the file save dialog.   The application will provide a default name – you can chance the name as required.   Click the “Save” button when you are satisfied with the file name and location.

Screen Shot 2015-01-26 at 11.18.41 AM

Show SQL Command:  This is an optional item that will show you the parameterized SQL command to be executed.

Screen Shot 2015-01-26 at 11.25.10 AM

Click the Screen Shot 2015-01-26 at 11.22.11 AMbutton when ready to export the data.

The query will now export and you will see a progress bar and the “Export Status list box will populate with the data as it is written to the .csv file.

When complete, you will receive a message box indicating the path to the file and how many records were exported.

Screen Shot 2015-02-09 at 3.51.26 PM

A button below the “Export Status” listbox will also appear which will allow you to open the export file automatically with the application associated with the .csv extention (typically excel).

Screen Shot 2015-01-26 at 11.29.55 AM

Screen Shot 2015-02-09 at 3.05.34 PM

At this point the data has been exported and you can review as needed and run as many more exports as needed.

I hope this utility will be helpful for organizations running VMware View.  Please let me know of any issues, questions or suggestion at chrisdhalstead@gmail.com or on Twitter at @chrisdhalstead.

You can download the application here:

https://labs.vmware.com/flings/horizon-view-events-database-export-utility

Advertisements
This entry was posted in Reporting and tagged . Bookmark the permalink.

11 Responses to VMware Horizon View Events Database Export Utilty

  1. Justin says:

    Very cool. I think the events database is much neglected resource that folks should look to get more out of.

  2. Awesome. Thanks for putting this together…and for sharing!

  3. Andrey says:

    Good Utility, But I am having some issues using it =( In my case I am not able to do any user filtering. When I try to refresh users, I am having an error saying – Invalid odject name ‘view_events.dbo.View1_user_events’ . Of course, there is no such table in the DB Created by Horizon View . Could you please help me to solve this issue ?
    Thank you in advance !

  4. Pingback: View Events simplified | myEUC.net

  5. Andrey says:

    Thanks for the good news about the upcoming features ! We will be glad to see them soon =) !

  6. Pingback: Newsletter: February 15, 2015 | Notes from MWhite

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s