monitoringservice.xml reference

  • Article

 

Applies to: FAST Search Server 2010

Use monitoringservice.xml to configure WMI classes and performance counters published by the Microsoft FAST Search Server 2010 for SharePoint monitoring service.

Use the monitoringserviceconfig.exe utility to apply file changes and to synchronize the configuration, WMI classes, and performance counters registered in the Windows operating system.

You will rarely have to edit this file, because it requires advanced knowledge of FAST Search Server 2010 for SharePoint internals.

The FAST Search Server 2010 for SharePoint monitoring service reads this configuration file when it starts and uses the configuration to do the following tasks:

  • Retrieve data from the declared process sources

  • Publish the metrics data into the declared WMI class and performance counter target objects

monitoringserviceconfig.exe uses this file to register the WMI and performance counter objects in the Windows operating system. This step is a prerequisite for the monitoring service to function, and must be performed every time that monitoringservice.xml is changed.

Customizing monitoringservice.xml

Note

To modify a configuration file, 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.

  1. Use a text or XML editor to change monitoringservice.xml.

  2. Run monitoringserviceconfig /checkconfig to validate the configuration.

  3. Run monitoringserviceconfig /install to apply the new configuration. You must temporarily stop the FAST Search Server 2010 for SharePoint Monitoring service (FASTSearchMonitoring) when you install the new configuration.

Element quick reference

monitoringservice.xml uses the following elements:

Element Description

<configuration>

This is the top level element

<nameserver>

Settings that control how the monitoring service polls the middleware name server

<nodecontroller>

Settings that control how the monitoring service polls the node controller

<processes>

List of processes (metrics sources) with <process> metrics declarations

<wmi>

List of WMI classes (metrics targets) with WMI <class> and <value> (attribute) declarations

<perfctr>

List of performance counter categories (metrics targets) with <category> and <counter> declarations

monitoringservice.xml file format

monitoringservice.xml is an XML file and follows all conventions and syntax rules that are defined for the XML file format.

The basic structure of the file is as follows:

<?xml version="1.0" encoding="utf-8" ?>
<configuration .. >

  <nameserver     .. />
  <nodecontroller .. />
  
  <processes>
    <process .. />
    <process .. />
    ...
    ...
  </processes>
  
  <wmi>
    <class .. />
    <class .. />
    ...
    ...
  </wmi>

  <perfctr>
    <category .. />
    <category .. />
    ...
    ...
  </perfctr>

</configuration>

The process declarations serve as the sources for metrics data. The WMI class elements and performance counter category elements serve as the destinations.

The declarations in process elements are tied to FAST Search Server 2010 for SharePoint internals, and should not be edited.

Warning

The default declarations in WMI class and performance counter category elements make up the official external monitoring interfaces of FAST Search Server 2010 for SharePoint; editing these elements can cause integration with other products to fail (e.g., the FAST Search Server 2010 for SharePoint management pack for System Center Operations Manager 2007).

configuration

This is the top level element.

Attributes

Attribute Value Description

version

3

The configuration file version for FAST Search Server 2010 for SharePoint

nameserver

Contains attributes that control how the middleware name server is polled

Attributes

Attribute Value Description

refresh_interval

<seconds>

Number of seconds to wait between each request to the middleware name server

timeout

<seconds>

Request timeout (default: 7 seconds)

nodecontroller

Contains attributes that control how the node controller is polled

Attributes

Attribute Value Description

refresh_interval

<seconds>

Number of seconds to wait between each request to the node controller

timeout

<seconds>

Request timeout (default: 10 seconds)

processes

Contains a list of process elements

process

Contains declarations of metrics sources, to control the collection of monitoring performance data and statistics

Attributes

Attribute Value Description

name

<string>

Process name

wmi

Contains a list of WMI class declarations

class

WMI class declaration; contains value elements that have class attribute declarations

Attributes

Attribute Value Description

name

<string>

WMI class name

description

<string>

WMI class description

instance_source

<string>

A string matching the symbol attribute of the corresponding process source

Example

<class name="Indexer" description="FAST Search Indexer" instance_source="indexer">
  <value symbol="rowId" name="RowId" type="int" />
  <value .. />
  ...
  ...
</class>

value

WMI class attribute declaration

Attributes

Attribute Value Description

symbol

<string>

This attribute is used to look up a corresponding value or attr element (the source for metrics data). Matching is performed against the symbol attribute of that value or attr element.

name

<string>

WMI attribute name

type

<data_type>

Valid values:

  • int - Integer data type (32-bit)

  • long - Long integer data type (64-bit)

  • bool - Boolean data type

  • string - String data type

  • float - Floating point data type

Example

<value symbol="rowId" name="RowId" type="int" />

perfctr

Contains a list of performance counter category declarations

category

Performance counter category declaration; contains counter elements that have class attribute declarations

Attributes

Attribute Value Description

name

<string>

Performance counter category name

description

<string>

Performance counter category description

instance_source

<string>

A string matching the symbol attribute of the corresponding process source

Example

<category name="FAST Search Indexer" description="FAST Search Indexer" instance_source="indexer">
  <counter symbol="rowId" name="Row id" type="NumberOfItems32" />
  <counter .. />
    ...
    ...
</category>

counter

Performance counter declaration

Attribute Value Description

symbol

<string>

This attribute is used to look up a corresponding value or attr element (the source for metrics data). Matching is performed against the symbol attribute of that value or attr element.

name

<string>

Performance counter name

type

<data_type>

  • NumberOfItems32 - Integer data type (32-bit)

  • NumberOfItems64 - Long integer data type (64-bit)

  • CounterDelta32 - Counter type displaying the difference between the current measurement and previous measurement (32-bit sources)

  • CounterDelta64 - 64-bit version

  • RateOfCountsPerSecond32 - Counter type displaying the difference between the current and previous measurements divided by the time difference between the two measurements (32-bit sources)

  • RateOfCountsPerSecond64 - 64-bit version

Example

<counter symbol="rowId" name="Row id" type="NumberOfItems32" />