Microsoft® FAST™ Search Server 2010 for SharePoint® Management Pack Guide for Operations Manager 2007

Microsoft® FAST™ Search Server 2010 for SharePoint® Management Pack Guide for Operations Manager 2007
Microsoft Corporation
Published: April 16. 2010
Send suggestions and comments about this document to mpgfeed@microsoft.com. Please include the management pack guide name with your feedback.
Copyright
Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in examples herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.
Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.
© 2010 Microsoft Corporation. All rights reserved.
Microsoft, and MS-DOS, Windows, Windows Server, and Active Directory are trademarks of the Microsoft group of companies. All other trademarks are property of their respective owners.
Contents
Microsoft® FAST™ Search Server 2010 for SharePoint® Management Pack Guide for Operations Manager 2007 1
Copyright 2
Contents 3
Microsoft® FAST™ Search Server 2010 for SharePoint® Management Pack Guide 5
Microsoft® FAST™ Search Server 2010 for SharePoint® Management Pack Guide 5
Document Version 5
Introduction to the FAST Search Server 2010 for SharePoint Management Pack 5
Getting the Latest Management Pack and Documentation 5
What's New 5
Supported Configurations 6
Getting Started 6
Before You Import the Management Pack 6
How to Import the Microsoft FAST Search Server 2010 for SharePoint Management Pack 7
Create a New Management Pack for Customizations 7
Security Considerations 8
Low-Privilege Environments 8
Understanding Management Pack Operations 8
Objects that the Management Pack Discovers 8
Classes 10
How Health Rolls Up 10
Key Monitoring Scenarios 11
Known Issues 13
Appendix: Reports 14
Appendix: Scripts 15
Microsoft® FAST™ Search Server 2010 for SharePoint® Management Pack Guide
This management pack monitors FAST Search Server 2010 for SharePoint.
Document Version
This guide was written based on the 14.0.19.1000 version of the Microsoft FAST Search Server 2010 for SharePoint Management Pack.
Revision History
Release Date
|
Changes
|
April 16, 2010
|
Original release of this guide
|
Introduction to the FAST Search Server 2010 for SharePoint Management Pack Getting the Latest Management Pack and Documentation
You can find the FAST Search Server 2010 for SharePoint Management Pack in the System Center Operations Manager 2007 Catalog (http://go.microsoft.com/fwlink/?LinkId=82105).
What's New
The following features are new in this release of the FAST Search Server 2010 for SharePoint Management Pack:
Discovery of FAST Search Server 2010 for SharePoint processes and services
Overview dashboard
Search topic folders with related performances views and dashboards for advanced performance analysis
Monitoring and views of FAST Search Server 2010 for SharePoint Windows events
FAST Search Server 2010 for SharePoint back-end performance collection rules
Content Plugin discovery and performance collection rules
State views for process, services and data objects
Process & service start/stop/restart control tasks
Utility task to reset all event log monitors
Monitoring of process & service availability
Periodic QRServer Test Query (HTTP) with monitors and performance rules
Farm-wide search availability monitor
Indexer monitors (disk space, fault-tolerant sync, status code, missing data folder)
Supported Configurations
The following table contains information about supported configurations for the FAST Search Server 2010 for SharePoint Management Pack:
Configuration
|
Support
|
Windows Server 2008
|
64-bit editions only (Service Pack 2 required)
|
Windows Server 2008 R2
|
64-bit editions only
|
Clustered servers
|
Not supported
|
Agentless monitoring
|
Not supported
|
Virtual environment
|
Not supported
|
The number of supported search servers is based on the supported limit for the number of agents in a management group.
Getting Started
This section describes the actions you should take before you import the management pack. No additional configuration is required after the management pack is imported.
Before You Import the Management Pack
Agentless monitoring is not supported, so all monitored servers must have an agent running and must be listed in the Agent Managed view of the SCOM Operations Console. Only the 64-bit version of the agent is supported.
Files in this Management Pack
The FAST Search Server 2010 for SharePoint Management Pack includes the following files:
Microsoft.FAST.Search.Server.2010.for.SharePoint.mp
Microsoft FAST Search Server 2010 for SharePoint Management Pack Guide.doc
EULA.RTF
Recommended Additional Management Packs
It is recommended that you obtain, import and configure the following management packs to perform complete service-oriented monitoring of the FAST Search Server 2010 for SharePoint role:
Windows Server 2008 Operating System
SQL Server
Windows Server Internet Information Services (IIS)
SharePoint Foundation 2010
SharePoint Server 2010
How to Import the Microsoft FAST Search Server 2010 for SharePoint Management Pack
For instructions about importing a management pack, see How to Import a Management Pack in Operations Manager 2007 (http://go.microsoft.com/fwlink/?LinkId=142351).
After you import the FAST Search Server 2010 for SharePoint Management Pack, create a new management pack in which you store overrides and other customizations.
Create a New Management Pack for Customizations
Most vendor management packs are sealed so that you cannot change any of the original settings in the management pack file. However, you can create customizations, such as overrides or new monitoring objects, and save them to a different management pack. By default, Operations Manager 2007 saves all customizations to the Default Management Pack. As a best practice, you should instead create a separate management pack for each sealed management pack you want to customize.
Creating a new management pack for storing overrides has the following advantages:
It simplifies the process of exporting customizations that were created in your test and pre-production environments to your production environment. For example, instead of exporting the Default Management Pack that contains customizations from multiple management packs, you can export just the management pack that contains customizations of a single management pack.
You can delete the original management pack without first needing to delete the Default Management Pack. A management pack that contains customizations is dependent on the original management pack. This dependency requires you to delete the management pack with customizations before you can delete the original management pack. If all of your customizations are saved to the Default Management Pack, you must delete the Default Management Pack before you can delete an original management pack.
It is easier to track and update customizations to individual management packs.
For more information about sealed and unsealed management packs, see Management Pack Formats (http://go.microsoft.com/fwlink/?LinkId=108355). For more information about management pack customizations and the Default Management Pack, see About Management Packs in Operations Manager 2007 (http://go.microsoft.com/fwlink/?LinkId=108356).
Security Considerations
Agentless monitoring is not supported. Certain operations cannot be run in a low-privilege environment or must have minimum permissions.
Low-Privilege Environments
A low-privilege agent action account must meet the following requirements:
The account must be a member of the FASTSearchAdministrators and Performance Monitor local user groups
The account must have Granted Log On Locally rights
Understanding Management Pack Operations
The Overview dashboard view found in the root folder of the management pack is a good starting point. It shows all FAST Search Server 2010 for SharePoint components, and also has some important performance metrics and an event view showing all events from all FAST Search Server 2010 for SharePoint nodes.
Any alerts that are triggered by this management pack are listed in the Active Alerts view. Visit this view to see a list of detected issues with your search installation.
The Services and Processes view lists all FAST Search Server 2010 for SharePoint services. This view offers easy access to the start/stop/restart tasks.
The All Events view is the same view as the one found in the Overview view. Use this view to get a bigger display area for the events list to inspect events more effectively and in closer detail.
The General / Admin, Feeding and Search folders contain performance and dashboard views for targeted topics. This can be useful to analyze performance bottlenecks.
The Performance, Events and State Views folders contain complete views of management pack elements for each management pack class. These are mostly useful for detailed inspection and analysis tasks.
Objects that the Management Pack Discovers
The FAST Search Server 2010 for SharePoint Management Pack discovers the following FAST Search Server 2010 for SharePoint services/features:
Computer role: FAST Search Server, hosts:
Processes and services controlled by the FAST Search Server 2010 for SharePoint node controller
Monitoring service
Admin services
FAST Search content indexing connectors
Content Collection(s)
Index Partitions
Computer role: SharePoint Server 2010 FAST Search Components Host, hosts:
The two top-most discoveries for the computer roles FAST Search Server and SharePoint Server 2010 FAST Search Components Host are light-weight registry-based discoveries with discovery intervals of 14470 and 14573 seconds, respectively. Their discovery attributes are all static.
FAST Content Plugin instances are discovered using a PowerShell script (FASTContentPluginDiscovery.ps1) with a discovery interval of 22012 seconds (>6 hours).
Services and FAST Search content indexing connectors are discovered by the script SearchNodeDiscovery.vbs. The remaining components are discovered using WMI. Discovery frequencies for these discoveries are in the range of 14500 to 15500 seconds (>4 hours).
The computer role discoveries target the class Microsoft.Windows.Server.Computer, and the remaining discoveries, except for the FAST Content Plugin discovery, target the FAST Search Server class.
Use the following procedure to disable automatic discovery:
To use an override to change the setting for automatic discovery (example for the FAST Content Plugin)
-
1. In the Authoring pane, expand Management Pack Objects, and then click Object Discoveries.
2. On the Operations Manager toolbar, click Scope, and then filter the objects that appear in the details pane to include only FAST Search Server 2010 for SharePoint objects.
3. In the Operations Manager toolbar, use the Scope button to filter the list of objects, and then click FAST Content Plugin.
Note
In Operations Manager 2007 R2, click Change Scope.
4. On the Operations Manager toolbar, click Overrides, click Override the Object Discovery, and then click For all objects of type: FAST Content Plugin.
5. In the OverridesProperties dialog box, click the Override box for the Enabled parameter.
6. Under Management Pack, click New to create an unsealed version of the management pack, and then click OK, or select an unsealed management pack that you previously created in which to save this override. As a best practice, you should not save overrides to the Default Management Pack.
| Classes
The following diagram shows the classes defined in this management pack. Light gray boxes indicate classes that are defined in other management packs.
How Health Rolls Up
Component Base is hosted by the FAST Search Server class, and a dependency rollup monitor rolls up health from the corresponding sub-classes of Component Base.
Key Monitoring Scenarios
This section provides a list of the key features, benefits, and scenarios of this management pack.
General/Admin, Feeding and Search folders provide an assortment of views that are essential for efficient analysis of search performance, locating bottlenecks, etc. The sampling frequencies of the performance collection rules can be increased via Overrides to provide greater precision in the resulting charts. This can prove useful for detecting load spikes, especially for performance collection rules like Performance Collection: FAST Search QRServer/# of Queries/sec (QRServer). Keep in mind that increased collection frequencies generate additional load on the System Center Operations Manager databases.
Service Availability Monitoring
All FAST Search Server Windows services are monitored using SCOM built-in Windows!Microsoft.Windows.CheckNTServiceStateMonitorType monitors.
Process Availability Monitoring
All FAST Search Server 2010 for SharePoint processes are monitored by inspecting the NodeConfProcess WMI data provided by the FAST Search Server monitoring service.
Periodic QRServer Test Query (HTTP)
A periodic test query (search term: SCOMQueryMonitorPing) is performed against the local HTTP interface of all QRServers.
Monitors (QRServer):
Periodic Query Test (Aggregate monitor)
HTTP Request Failure
Search URI Unreachable
HTTP Request Status Code
HTTP Request Timeout
This ensures that QRServers can service search requests. In addition to these query tests, it is recommended to set up monitoring of your main search application front-end using the built-in Web Application management pack template.
Search Component State Monitoring
FAST Search Server 2010 for SharePoint processes report their state through various WMI attributes and performance counters. These indicate various fault states that require administrator intervention. See the Product Knowledge pages for these monitors for detailed information.
Monitors:
Manual FT Sync Needed (RTSIndexer)
Status Code Check (RTSIndexer)
Custom Disk Space Monitors
Running out of disk space in the search data partition is very damaging to the search environment. Two special disk space monitors exist to ensure that such incidents are detected early on. One checks the FAST Search Indexer/Disk low state performance counter reported by the indexer, and the other monitor uses a script to monitor free disk space for the indexDir path configured in %FASTSEARCH%\etc\rtsplatformrc.xml.
The script version of the monitor has a default warning level for <20% free disk space, and a critical level for <10% free disk space. The 'Disk low state' performance counter is controlled by the configuration entry diskspaceMBWarning in the configuration file rtsearchrc.xml (typical path: %FASTSEARCH%\etc\config_data\RTSearch\webcluster\rtsearchrc.xml).
Monitors (RTSIndexer):
Disk Space Low (Reported by indexer)
Disk Space Low (Script Poll)
Event Log Monitoring
Individual Warning/Error monitors exist for the FAST Search Server processes and services that provide Windows event sources. The windows events originate from the FAST Search operational log server channel (log server infrastructure).
Use the Reset Log Monitors task to efficiently reset all manual-reset monitors for specified FAST Search Server instances (multi-select supported). This is especially useful for scenarios where unforeseen server reboots or other dramatic incidents have occurred outside of Maintenance Mode periods.
Use overrides to disable event log monitors that trigger too often.
Farm-Wide Search Availability Checks
A periodic test runs the searchinfo.exe tool and inspects the states of all registered search nodes in the system to ensure full search availability. The search index on each search node is divided into partitions, and this test verifies that all partitions are available for handling search queries.
Process/Service Control
Use the following management pack Tasks to control processes and services:
Task
|
Description
|
Start/Stop/Restart Service
|
Control Windows services
|
Start/Stop/Restart Component
|
Control processes and services managed by the node controller
| Known Issues
Issue:
Performance collection rules do not collect any data.
Causes:
Depending on timing of the availability of the dynamic FAST Search Server performance counter instances, the agent can believe a performance counter is not available for a quite long time (up to 24 hours).
Resolution:
These issues will resolve themselves automatically. Restart the agent service (HealthService) to recover more quickly.
Appendix: Reports
A single report is included in this management pack:
Aggregate QPS for Farm
This report yields the aggregated (total) QPS count for the whole search system
For a FAST Search Server object this report performs aggregation of the performance counter 'FAST Search QRServer/# of Queries/sec' across all search servers in the farm (all instances with the same InstanceID attribute). Performance data is retrieved from the hourly performance data aggregate for all QRServer instances, stored in the data warehouse.
Allow up to thirty minutes for reports from a new management pack to appear in the Reporting console.
Appendix: Scripts
The following scripts are included in the FAST Search Server 2010 for SharePoint Management Pack:
Script
|
Purpose
|
Rule/Monitor/Task
|
IndexerDiskSpaceCheck.vbs
|
This script runs as part of the Indexer disk space monitor and determines available disk space for the index data partition.
|
Disk Space Low (Script Poll)
|
ProcessTaskNCtrl.vbs
|
This script works as a wrapper for nctrl.exe in the %FASTSEARCH%\bin folder. The application folder path is extracted from the registry.
|
Start Component
Stop Component
Restart Component
|
FASTContentPluginDiscovery.ps1
|
PowerShell script which discovers FAST Content Plugin instances using a lookup check of configured performance counters for such instances.
|
Discovery: FAST Content Plugin
|
SearchNodeDiscovery.vbs
|
This script discovers admin services, connectors, the monitoring service and services controlled by the node controller.
|
Discovery: FAST Search Server Hosted Classes
|
ServiceTaskRestart.vbs
|
Wrapper script for restarting windows services not controlled by the node controller.
|
Restart FASTSearchService
Restart FASTSearchMonitoring
|
SearchAvailabilityCheck.vbs
|
This script executes the searchinfo.exe tool and performs validations of the engine/partition status.
|
Search Availability (Search Farm Watcher)
|
|