IDOL Content Component 23.2

# GetStatistics

The `GetStatistics` action returns statistics for the service.

NOTE: This is a service status action that can be sent only by users that belong to an authorization role that allows the `ServiceStatus` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

Each statistic returns in an `autn:stat` XML element. This element contains the following attributes:

class | The group that the statistic belongs to. For example, `Service`.
autnid | The subgroup that the statistic belongs to. For example, `Documents`.
name | The name of the statistic.
metric | The type of statistic. This can have one of the following values: 0 String 1 Bytes 2 Bytes per second 3 per second 4 percent 5 count 6 number 7 timestamp 8 seconds 9 milliseconds 10 maximum 11 megabytes
value | The value of the statistic.

For example:

    <autn:stat class="Service" autnid="Statistics" name="24HourRequestsPerSecond" metric="3" value="8.5" />

In this example, the statistic `24hourRequestsPerSecond` has a value of 8.5 per second.

The following statistics return for all servers:

Class | Statistic | Description
--- | --- | ---
[Service] Class
[Statistics] |
| `ServiceDuration` | The number of seconds the service has been running.
| `10SecondResponseAverage` | The average service response time (in milliseconds) measured over the last 10 seconds.
| `10SecondRequestsPerSecond` | The number of requests to the service per second in the last 10 seconds.
| `10SecondRequests` | The number of requests to the service in the last 60 seconds.
| `60SecondResponseAverage` | The average service response time (in milliseconds) measured over the last 60 seconds.
| `60SecondRequestsPerSecond` | The number of requests to the service per second in the last 60 seconds.
| `60SecondPeakRequestsPerSecond` | The highest number of requests to the service over any 60 second period.
| `60SecondRequests` | The number of requests to the service in the last 60 seconds.
| `1HourResponseAverage` | The average service response time (in milliseconds) measured over the last hour.
| `1HourRequestsPerSecond` | The number of requests to the service per second in the last hour.
| `1HourPeakRequestsPerSecond` | The highest number of requests to the service over any 1 hour period.
| `1HourRequests` | The number of requests to the service in the last hour.
| `24HourResponseAverage` | The average service response time (in milliseconds) measured over the last 24 hours.
| `24HourRequestsPerSecond` | The number of requests to the service per second in the last 24 hours.
| `24HourPeakRequestsPerSecond` | The highest number of requests to the service over any 24 hour period.
| `24HourRequests` | The number of requests to the service in the last 24 hours.
| `RecentResponseAverage` | The average service response time (in milliseconds) from the time the last 10 second period finished to the current time.
| `RecentRequestsPerSecond` | The number of requests to the service per second from the time the last 10 second period finished to the current time.
| `RecentPeakRequestsPerSecond` | The highest number of requests to the service from the time the last 10 second period finished to the current time.
| `RecentRequests` | The number of requests to the service from the time the last 10 second period finished to the current time.
| `TotalRequests` | The total number of requests that were made to the service.

The following statistics return for specific components:

Class | Statistic | Description
--- | --- | ---
[Service] Class
[Statistics] |
| `TruncatedQueries` | The number of queries that timed out.
[Documents]
| `Total` | The total number of documents that this IDOL index contains.
| `Sections` | The number of document sections that this IDOL index contains.
| `TotalSlots` | The total number of document sections that the IDOL index contains, including document sections that have been deleted.
[Databases]
| `Number` | The total number of databases, including empty databases and databases that have been deleted.
| `Active` | The number of active databases (databases that are empty or contain data).
[ACI] Class
[Action:`ActionName`]
| `Count` | The total number of `ActionName` actions that were sent to the service.
| `Avg.Duration` | The average duration (in ms) of `ActionName` actions.
| `Shortest` | The shortest duration (in ms) of `ActionName` actions.
| `Longest` | The longest duration (in ms) of `ActionName` actions.
| `Avg.ResponseSize` | The average size of responses (in bytes) for `ActionName` actions.
| `Min.ResponseSize` | The minimum size of a response (in bytes) for `ActionName` actions.
| `Max.ResponseSize` | The maximum size of a response (in bytes) for `ActionName` actions.
[Indexer] Class
[Connections]
| `Total` | The number of socket connections to the index port.
| `Unauthorized` | The number of index actions that IDOL received from unauthorized clients.
| `Paused` | The number of connections that were rejected because the service was paused.
| `InsufficientDiskSpace` | The number of connections that were rejected because there was insufficient disk space.
| `InvalidIndexCode` | The number of connections that were rejected because they contained an index code that was not valid.
[Commands]
| `Invalid` | The number of actions that the service received to the index port that were not valid index actions.
| `TruncatedData` | The number of index actions that were received that had truncated data.
| `CommandName` | The number of `CommandName` index actions that were run.
[Command:`CommandName`]
| `Avg.Duration` | The average duration (in ms) of `CommandName` index actions.
| `Shortest` | The shortest duration (in ms) of `CommandName` index actions.
| `Longest` | The longest duration (in ms) of `CommandName` index actions.
[Streaming]
| `BytesStreamedToDisk` | The number of bytes of data that the service has streamed to disk.
| `TimeSpentStreaming` | The amount of time in seconds that the service has spent streaming data.
[Queue]
| `Received` | The number of index actions that have been received.
| `Completed` | The number of index actions that have been completed.
| `Queued` | The number of index actions that are in the index queue.
[Rejected Commands]
| `Invalid` | The number of index actions that were rejected because they were not recognized actions.
| `RejectedInvalidDatabase` | The number of index actions that were rejected because they contained a database that was not valid.
| `ReadOnlyDatabase` | The number of index actions that were rejected because they contained a read-only database.
| `FileNotFound` | The number of index actions that were rejected because the file was not found.
| `DocLimitExceeded` | The number of index actions that were rejected because the document limit was exceeded.
| `IndexSizeExceeded` | The number of index actions that were rejected because the maximum index size was exceeded.
| `UserConfIndexLimitExceeded` | The number of index actions that were rejected because the configured maximum allowed index size was exceeded.
| `OutOfMemory` | The number of index actions that were rejected because IDOL was out of memory.
| `BadParameter` | The number of index actions that were rejected because they contained a parameter or parameter value that was not valid.
| `InsufficientFileHandles` | The number of index actions that were rejected because there were insufficient file handles.
| `InsufficientDiskSpace` | The number of index actions that were rejected because there was not enough disk space.
| `TruncatedData` | The number of POST index actions that were rejected because their data termination was incorrect.
| `SuccessfullyProcessed` | The number of successfully run index actions.
| `OndiskComponent` | The number of index actions that have data stored on disk.
[Documents]
| `ReplacedReindex` | The number of documents that were re-indexed because an ACLType or Index field had changed.
| `ReplacedDocsTotal` | The number of documents that have been replaced.
| `InvalidDatabaseDocs` | The number of documents that were not indexed because their database was not valid.
[Database] Class
[DatabaseName]
| `Documents` | The number of documents that this database contains.
| `Sections` | The number of document sections that this database contains.
[Licensing] Class
[Users]
| `Maximum` | The maximum number of users that can be set up for this service.
[Statistics] Class
[Users]
| `Users` | The number of users that has been set up for this service.

## Example

    action=GetStatistics

## Parameters

None.

Copyright 2023 Open Text
Version 23.2 | Last updated March 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL IDOL Content Component 23.2

Topic Title: GetStatistics