IBM System Dashboard for Enterprise Content Management, Version 5.0.0.2

Search-related counters for IBM Content Search Services

The IBM® Content Search Services search counters measure the indexing and search activities performed by the Content Platform Engine and IBM Content Search Services servers.

For additional IBM Content Search Services counters that you can use to monitor indexing performance, see Monitoring system metrics to improve indexing performance.

Object store counters

Dashboard path: HostName > IBM FileNet Content Platform Engine > USER > ObjectStoreName > CBR
Table 1. Object store counters for IBM Content Search Services
Subcontainer Type Counter name and definition
Common counters in <ObjectStoreName>/CBR Event Index Creates Submitted - The number of requests the Content Platform Engine generated to add an object to a full-text index.
Event Index Updates Submitted - The number of requests the Content Platform Engine generated to update an object to a full-text index.
Event Index Deletes Submitted - The number of requests the Content Platform Engine generated to delete an object from a full-text index.
Index Job Avg/Min/Max meter Object Query Time Avg ms - The amount of time the index job has spent doing a query against the database looking for objects to index.
Avg/Min/Max meter Object Retrieval Time Avg ms - The amount of time spent retrieving the objects to be indexed.
Event Index Request Submitted Rate - An event will provide a count and rate per-second of indexing Create/Update/Deletes that were submitted.
Simple meter Index Request Submitted - Shows the number of index requests submitted by index jobs since the server was started.
Simple meter Actual Create Index Request Processed - Shows the number of create index requests processed that are associated to an index job since the server was started. Only index requests sent to the CBR engine are counted (no-opt, duplicates, etc. are not in this tally).
Simple meter Actual Delete Index Request Processed - Shows the number of delete index requests processed that are associated to an index job since the server was started. Only index requests sent to the CBR engine are counted (no-opt, duplicates, etc. are not in this tally).
Simple meter Actual Update Index Request Processed - Shows the number of update index requests processed that are associated to an index job since the server was started. Only index requests sent to the CBR engine are counted (no-opt, duplicates, etc.. are not in this tally).
Rate of progress meter Objects Indexed Per-Minute - The Content Platform Engine computes the rate index requests that are being processed per-minute. It should be noted that indexing from object ingestion is not counted in this time and may slow down the number of index requests for an index job that are processed.
Duration Job Execution Duration Avg ms - The duration of time the job executed (the time the job is running; does not include sleep time).
Simple Meter Retries - The number of index requests associated to an index job resubmitted because of a retry. This value begins from zero each time the process is restarted.
Indexing Batch (for the object store).

Indexing Batch/<index-area-name> (for each index area)

Avg/Min/Max meter Dispatch Duration Avg ms - The amount of time it takes to read the index requests from the database for the purposes of index batch dispatching.
Avg/Min/Max meter Dispatch Wait time Avg ms - The amount of time the dispatcher is waiting before looking for index request work.
Avg/Min/Max meter Dispatch Checks Avg - The number of times the dispatcher checks for work before finding index requests to dispatch. Currently reported in the CBR summary tracing as dispatch loop #.
Avg/Min/Max meter Active Indexing Workers Avg - The number of active indexing workers found while dispatching index requests.
Avg/Min/Max meter Lease Update Duration Avg ms - The amount of time it takes to update the index request lease time prior to dispatching.
Avg/Min/Max meter Clear or Update Duration Avg ms - The amount of time it takes to clear or update the index requests after batch completion.
Avg/Min/Max meter Batch Size Avg - The size counter of the index request batch.
Avg/Min/Max meter Batch Duration Avg ms - The total duration of time it takes to process the batch.
Rate of Progress Meter Objects Indexed Per-Minute - The number of objects full text indexed per-minute as calculated by a simple moving average.
Avg/Min/Max meter K-Bytes Per-Minute Avg - The number of bytes transferred to the CBR engine for indexing per-minute.
Avg/Min/Max meter Actual Creates Avg - The number of creates sent to the CBR engine.
Avg/Min/Max meter Actual Deletes Avg - The number of deletes sent to the CBR engine.
Avg/Min/Max meter Actual Updates Avg - The number of updates sent to the CBR engine.
Avg/Min/Max meter Duplicate Count Avg - The number of index requests that were skipped because they were duplicates.
Avg/Min/Max meter Duplicate Duration Avg ms - The expense of removing duplicate index requests.
Avg/Min/Max meter Index Completion Time Avg Sec - The average time, in seconds, that has elapsed between when the index request was first created and the object is available for searching in the CBR engine.
Avg/Min/Max meter File Recognition Duration Avg ms - The amount of time spent doing file recognition.
Avg/Min/Max meter Object Retrieval Duration Avg ms - The amount of time spent doing object retrieval for an indexing batch.
Avg/Min/Max meter Indexing Duration Avg ms - The amount of time it takes to transfer text to the CBR engine and index the data.
Avg/Min/Max meter Text Extraction Duration Avg ms - The amount of time spent performing text extraction for an indexing batch.
Avg/Min/Max meter Total Text File Open Duration Avg ms - The amount of time spent checking if the text input file exists and its length.
Avg/Min/Max meter Content Storage Retrieval Avg ms - The amount of time spent setting up access to content storage.
Avg/Min/Max meter Object Indexing Failures Avg - The number of objects with a recording failure found in the batch (not necessarily the number of failure codes). These could be from text extraction errors or reported by the CBR engine. All errors that would normally set the indexing failure code of the object in a batch are counted (excluding batch exception/failures).
Simple meter Batch Exceptions - The number of batches that have been aborted because an exception was thrown during index processing, This value begins from zero each time the process is restarted.
Simple meter Retries - The number of index requests that are resubmitted because of a retry. This value begins from zero each time the process is restarted.
Avg/Min/Max meter Text Index Counter Update Avg - The amount of time it takes to update the full text index row after indexing.
Avg/Min/Max meter Move Duration Avg - The amount of time it takes to process/reissue index requests for a full collection.
Test Extraction (for the object stores).

Test Extraction/<type-name> (for each type, such as Outside In and PDF Box)

Rate of progress meter Text Extractions Per-Minute - The number of files text extraction was performed for. Typically, this equates to the number of content elements the system is performing text extractions for Per-Minute.
Avg/Min/Max meter Batch Duration Avg - The amount of time a text extraction batch takes to process.
Avg/Min/Max meter Batch Size Avg - The size counter of the text extraction batches.
Simple meter Time outs - The number of time-out cases recorded for text extraction since the server was started.
Simple meter Unexpected Result - The number of times an unexpected return code was detected from the text extraction process since the server was started.
Avg/Min/Max meter Text Extraction Wait Time Avg - The amount of time spent waiting for a text extraction process to become available.
Search (Search is an Event) Accumulator (avg, min, max) Total Search Duration ms - Total (ms) time to satisfy the CBR rows requested. This is typically the a reflection of how long a CBR search took with the search engine but can be impacted by the number of full text indexes to search and the number of worker threads. It is the amount of time the worker threads took to execute the CBR queries.
Accumulator (avg, min, max) Merge Duration ms - The duration of time in milliseconds the search results into the database.
Accumulator (avg, min, max) Search Workers Per-Request - The number of worker threads being used to satisfy search requests.
Accumulator (avg, min, max) Index Count - The number of full text indexes that had to be searched to satisfy the user request. Each search request might require a different number of indexes, depending on the criteria.
Accumulator (avg, min, max) Result Count - The number of results returned for a CBR query.

Server-based counters

The server-based counters provide counters for each of the CSS servers. These counters can help administrators understand the performance of each CSS server, from the viewpoint of the Content Platform Engine server, regardless of which object store data is being indexed.

Dashboard path: HostName > IBM FileNet Content Platform Engine > USER > Server Based Counters > CSS > CSSServerName

Note that the Index Search counters view includes timings that are for each search issued against a full text index (the object store search counters represent end user query times).

Table 2. Server-based counters for IBM Content Search Services
Subcontainer Type Counter name and definition
Indexing Batch Avg/Min/Max meter Batch Size Avg - The size counter of the index request batch.
Avg/Min/Max meter Batch Duration Avg ms - The total duration of time it takes to process the batch.
Rate of progress meter Objects Indexed Per-Minute - The number of objects full text indexed per-minute as calculated by a simple moving average.
Avg/Min/Max meter Actual Creates Avg - The number of creates sent to the CBR engine.
Avg/Min/Max meter Actual Deletes Avg - The number of deletes sent to the CBR engine .
Avg/Min/Max meter Actual Updates Avg - The number of updates sent to the CBR engine.
Avg/Min/Max meter Indexing Failures - The number of indexing failures found in the batch. Only errors, info messages, and warnings reported by the CBR engine are recorded by this counter. This counter is for object level processing.
Index Search (Index Search is an Event Accumulator (avg, min, max) Search Duration ms - The duration of time in milliseconds it took to execute the search in the CBR engine.
Accumulator (avg, min, max) Search Read Time ms - The duration of time in milliseconds it took to read the search result.
Accumulator (avg, min, max) Result Count - The number of results returned for a CBR query.
Accumulator (avg, min, max) Merge Duration ms - The amount of time taken to insert the rows into the temp table for merging into the main query.
Text Extraction Queue <type-name> (for each type, such as Outside In or PDF Box) Event Execution – this is a PCH Event. It represents the processing of requests the worker queue does. The worker queue is pulling elements from the queue and doing the work. This work is done in batches, meaning each worker thread pulls multiple entries from the queue.
Accumulator (avg, min, max) Execution Duration ms – a measurement of the Execution Event. The amount of time the worker thread took to process the request.
Accumulator (avg, min, max) Execution size – A measurement of the execution event; the number of entries the worker thread pulled from the queue for the execution of work. This will be multiple for text extraction.
Meter In Progress – The number of queue entries currently being executed.
Meter Pending In Queue – The number of queue entries waiting to be processed by a worker thread.
Avg/Min/Max meter Request Per-Minute – The number of queue entries processed per-minute for the last 15 minutes (shows moving rate of progress).
Text Indexing Preprocessor Queue Event Execution – Represents the processing of requests the worker queue does. The worker queue is pulling elements from the queue and doing the work. Each worker thread pulls a single entry from the queue at a time.
Accumulator (avg, min, max) Execution Duration ms – a measurement of the Execution Event. The amount of time the worker thread took to process the request.
Accumulator (avg, min, max) Execution size – A measurement of the execution event; the number of entries the worker thread pulled from the queue for the execution of work. This will be multiple for text extraction.
Meter In Progress – The number of queue entries currently being executed.
Meter Pending In Queue – The number of queue entries waiting to be processed by a worker thread.
Avg/Min/Max meter Request Per-Minute – The number of queue entries processed per-minute for the last 15 minutes (shows moving rate of progress).


Last updated: March 2016
p8pdb005.htm

© Copyright IBM Corporation 2016.