Skip Headers
Oracle® Enterprise Manager System Monitoring Plug-in Installation Guide for Microsoft SQL Server
Release 12.1.0.4.0 for Windows

E35211-09
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

  PDF · Mobi · ePub

Oracle® Enterprise Manager

System Monitoring Plug-in Installation Guide for Microsoft SQL Server

Release 12.1.0.4.0 for Windows

E35211-09

May 2014

This document provides a brief description about the Oracle system monitoring plug-in for Microsoft SQL Server, details on the versions the plug-in supports, prerequisites for installing the plug-in, and step-by-step instructions on how to download, install, verify, and validate the plug-in.

The following topics are presented:

1 Description

The system monitoring plug-in for Microsoft SQL Server extends Oracle Enterprise Manager Cloud Control 12c to add support for managing Microsoft SQL Server instances. By deploying the plug-in within your Cloud Control environment, you gain the following management features:

  • Monitor SQL Server instances.

  • Supports both SQL Authentication and Windows Integrated Authentication

  • Gather configuration data and track configuration changes for SQL Server instances.

  • Raise alerts and violations based on thresholds set on monitored metrics and configuration data.

  • Provide rich out-of-box reports based on the gathered data.

  • Support monitoring by a local or remote Windows Agent. Local Windows Agent is an agent running on the same host as the Microsoft SQL Server. Remote Windows Agent is an agent running on a host that is different from the host where SQL Server is running.

2 What's New in SQL Server Plug-in Release 4 (12.1.0.4.0)

Starting with this version of the SQL Server plug-in, you can now view a Performance page separate from the target home page. In addition to the new Performance page, you will also see tables that visualize critical database statistics, such as Top Processes by CPU Time.

Figure 1 shows an example of the SQL Server target home page. The following items have been added to the target home page in the Summary section.

  • SQL Server Status - The run state of the SQL Server service

  • SQL Server Agent Status - The run state of the SQL Server Agent service

  • Database Instance Name - The name of the SQL Server instance that is being monitored

  • Server Host Name - The host name of the server or cluster on which the SQL Server instance is running

  • Database Version - The version of SQL Server

  • Cluster Summary - Displays the cluster nodes, their statuses, and the active node

Figure 1 Target Home Page Example

Surrounding text describes Figure 1 .

The following graphs and tables have been updated or added to the target home page and can be seen in Figure 1.

  • Databases - Displays the names and statuses of the databases running on the SQL Server instance, as well as their size and available space

  • Buffer Cache Hit Ratio (%) - The percentage of pages read from memory, rather than from the disk

  • Average Latch Wait Time (ms) - The average time, in milliseconds, for latch wait requests

  • Load Percentage (%) - The percent load on the host's CPUs

  • Process States - A summary of states of the SQL Server processes

  • Top Processes By CPU Time - The Top CPU consuming SQL Server processes

The Performance page, as shown in Figure 2, can be accessed by clicking Performance in the target home page or using the Microsoft SQL Server target drop down and selecting Performance.

Figure 2 Performance Page Example

Surrounding text describes Figure 2 .

In the Performance page, you can view tables that show Top 5 Session Statistics or Top 5 Query Statistics. Figure 2 shows an example of the CPU Time, which has been selected from the drop-down, for Top 5 Session Statistics. With this view available, administrators can quickly determine, by session ID, which sessions have the highest CPU Time. If a session is the cause of an issue, you can click Kill Session to invoke the new Kill Session Job to end the problem session.

Another way to view the new statistics from the Performance page is with the use of the newly added ”Microsoft SQL Server Query and Session Performance” Information Publisher Report. Running this report will display graphs and details for top 5 sessions by CPU time and memory utilization, along with top 5 queries by execution, blocked time, and CPU time.

Figure 3 Performance Page Example

Surrounding text describes Figure 3 .

In Figure 3, you can see views for Memory Utilization of the Top 5 Sessions as well as the Blocked Time for the Top 5 Queries.

3 Supported Versions

This plug-in supports the following versions of products:

  • Enterprise Manager Cloud Control 12c Release 3 (12.1.0.3.0) or higher (Oracle Management Server and Oracle Management Agent).

  • Standard, Enterprise, and Workgroup editions of Microsoft SQL Server 2005, Microsoft SQL Server 2008, and Microsoft SQL Server 2012 as detailed below:

    • Microsoft SQL Server 2005 (32-bit)

    • Microsoft SQL Server 2005 (64-bit) running on x64

    • Microsoft SQL Server 2008 R2 (32-bit)

    • Microsoft SQL Server 2008 R2 (64-bit) running on x64

    • Microsoft SQL Server 2012 (32-bit)

    • Microsoft SQL Server 2012 (64-bit) running on x64

  • Microsoft SQL Server 2008 R2 Cluster: Active/Active and Active/Passive

  • Microsoft SQL Server 2012 Cluster

Note:

Although, the plug-in for Microsoft SQL Server version 12.1.0.4.0 is compatible with Enterprise Manager Release 3 (12.1.0.3.0), it is strongly recommended to deploy to Enterprise Manager Release 4 (12.1.0.4.0) for best results.

It is also recommended to upgrade previous versions of the plug-in to 12.1.0.4.0, where applicable (see Upgrading the Plug-in)

4 Prerequisites

The following prerequisites must be met before you can deploy the plug-in:

  • Enterprise Manager Cloud Control 12c Release 3 (12.1.0.3.0) or higher (Oracle Management Server and Oracle Management Agent) must be installed.

  • For the plug-in to establish connection to SQL Server instance using Windows Integrated Authentication mode, when deployed on a 64-bit (x64 or IA64) copy of Oracle Management Agent running on 64-bit Windows operating system, do the following:

    • Depending on the JVM version, copy the respective version of the sqljdbc_auth.dll file to the following location:

      Drive:\<agent_base>\plugins\oracle.em.smss.agent.plugin_12.1.0.4.0\dependencies\oracle.em.smss\jdbcdriver
      

      If the directory does not exist, then create it. The sqljdbc_auth.dll file is available as part of Type 4 Microsoft SQL Server 2005 JDBC Driver version 3.0 (after unzipping, you will find three files with same name, that is, auth\x86\sqljdbc_auth.dll, auth\x64\sqljdbc_auth.dll, and auth\ia64\sqljdbc_auth.dll)

      • For x64 version of Oracle Management Agent installed on x64 (Xeon or AMD) Windows systems, copy the file auth\x64\sqljdbc_auth.dll to $AgentHome\sysman\jdbcdriver (the dll file should be copied directly under the folder specified. No sub-directories should be created.)

      • For IA64 version of Oracle Management Agent installed on IA64 Windows systems, copy the file auth\ia64\sqljdbc_auth.dll to $AgentHome\sysman\jdbcdriver

    Note:

    Type 4 Microsoft SQL Server 2005 JDBC Driver Version 4.0 is not currently supported for use with Windows Integrated Authentication.
  • No manual step needs to be performed when the plug-in is deployed on 32-bit copy of Oracle Management Agent (running on 32-bit or 64-bit Windows).

  • Access privileges required for non-admin System user to perform Remote Monitoring of SQL Server instance.

  • As part of JDBC URL, either IP Address or host name can be provided. Ensure that the host name can be resolved consistently on the network. Standard TCP tools such as nslookup and traceroute can be used to verify the host name. Validate using the following commands on Management Agent where plug-in is deployed:

    • nslookup <hostname>

      This returns the IP address and fully qualified host name.

    • nslookup <IP>

      This returns the IP address and fully qualified host name.

      Note:

      The hostname provided in the JDBC URL should be a fully qualified name (that is, must include the domain name also).
  • Windows Management Instrumentation Service is up and running.

  • Preferred credentials are set and validated on all Agents where you want to deploy the plug-in.

  • The OS privileges for the user (set in the Preferred Credentials for the Agent) must meet the requirements documented in the "Setting Credentials for the Job System to Work with Enterprise Manager" section of the Oracle Database Installation Guide for Microsoft Windows available at:

    http://docs.oracle.com/cd/E11882_01/install.112/e24186/postcfg.htm#BABFAEIG
    

    Note:

    If you do not assign the correct privileges for users, the deployment will fail.
  • Enable TCP/IP for the SQL Server instance. For more information, see Enabling and Finding TCP/IP Port Information.

  • Enable SQL or Mixed Authentication on the SQL Server instance. For more information, Enabling SQL Authentication or Mixed Authentication.

  • Create a suitable DB user with 'sysadmin' fixed server role.

  • To monitor the SQL Server instance using non-sysadmin user, create a user with non-sysadmin role and provide the following access to it:

    1. Execute this command to give access to the user:

      GRANT VIEW SERVER STATE TO "login name"
      
    2. Provide database access to the user.

    3. Provide SQLAgentOperatorRole fixed database role in msdb to the user.

5 Downloading the Plug-in

You can download plug-ins in online or offline mode. Online mode refers to an environment where you have Internet connectivity, and can download the plug-in directly through Enterprise Manager from My Oracle Support. Offline mode refers to an environment where you do not have Internet connectivity, or where the plug-in is not available from My Oracle Support.

See the Managing Plug-ins chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for details on downloading the plug-in in either mode:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/plugin_mngr.htm#CJGBEAHJ

6 Deploying the Plug-in

You can deploy the plug-in to an Oracle Management Service instance using the Enterprise Manager Cloud Control console, or using the EM Command Line Interface (EMCLI). While the console enables you to deploy one plug-in at a time, the command line interface mode enables you to deploy multiple plug-ins at a time, thus saving plug-in deployment time and downtime, if applicable.

See the Managing Plug-ins chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for instructions on deploying the plug-in:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/plugin_mngr.htm#CJGCDHFG

7 Enabling and Finding TCP/IP Port Information

The following sections provide information you require to enable the TCP/IP port and to find the TCP/IP port for a particular SQL server instance:

7.1 Enabling TCP/IP Port

  1. From the SQL Server Configuration Manager, select your appropriate SQL Server Network Configuration in the left panel and navigate to the SQL Server instance:

    • SQL Server 2005 Network Configuration

    • SQL Server 2008 Network Configuration

    • SQL Server 2012 Network Configuration

    The right panel displays all protocols for the specified SQL Server instance and their status.

  2. Ensure that TCP/IP is enabled.

  3. (If TCP/IP is disabled), right-click TCP/IP and select Properties. The TCP/IP Properties dialog box appears.

  4. In the Protocol tab, select enabled, and click Apply.

  5. Restart the SQL Server instance.

7.2 Finding TCP/IP Port

After enabling the TCP/IP protocol, restart the SQL Server to apply the changes.

From the SQL Server Configuration Manager, select the appropriate SQL Server Network Configuration in the left panel and navigate to the SQL Server instance:

  • SQL Server 2005 Network Configuration

  • SQL Server 2008 Network Configuration

  • SQL Server 2012 Network Configuration

The right panel displays all protocols for the specified SQL Server instance and their status.

In the IP Addresses tab, TCP Dynamic Ports row of IP All will give the TCP/IP port of instance.

8 Enabling SQL Authentication or Mixed Authentication

Modify the permissions for database authentication so that you enable SQL authentication or mixed authentication, and set sysadmin role for the database user that you are going to use for discovering the target and running jobs.

On the SQL Server, for the user you are going to use for monitoring and running jobs, set the write permissions by following these steps:

Note:

If you do not have a user, then create one. To do so, from the task bar, go to Start, select Settings, and then Control Panel. In the Control Panel, double-click Users and Passwords and click Add in the Users tab.
  1. In the Control Panel, double-click Administrative Tools and then Computer Management. The Computer Management screen appears.

  2. In the left panel, go to Services and Applications and select the Microsoft SQL Server and navigate down to Security.

  3. Double-click Security, and select Logins.

  4. Right-click Logins and click NewLogin. The SQL Server Login Properties-New Login dialog box appears.

  5. Click General tab, specify the name for the new login, select SQL Server Authentication and specify a unique password to use when connecting to the server using SQL Authentication.

  6. Click Server Roles tab and ensure that sysadmin is selected in the Server Roles section.

  7. Click Database Access tab, and ensure that in the Permit in Database Role section, no role is selected for any database.

9 Discovering Targets

After successfully deploying the plug-in, follow these steps to add the plug-in target to Cloud Control for central monitoring and management:

  1. From the Setup menu, select Add Target and then Add Targets Manually.

  2. In the Add Targets Manually page, select Add Non-Host Targets by Specifying Target Monitoring Properties, select Target Type as Microsoft SQL Server, select a Monitoring Agent and click Add Manually.

    In the Add Microsoft SQL Server page, provide the following information for the properties

    • Name — Unique target name across all Cloud Control targets, such as SqlServer2k_Hostname. This is the display name in Cloud Control. It represents this SQL Server target across all user interfaces within Cloud Control.

    • JDBC URL — URL for JDBC.

      For example,

      jdbc:sqlserver://<host>:<port> 
      

      Note:

      You can specify either IP Address or host name. However, ensure that the host name can be resolved consistently on the network. Standard TCP tools such as "nslookup" and "traceroute" can be used to verify the host name. Also, if you are monitoring a Microsoft SQL Server Cluster, then specify the IP address or host name of the virtual SQL Server of the cluster.
    • JDBC Driver — (Optional) Microsoft SQL Server 2005 JDBC driver class name.

      For example,

      com.microsoft.sqlserver.jdbc.SQLServerDriver
      
    • Database Username (Required for SQL Authentication) — Valid user for the database in sysadmin fixed server role.

    • Password for the Database User (Required for SQL Authentication) — Corresponding password for the database user

    • System Username (Needed when SQLServer is at remote location) — Valid host user name. Required only for remote Agent monitoring. For more information, see Configuring Remote Connections to Monitor Targets. The system username must be fully qualified. For example:

      hostname.domainname.com\Administrator
      
    • System Password (Needed when SQLServer is at remote location) — Password for the Username. Required only for remote Agent monitoring.

    • Connect Using Windows Integrated Authentication (Yes/No) — Yes for Windows Integrated Authentication, No for SQL Authentication

    • Role — (Optional)

  3. Click Test Connection to make sure the parameters you entered are correct.

Note:

See support note 1500823.1 for information on configuring authentication details. The document also includes different scenarios (remote vs local, WIA vs SQL Authentication) for creating SQL Server instances in Enterprise Manager.

You can access this document in My Oracle Support:

https://support.oracle.com

After you deploy and configure the plug-in to monitor one or more targets in the environment, you can customize the monitoring settings of the plug-in. This alters the collection intervals and threshold settings of the metrics to meet the particular needs of your environment. If you decide to disable one or more metric collections, this could impact the reports that the metric is a part of.

10 Verifying and Validating the Plug-in

After waiting a few minutes for the plug-in to start collecting data, use the following steps to verify and validate that Enterprise Manager is properly monitoring the plug-in target:

  1. Click the Microsoft SQL Server target link from the All Targets page. The Microsoft SQL Server home page appears.

  2. Verify that no metric collection errors are reported by clicking Monitoring and then Metric Collection Errors from the Target menu.

  3. Ensure that reports can be seen and no errors are reported by clicking Information Publisher Reports in the Target menu and viewing reports for the Microsoft SQL Server target type.

  4. Ensure that configuration data can be seen by clicking Configuration and then Last Collected in the Target menu. If configuration data does not immediately appear, click Refresh in the Latest Configuration page.

11 Configuring Connections

This section provides details about configuring connections for monitoring targets and executing jobs and includes the following topics:

11.1 Configuring Remote Connections to Monitor Targets

If you want to monitor targets using remote Agents, then Oracle recommends that you do the following security configurations on every system where SQL Server target resides.

  • Set WMI namespace security.

  • Restrict access to the registry from a remote computer.

  • Set DCOM Security to allow user to access remotely.

  • Set privileges for System User to access Windows performance counters remotely as follows:

    1. Locally on the Microsoft Windows node hosting the Agent, open the Local Security Settings Windows Tool. Go to Start, select Control Panel, and then select Administrative Tools, select Computer Management, select System Tools, then Local Users and Groups, and select Groups.)

    2. Add System Username to Performance Monitor Group.

  • Set access privileges of SQL Server Services to allow user to access a computer remotely.

  • Set privileges for System User of target on Oracle Management Agent for Windows Integrated Authentication based monitoring.

    1. Locally on the Microsoft Windows node hosting the Agent, open the Local Security Settings Windows Tool. Go to Start, select Control Panel, and then select Administrative Tools, and select Local Security Policy.

    2. Click on Local Policies and then User Rights Assignment.

    3. Assign the following right to the System User of the target:

      Logon as batch job

  • Configure Allow Remote Administration Exception in Windows Firewall if Windows firewall is enabled on the SQL Server target system.

11.2 Configuring Connections to Execute Jobs

If you want to execute jobs using local or remote Agents, then Oracle recommends that you do the following security configurations on every system where SQL Server target resides.

  • Set WMI namespace security.

  • Set DCOM Security to allow user to access a computer remotely.

For configuration details, refer to the following:

12 Creating and Editing Jobs

To create and edit jobs, follow these steps:

Note:

Currently, the Microsoft SQL Server Pause or Resume job is only supported for stand-alone Microsoft SQL Server instances. Pause of Resume Jobs submitted for Microsoft SQL Server 2005, 2008, and 2012 cluster instances will fail with the appropriate error message.
  1. In Enterprise Manager Cloud Control 12c, click Enterprise, then Job, then click Activity.

  2. On the Job Activity page, select a job type from the Create Job menu and click Go.

    Select one of the following:

    • Microsoft SQL Server and/or SQL Agent Start

    • Microsoft SQL Server and/or SQL Agent Stop

    • Microsoft SQL Server Pause or Resume

    • Microsoft SQL Server Kill Session

    Note:

    If you want to edit a job, then select an existing job from the list and click Edit.
  3. In the General tab of the Create <Job Type> Job page, provide a name for the job and add the individual targets or one composite target such as a Group.

    Note:

    If you are editing a job, then modify the job name and the selected targets.
  4. In the Parameters tab of the Create <Job Type> Job page, from the Options menu, select an appropriate option to make the job function accordingly when it starts.

    You can select one of these options as shown in Table 1:

    Table 1 Job Parameters Options

    Job Type Available Options

    Microsoft SQL Server and/or SQL Agent Start

    • Start SQL Server and SQL Server Agent services

      (You will select this option when both, SQL Server and SQL Server Agent, are stopped or when SQL Server is running but the SQL Server Agent is stopped)

    • Start SQL Server service

      (You will select this option when both, SQL Server and SQL Server Agent, are stopped and if you want to start only the SQL Sever)

    Microsoft SQL Server and/or SQL Agent Stop

    • Stop SQL Server and SQL Server Agent services.

      You will select this option:

      • When both SQL Server and SQL Server Agent are running.

      • When SQL Server is paused but the SQL Server Agent is running.

      • When SQL Server is running/paused but the SQL Server Agent is stopped.

    • Stop SQL Server Agent service.

      (You will select this option when you want to stop a running SQL Server Agent)

    Microsoft SQL Server Pause or Resume

    • Pause SQL Server service

      (You will select this option when you want to pause a running SQL Server)

    • Resume SQL Server service

      (You will select this option when you want to resume a paused SQL Server)

    Microsoft SQL Server Kill Session

    • End a single active SQL Server user session.

      (You will select this option to end an active user session by specifying the session id)


    Cloud Control starts the SQL server and agent services according to the selection made.

    Note:

    If you are editing a job, then modify the options for that job.
  5. In the Credentials tab of the Create <Job Type> Job page, select an appropriate option for credentials.

    You can choose to use the preferred credentials that are already set or override the preferred credentials with new credentials. In either case, you need to provide the credentials for agent host and database host.

    To set the preferred credentials, click Preferences at the top-right corner of the Cloud Control console. From the left-vertical navigation bar, click Preferred Credentials. Cloud Control displays the Preferred Credentials page. On this page, you can set the preferred credentials

    Note:

    If you are editing a job, then modify the credentials set for that job.
  6. In the Schedule tab of the Create <Job Type> Job page, schedule the job.

    Note:

    If you are editing a job, then modify the schedule prepared for that job.
  7. In the Access tab of the Create <Job Type> Job page, define or modify the access you want other users to have to this job.

    Note:

    If you want to edit, then modify the access levels for that job.
  8. Click Submit to create the job.

Note:

To enable use of the Job buttons found in the Summary section of the Target home page, be sure to set the Preferred Credentials for the Microsoft SQL Server target type.

13 Upgrading the Plug-in

The Self Update feature allows you to expand Enterprise Manager's capabilities by updating Enterprise Manager components whenever new or updated features become available. Updated plug-ins are made available via the Enterprise Manager Store, an external site that is periodically checked by Enterprise Manager Cloud Control to obtain information about updates ready for download. See the Updating Cloud Control chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for steps to update the plug-in:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/self_update.htm

14 Undeploying the Plug-in

See the Managing Plug-ins chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for steps to undeploy the plug-in:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/plugin_mngr.htm#CJGEFADI

15 Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.


System Monitoring Plug-in Installation Guide for Microsoft SQL Server, Release 12.1.0.4.0

E35211-09

Copyright © 2014, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.