GetStatistics

The GetStatistics action returns statistics for the service.

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

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:

 
ClassStatisticDescription
[Service] Class
[Statistics] 
 TruncatedQueriesThe number of queries that timed out.
[Documents]
 TotalThe total number of documents that this IDOL server contains.
 SectionsThe number of document sections that this IDOL server contains.
 TotalSlotsThe total number of document sections that the IDOL server contains, including document sections that have been deleted.
[Databases]
 NumberThe total number of databases, including empty databases and databases that have been deleted.
 ActiveThe number of active databases (databases that are empty or contain data).
[ACI] Class
[Action:ActionName]
 CountThe total number of ActionName actions that were sent to the service.
 Avg.DurationThe average duration (in ms) of ActionName actions.
 ShortestThe shortest duration (in ms) of ActionName actions.
 LongestThe longest duration (in ms) of ActionName actions.
 Avg.ResponseSizeThe average size of responses (in bytes) for ActionName actions.
 Min.ResponseSizeThe minimum size of a response (in bytes) for ActionName actions.
 Max.ResponseSizeThe maximum size of a response (in bytes) for ActionName actions.
[Indexer] Class
[Connections]
 TotalThe number of socket connections to the index port.
 UnauthorizedThe number of index actions that IDOL server received from unauthorized clients.
 PausedThe number of connections that were rejected because the service was paused.
 InsufficientDiskSpaceThe number of connections that were rejected because there was insufficient disk space.
 InvalidIndexCodeThe number of connections that were rejected because they contained an index code that was not valid.
[Commands]
 InvalidThe number of actions that the service received to the index port that were not valid index actions.
 TruncatedDataThe number of index actions that were received that had truncated data.
 CommandNameThe number of CommandName index actions that were run.
[Command:CommandName]
 Avg.DurationThe average duration (in ms) of CommandName index actions.
 ShortestThe shortest duration (in ms) of CommandName index actions.
 LongestThe longest duration (in ms) of CommandName index actions.
 CommandsRejectedDiskFullThe number of index actions that were rejected because the disk was full.
 CommandsRejectedInvalidIndexCodeThe number of index actions that were rejected because their index code was not valid.
[Streaming]
 BytesStreamedToDiskThe number of bytes of data that the service has streamed to disk.
 TimeSpentStreamingThe amount of time in seconds that the service has spent streaming data.
[Queue]
 ReceivedThe number of index actions that have been received.
 CompletedThe number of index actions that have been completed.
 QueuedThe number of index actions that are in the index queue.
[Rejected Commands]
 InvalidThe number of index actions that were rejected because they were not recognized actions.
 RejectedInvalidDatabaseThe number of index actions that were rejected because they contained a database that was not valid.
 ReadOnlyDatabaseThe number of index actions that were rejected because they contained a read-only database.
 FileNotFoundThe number of index actions that were rejected because the file was not found.
 DocLimitExceededThe number of index actions that were rejected because the document limit was exceeded.
 IndexSizeExceededThe number of index actions that were rejected because the maximum index size was exceeded.
 UserConfIndexLimitExceededThe number of index actions that were rejected because the configured maximum allowed index size was exceeded.
 OutOfMemoryThe number of index actions that were rejected because IDOL server was out of memory.
 BadParameterThe number of index actions that were rejected because they contained a parameter or parameter value that was not valid.
 InsufficientFileHandlesThe number of index actions that were rejected because there were insufficient file handles.
 InsufficientDiskSpaceThe number of index actions that were rejected because there was not enough disk space.
 TruncatedDataThe number of POST index actions that were rejected because their data termination was incorrect.
 SuccessfullyProcessedThe number of successfully run index actions.
 OndiskComponentThe number of index actions that have data stored on disk.
[Documents]
 ReplacedReindexThe number of documents that were re-indexed because an ACLType or Index field had changed.
 ReplacedDocsTotalThe number of documents that have been replaced.
 InvalidDatabaseDocsThe number of documents that were not indexed because their database was not valid.
[Database] Class
[DatabaseName]
 DocumentsThe number of documents that this database contains.
 SectionsThe number of document sections that this database contains.
[Server] Class
[Tasks]
 NumberThe number of tasks set up in the configuration file.
 StartTaskThe first task that is performed.
 IndexCommandsThe number of index actions that have been processed (the number displayed includes any index action that is currently being processed).
 DocumentsThe number of documents that have been processed (the number displayed includes any document that is currently being processed).
 DocumentSuccessesThe number of documents that have been processed successfully.
 DocumentFailuresThe number of times that document processing has failed.
 SectionsThe number of document sections processed.
[Tasks] Class
[TaskName]
 RequestsThe number of requests sent to a specific task.
 SuccessesThe number of requests processed successfully by a specific task.
 FailuresThe number of request-processing failures for a specific task.
[Licensing] Class
[Users]
 MaximumThe maximum number of users that can be set up for this service.
[Statistics] Class
[Users]
 UsersThe number of users that has been set up for this service.
[CHILDSTAT] Class  
[AllChildren] 
 TotalUpEventsThe number of times a DIH child server was marked up.
 TotalDownEventsThe number of times a DIH child server was marked down.
[Engine N] 
 UpEventsThe number of times this DIH child server was marked up.
 DownEventsThe number of times this DIH child server was marked down.
 CommandsSentThe number of actions that were sent to this DIH child server.
 RetriesThe number of times actions to this DIH child server were retried.
 TotalBytesSentThe total number of bytes of data that were sent to this DIH child server.
 AvgSendCommandRateThe average rate that actions were sent to this DIH child server.
 MinResponseTimeThe smallest time that DAH took to respond to a request.
 AvgResponseTimeThe average time that DAH took to respond to requests.
 MaxResponseTimeThe largest time that DAH took to respond to requests.
 SuccessfulActionsThe number of actions that were successfully completed.
 FailedActionsThe number of actions that failed.
 TimeoutsThe number of actions that timed out.

Example

action=GetStatistics

Parameters

None.


© 2013 Autonomy Corporation plc and all its affiliates. All rights reserved.