CBR Dashboard

The CBR Dashboard "ping page" provides a method of accessing key CBR PCH counter values. The contents of the CBR Dashboard displays metrics based on the text search service that you configure for your environment.

The Content Based Retrieval (CBR) PCH counter values, viewable using the System Dashboard, are useful for investigating indexing and search issues. Basic Content Platform Engine and Content Based Retrieval PCH counter metrics such as Batch Duration time, Batch Size, Indexing Duration, Object Indexed per-minute can provide key indexing information about CBR performance.

The CBR Dashboard provides a view of some of the key CBR PCH Counter metrics from the Content Platform Engine server by way of a browser instead of the System Dashboard tool. The CBR Dashboard servlet is included in the Engine-health WAR that is bundled with the FileNet enterprise application, so the Dashboard requires no special installation or configuration. If Content Platform Engine is up and running, the Dashboard is available.

Tip: The Dashboard provides a snapshot of the supported CBR PCH counters, and does not refresh automatically. To see updated values for the PCH counters, you must refresh the browser.

Accessing the Dashboard

The dashboard can be accessed from any supported browser by using the following URL: server:port/P8CE/Health/CBRDashboard

For example, your URL might look like the following: server1:9080/P8CE/Health/CBRDashboard

The default values for the Dashboard are generally adequate, but if needed you can specify parameters as part of the access URL to change the information that is displayed:

timespan

The timespan parameter specifies how many minutes back the PCH data is retrieved for. The default setting is 30. To increase the setting to 60 minutes, for example, you specify the following URL:

server1:9080/P8CE/Health/CBRDashboard?timespan=60

objectstore

The objectstore parameter specifies that PCH counter data is collected for only a single objectstore. The default setting is to return counter data for all object stores. For example, to show only data for objstore1, you specify the following URL:

server1:9080/P8CE/Health/CBRDashboard?objectstore=objstore1

timeout

The timeout parameter provides a time limit for the dashboard to respond. If the dashboard cannot collect and process the required counters within this period, the browser returns a warning and no data. The default setting in seconds is 30, which is typically adequate. It is unlikely you will need to modify this value, however if needed, the following example increases the timeout value to 60 seconds:

server1:9080/P8CE/Health/CBRDashboard?timeout=60

sampletime

The sampletime parameter controls the number of seconds the servlet collects PCH counter data before displaying the results. The default of 5 seconds is typically adequate. If however there is a large amount of PCH data and numerous object stores this value can be increased, but must be less than the timeout value. The following example increases the value to 10 seconds:

server1:9080/P8CE/Health/CBRDashboard?sampletime=10

addlistener

The addlistener parameter specifies a host:port pair so that the dashboard can reach a PCH listener, for example, from a containerized Content Search Services server. Containers that are started with the Docker “-p option”, for example

docker
run … -p 9999:32775 …

, expose the default 32775 PCH listener port of the containerized server to the container host. The addlistener URI paramater can reach this listener port, and provide additional PCH counters displayed in the dashboard. The following example includes the input from a containerized Content Search Services server:

server1:9080/P8CE/Health/CBRDashboard?addlistener=9999:32775

You can combine parameters in the URL, such as in the following example:

server1:9080/P8CE/Health/CBRDashboard?timespan=60&objectstore=objstore1&timeout=45&addlistener=9999:32775

Included Content Platform Engine Server PCH counters

The Dashboard provides information on the following PCH counters. Note that counters are only displayed if values exist for the counters.

CBR Indexing Batch - Active Indexing Workers Avg: The number of active indexing workers found while dispatching index requests.
CBR Indexing Batch - Index Creates Submitted: Document indexing submit rate and total.
CBR Indexing Batch - Total Number of Processed Documents: Document indexing submit rate and total.
CBR Indexing Batch - Text Extraction Duration Avg ms: The amount of time spent performing text extraction for an indexing batch.
Document - Creates: Document creation rate and total.
CBR Indexing Batch - Batch Size Avg: The size counter of the text extraction batches.
CBR Indexing Batch - Batch Duration Avg ms: The amount of time for a batch to be processed.
CBR Indexing Batch - Objects Indexed Per-Minute: The computed rate index requests are being processed per-minute.
CBR Indexing Batch - Content Storage Retrieval Avg ms: The amount of time spent setting up access to content storage.
CBR Indexing Batch - Batches in Progress: The number of batches in progress.
CBR Indexing Batch - Documents Currently being Indexed: The number of documents that are being indexed.
CBR Indexing Batch - OIT Text Extraction Batch Size Avg: The average size of OIT text extraction batches.
CBR Indexing Batch - OIT Text Extraction Batch Duration Avg ms: The average time spent processing an OIT text extraction batch.
Elasticsearch API - GET: The rate and total number of Elasticsearch GET API requests.
Elasticsearch API - POST: The rate and total number of Elasticsearch POST API requests.
Elasticsearch - Bulk API Objects Created: The number of objects that the Elasticsearch bulk API creates.
Elasticsearch - Bulk API Objects Deleted: The number of objects that the Elasticsearch bulk API deletes.
Elasticsearch - Bulk API Objects Failed: The number of objects that the Elasticsearch bulk API fails to process.
Elasticsearch - Bulk API Submit Batch Items: The number of items submitted in an Elasticsearch bulk API batch.
Elasticsearch - Bulk Submit API Batch: The rate and total number of Elasticsearch bulk submit API requests.
Elasticsearch - ES Batch Duration Avg ms: The average time that Elasticsearch takes to process a batch.
Elasticsearch - ES Batch Size Avg: The average size of Elasticsearch batches.
Elasticsearch - ES Batches in Progress: The number of Elasticsearch batches that are in progress.