pm.exe reference

  • Article

 

Applies to: FAST Search Server 2010

Use pm to debug problems related to item feeding and indexing in a Microsoft FAST Search Server 2010 for SharePoint installation.

You can configure FAST Search Server 2010 for SharePoint to consume log file output from components such as the FAST Search connector Content Search Service Application, the content distributor, the indexing dispatcher, and command-line clients such as docpush, can be configured to output file logs with processing information. pm processes these logs and report problems. The most common problems are missing callbacks related to operation processing. Use this information for debugging; for example, to determine why particular items are missing from the search index.

Before you can consume the log files with pm, you should enable operational logging, as explained in the remarks section of this article.

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\pm [global options] <log file> ... <log file>

Parameters

Property value/return value

Parameter Description

<log file> ... <log file>

Specifies which log files to process.

If you use the -d global option, you do not have to specify log files.

<FASTSearchFolder>

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

pm global options

Option Value Description

-h

Displays help.

-v

Displays version information.

-d

Processes all client feeder log files that are located in the <FASTSearchFolder>\var\log\dsfeeder directory. Client feeders such as the FAST Search Web Crawler and the docpush command-line utility create log files in this directory.

-s

Prints operation related statistics based on processing the log files. Statistics include the number of errors and the total number of callbacks.

-t

<seconds>

The maximum allowed time to complete processing an operation set (i.e., a batch of operations). If an operation set uses more than the specified number of seconds to complete processing (that is, all expected callbacks are sent and received) pm will report this.

Default: 600 seconds

-b

<session id>:<batch id>

Tracks the progress of the specified operation sets for the given session. Separate multiple instances with a comma. Operation sets are specified with the format:

[start:stop]

where start and stop specify the first and last operations in the set.

-c

<log>=<subsystem>:<secured>:<completed>

Overrides the expected callbacks for a given log file.

  • <log> must be either Feeder, CD.in, CD.out, ID.in, or ID.out

  • <subsystem> must be either processing or indexing

  • <completed> and <secured> must be either 0 or 1 depending on whether the completed or secured callback is expected or not

Examples

The following example processes all files in the <FASTSearchFolder>\var\log\dsfeeder directory and outputs the status:

<FASTSearchFolder>\bin\pm -d

The following example processes contentdistributor operations logs, tracking specific batches (batch [2,43] in session 4, and batch [300,500] in session 3):

<FASTSearchFolder>\bin\pm -b 4[2:43],3[300:500]

<FASTSearchFolder>\var\log\contentdistributor.input

<FASTSearchFolder>\var\log\contentdistributor.output

Remarks

To enable operational logging:

  1. Stop FAST Search Server 2010 for SharePoint.

  2. Add the --debug option as a parameter to the <indexingdispatcher> process.

  3. Start FAST Search Server 2010 for SharePoint.

  4. After FAST Search Server 2010 for SharePoint has started, run this command:

    indexeradmin -a enabletracemode

  5. Create a string value called ContentAPILogFile under the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office Server\14.0\Search\Global\Gathering Manager that contains the full path and the file name to use for logging. The file name must start with the string ContentApi.

  6. Restart the mssearch.exe process by restarting the osearch14 service.

The contentdistributor will now log operation input and output files in <FASTSearchFolder>\var\log\contentdistributor and indexingdispatcher logs to <FASTSearchFolder>\var\log\indexingdispatcher. Input log files have the input file suffix, and output log files have the output file suffix.