monitoringserviceconfig.exe reference

 

Applies to: FAST Search Server 2010

Use the monitoringserviceconfig tool to install, reconfigure or uninstall Windows Management Instrumentation (WMI) classes and performance counters published by the Microsoft FAST Search Server 2010 for SharePoint monitoring service. This tool is primarily used by the installer; advanced administrators can use it to reconfigure published performance metrics for an installed instance of FAST Search Server 2010 for SharePoint.

monitoringserviceconfig reads configuration data from MonitoringService.xml, located in the <FASTSearchFolder>\etc folder.

Changing the configuration requires administrative permissions and temporarily stopping the monitoring service.

Note

To use a command-line tool, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

Syntax

<FASTSearchFolder>\bin\monitoringserviceconfig.exe [options] <command>

Parameters

Parameter Description

<FASTSearchFolder>

The path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch.

monitoringserviceconfig options

Option Description

-h

Prints help information.

-v

Prints version information.

-d

Enables debug logging to provide more detailed information.

-wmi

Specifies that the following command only updates WMI classes.

-perfctr

Specifies that the following command only updates performance counters.

monitoringserviceconfig commands

Command Description

/checkconfig

Validates configuration files.

In a production environment, use this command first as a dry run to verify that the configuration is valid. When all configuration checks pass, you must stop the monitoring service briefly while the configuration is updated, minimizing downtime of the monitoring and logging services.

This command does not require administrative permissions and can run independently of the monitoring service (FASTSearchMonitoring).

/install

Registers WMI classes and performance counters in the operating system.

/uninstall is automatically executed first.

This command generates DLLs and other metadata files in the <FASTSearchFolder>\var\monitoringservice folder.

/uninstall

Removes WMI classes and performance counters from the operating system.

Examples

The following example validates all configuration files. If the command passes without any errors, the configuration is valid for use with both the monitoring service and this configuration tool.

<FASTSearchFolder>\bin\MonitoringServiceConfig.exe /checkconfig

The following example registers WMI classes and performance counters in the operating system. You must stop the monitoring service while the configuration is updated, and restart it after monitoringserviceconfig /install has finished.

net stop FASTSearchMonitoring

<FASTSearchFolder>\bin\MonitoringServiceConfig.exe /install

net start FASTSearchMonitoring

The generated files use a .gen<x> suffix to avoid file locking issues with previous generations of the same files.

Remarks

Many of the performance counters and WMI classes that are defined in MonitoringService.xml are used by the FAST Search Server 2010 for SharePoint management pack for System Center Operations Manager (SCOM) 2007. If your environment is monitored by SCOM, removing or changing the configuration for these metrics could cause failures in the management pack.

You must run the monitoringserviceconfig /install command if the MonitoringService.xml configuration file is changed, to update the respective WMI and performance counter objects in the Windows operating system. The FAST Search Server 2010 for SharePoint monitoring service reads its configuration when it starts, and failures will occur if the configuration is not in sync with the registered WMI and performance counter operating system objects.