ZenPack:Microsoft SQL Server

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

Note: This is a Core ZenPack which can be found in the Core Zenoss RPM, and is fully documented in the Zenoss Extended Monitoring Guide. If you did not install this pack when you installed Zenoss Core, it can be found in $ZENHOME/packs.

Zenoss, Inc.
ZenPack name
Git sources (for cloning)

Applications Monitored: 

Microsoft SQL Server ZenPack

Monitoring for Microsoft SQL Server.


The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.


This ZenPack is part of Zenoss Core. Open Source users receive community support for this ZenPack via our online forums. Enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.


The ZenPacks.zenoss.MSSQLServer ZenPack uses WMI to monitor Microsoft SQL Server and its related services.

Note: This ZenPack is deprecated; see the Microsoft Windows ZenPack.

The ZenPack enables users to view graphs based on Microsoft SQL Server Performance Counters and to monitor processes related to SQL Server.


Prerequisite Restriction
Product Zenoss platform 4.x
Required ZenPacks ZenPacks.zenoss.WindowsMonitor,


Enable Monitoring

All MS SQL Server services must have a device entry under the /Devices/Server/Windows/MSSQLServer device class. In addition, verify that your Zenoss platform Windows service account has access to the MS SQL Server service.

  1. Navigate to the device or device class in the Zenoss platform interface.
    • If applying changes to a device class:
      1. Select the class in the devices hierarchy.
      2. Click Details.
      3. Select Configuration Properties.
    • If applying changes to a device:
      1. Click the device in the device list.
      2. Select Configuration Properties.
  2. Verify the credentials for the service account to access the service.
    MS SQL Server Configuration Properties
    Name Description
    zWinUser Windows user with privileges to gather performance information.
    zWinPassword Password for the above user.

  3. Click Save to save your changes. You will now be able to start collecting the MS SQL Server server metrics from this device.
  4. Navigate to Graphs to see placeholders for graphs. After approximately fifteen minutes, the graphs start to become populated with information.

Collecting Information from Non-Default Microsoft SQL Server Instances

The default Microsoft SQL Sever instance is SQLServer. The monitoring template delivered with this ZenPack uses this default instance to gather performance metrics. If you use a non-default SQL Server instance, then Zenoss platform does not automatically find and gather information about it.

To enable Zenoss platform to monitor a non-default instance, you must override the monitoring template:

  1. From Infrastructure > Devices, click the device on which you want to override the template.
  2. Under Monitoring Templates, select the MSSQLServer template.
  3. From the Action menu, select Override Template Here. The Override Templates dialog appears.
  4. Select the MSSQLServer template in the list, and then click Submit. The template redisplays in the left panel, now identified as "Locally Defined."
  5. For each of the data sources in the Data Sources area, perform these steps:
    1. Double-click the data source to edit it.
    2. In the Perf Counter field, change the text "\SQLServer:" to "\MyInstance:" (where MyInstance is the name of the Microsoft SQL Server database instance name.
    3. Click Save.
  6. Remodel the device.


Type Name
Performance Collector zenwinperf


Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.zenoss.MSSQLServer-*.egg
  4. Restart these services:
    $ zenoss restart

Developer Mode Installation

In order to do a development mode installation you will want to clone the existing git repository, and then use the --link flag with the zenpack command:

  1. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  2. Start by cloning the upstream repository:
    $ git clone https://github.com/zenoss/ZenPacks.zenoss.MSSQLServer.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.zenoss.MSSQLServer
  4. Finally, restart these serivices:
    $ zenoss restart


Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus