Overview

This guides describes common Attivio platform monitoring tasks. 

These features require that the memory module be included when you run createproject to create the project directories.

 

Determine Current Attivio System State (Started/Stopped)

All Administration Pages

All pages in the Use the Attivio Administrator display a status at the top of the page. 

System Information Screen

Open the Use the Attivio Administrator and navigate to the Monitors -> System Information -> System page. Under the "Runtime Information" block the current status will be displayed with more details:

Figure 2: System Information Page System Status

Log Files

Attivio console output and attivio.<node_name>.log log files contain the following lines to indicate system status:

Status

Output

starting

Everything before the started line

started


INFO  Attivio - System Ready (startupTime=28s)


shutting down


INFO  Attivio - Shutting down Attivio server...


shut down

Process no longer running

Determine if Attivio Query Capabilities are Online

If the following URI returns a valid XML QueryResponse then the system is capable of processing queries.

If load-balancers or other monitoring devices are configured to periodically test this URI, it is recommended that the totalRows attribute be checked for a non-zero value assuming that, for a particular Attivio application, content is persisted in the Attivio index.

If requesting this URI from another network location, localhost should be replaced with the URI for the target Attivio server. If running Attivio on a different port, change the port number to attivio.baseport + 1. If Attivio is configured to serve queries using a different query workflow, the workflows querystring parameter should be changed to reference the correct workflow.


http://localhost:17001/query?workflows=search&q=*:*

Sample Expected Response:

<queryResponse time="62" workflowTime="329" totalRows="260" clientId="" redelivered="false">
  <history>
    <string>10.2.1.42:17000/admin.queryReceiver-0</string>
    <string>10.2.1.42:17000/search.runSecureQuery-0</string>
    ....

Determine System Processing Status / Performance

Open the Use the Attivio Administrator and navigate to the Monitors -> Diagnostics -> Component Statistics page. The grid on the Component Statistics page displays the current and overall processing rates for every component in the system.

Statistic

Description

Msgs

Total number of messages seen by Attivio since system start.

Docs

Total number of documents seen by Attivio since system start.

Msgs/Sec

Messages per second in elapsed time processed while clients are active.

Docs/Sec

Documents processed per second elapsed time while clients are active.

% Processing

Percent of time component spent processing messages.

% Blocked Send

Percent of time component was blocked trying to send to follow-on components or other destinations.

% Blocked Input

Percent of time component was blocked waiting for input.

The statistics grid can be sorted by any of these columns by clicking on the column header.

When diagnosing performance issues, first sort by Docs/Sec. If the slowest active component (non-query) is spending most of its time processing, then it is the bottleneck. On multi-core systems, increasing the number of instances for that component can improve throughput.

If most components are blocked on input, sort by % Processing to find the one that is working the most, then focus on it for optimization.

Figure 3: Component Statistics Page

Determine the Documents Currently Being Processed

Open the Use the Attivio Administrator and navigate to the Monitors -> Diagnostics -> Document States page. The Document States page displays a grid listing every document being processed by the system and the component or thread processing each document.

As many documents can be in process concurrently, this list may be truncated for performance reasons.

Figure 4: Document State Page

Determine the current heap/memory usage

These features require that the memory module be included when you run createproject to create the project directories.

Main Article: Modules - Memory Statistics

In addition to the Memory Statistics module, JConsole or other standard JMX tools can be used to view memory, thread, cpu usage and other low level process information.

Figure 5: Using JConsole to View Attivio Memory Statistics