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
  • 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 are returned by Connector Framework Server:

Class Statistic Description
[CFS] Class
[Statistics]  
  IngestCallsTotal The total number of ingest actions processed since the CFS started.
  IngestAddsTotal The total number of ingest-adds (new documents to be added to the index) processed since the CFS started.
  IngestDeletesTotal The total number of ingest-deletes (documents to be deleted from the index) processed since the CFS started.
  IngestUpdatesTotal The total number of ingest-updates (metadata updates for existing documents in the index) processed since the CFS started.
  ImportNodes The number of documents currently in the import process.
  ImportQueuedTotal The total number of documents queued for import (pre-import tasks, followed by KeyView and post-import tasks).
  ImportStartedTotal The total number of documents that began the import process (pre-import tasks, followed by KeyView and post-import tasks).
  ImportFinishedTotal The total number of documents that finished the import process.
  ImportCancelledTotal The total number of documents that began the import process but were cancelled.
  ImportPending The number of documents currently waiting to start the import process.
  ImportActive The number of documents currently being processed.
  IndexerSection The name of an index (for example an IDOL Server or Vertica database) that has been configured.
  IndexerQueued_IndexerSection The total number of batches of documents that were queued for indexing into the index IndexerSection.
  IndexerFailed_IndexerSection The total number of batches of documents that could not be indexed into the index IndexerSection.
  IndexerSucceeded_IndexerSection The total number of batches of documents that were successfully indexed into the index IndexerSection.
  IndexerTotalQueued The total number of batches of documents that were queued for indexing across all indexes.
  IndexerTotalFailed The total number of batches of documents that could not be indexed across all indexes.
  IndexerTotalSucceeded The total number of batches of documents that were successfully indexed across all indexes.
  10SecondIngestCallsPerSecond The average number of ingest actions processed per second over the last 10 seconds.
  10SecondIngestCalls The number of ingest actions processed in the last 10 seconds.
  60SecondIngestCallsPerSecond The average number of ingest actions processed per second over the last 60 seconds.
  60SecondIngestCalls The number of ingest actions processed in the last 60 seconds.
  1hourIngestCallsPerSecond The average number of ingest actions processed per second over the last 1 hour.
  1hourIngestCalls The number of ingest actions processed in the last 1 hour.
  24hourIngestCallsPerSecond The average number of ingest actions processed per second over the last 24 hours.
  24hourIngestCalls The number of ingest actions processed in the last 24 hours.
  10SecondIngestAddsPerSecond The average number of ingest-adds processed per second over the last 10 seconds.
  10SecondIngestAdds The number of ingest-adds processed in the last 10 seconds.
  60SecondIngestAddsPerSecond The average number of ingest-adds processed per second over the last 60 seconds.
  60SecondIngestAdds The number of ingest-adds processed in the last 60 seconds.
  1hourIngestAddsPerSecond The average number of ingest-adds processed per second over the last 1 hour.
  1hourIngestAdds The number of ingest-adds processed in the last 1 hour.
  24hourIngestAddsPerSecond The average number of ingest-adds processed per second over the last 24 hours.
  24hourIngestAdds The number of ingest-adds processed in the last 24 hours.
  10SecondIngestUpdatesPerSecond The average number of ingest-updates processed per second over the last 10 seconds.
  10SecondIngestUpdates The number of ingest-updates processed in the last 10 seconds.
  60SecondIngestUpdatesPerSecond The average number of ingest-updates processed per second over the last 60 seconds.
  60SecondIngestUpdates The number of ingest-updates processed in the last 60 seconds.
  1hourIngestUpdatesPerSecond The average number of ingest-updates processed per second over the last 1 hour.
  1hourIngestUpdates The number of ingest-updates processed in the last 1 hour.
  24hourIngestUpdatesPerSecond The average number of ingest-updates processed per second over the last 24 hours.
  24hourIngestUpdates The number of ingest-updates processed in the last 24 hours.
  10SecondIngestDeletesPerSecond The average number of ingest-deletes processed per second over the last 10 seconds.
  10SecondIngestDeletes The number of ingest-deletes processed in the last 10 seconds.
  60SecondIngestDeletesPerSecond The average number of ingest-deletes processed per second over the last 60 seconds.
  60SecondIngestDeletes The number of ingest-deletes processed in the last 60 seconds.
  1hourIngestDeletesPerSecond The average number of ingest-deletes processed per second over the last 1 hour.
  1hourIngestDeletes The number of ingest-deletes processed in the last 1 hour.
  24hourIngestDeletesPerSecond The average number of ingest-deletes processed per second over the last 24 hours.
  24hourIngestDeletes The number of ingest-deletes processed in the last 24 hours.
  10SecondImportQueuedPerSecond The average number of documents queued for import per second over the last 10 seconds.
  10SecondImportQueued The number of documents queued for import in the last 10 seconds.
  60SecondImportQueuedPerSecond The average number of documents queued for import per second over the last 60 seconds.
  60SecondImportQueued The number of documents queued for import in the last 60 seconds.
  1hourImportQueuedPerSecond The average number of documents queued for import per second over the last 1 hour.
  1hourImportQueued The number of documents queued for import in the last 1 hour.
  24hourImportQueuedPerSecond The average number of documents queued for import per second over the last 24 hours.
  24hourImportQueued The number of documents queued for import in the last 24 hours.
  10SecondImportStartedPerSecond The average number of documents that began the import process per second over the last 10 seconds.
  10SecondImportStarted The number of documents that began the import process in the last 10 seconds.
  60SecondImportStartedPerSecond The average number of documents that began the import process per second over the last 60 seconds.
  60SecondImportStarted The number of documents that began the import process in the last 60 seconds.
  1hourImportStartedPerSecond The average number of documents that began the import process per second over the last 1 hour.
  1hourImportStarted The number of documents that began the import process in the last 1 hour.
  24hourImportStartedPerSecond The average number of documents that began the import process per second over the last 24 hours.
  24hourImportStarted The number of documents that began the import process in the last 24 hours.
  10SecondImportFinishedPerSecond The average number of documents that finished the import process per second over the last 10 seconds.
  10SecondImportFinished The number of documents that finished the import process in the last 10 seconds.
  60SecondImportFinishedPerSecond The average number of documents that finished the import process per second over the last 60 seconds.
  60SecondImportFinished The number of documents that finished the import process in the last 60 seconds.
  1hourImportFinishedPerSecond The average number of documents that finished the import process per second over the last 1 hour.
  1hourImportFinished The number of documents that finished the import process in the last 1 hour.
  24hourImportFinishedPerSecond The average number of documents that finished the import process per second over the last 24 hours.
  24hourImportFinished The number of documents that finished the import process in the last 24 hours.
  10SecondImportCancelledPerSecond The average number of documents that started the import process but were canceled, per second over the last 10 seconds.
  10SecondImportCancelled The number of documents that started the import process but were canceled, in the last 10 seconds.
  60SecondImportCancelledPerSecond The average number of documents that started the import process but were canceled, per second over the last 60 seconds.
  60SecondImportCancelled The number of documents that started the import process but were canceled, in the last 60 seconds.
  1hourImportCancelledPerSecond The average number of documents that started the import process but were canceled, per second over the last 1 hour.
  1hourImportCancelled The number of documents that started the import process but were canceled, in the last 1 hour.
  24hourImportCancelledPerSecond The average number of documents that started the import process but were canceled, per second over the last 24 hours.
  24hourImportCancelled The number of documents that started the import process but were canceled, in the last 24 hours.

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 server contains.
  Sections The number of document sections that this IDOL server contains.
  TotalSlots The total number of document sections that the IDOL server 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 server 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.
  CommandsRejectedDiskFull The number of index actions that were rejected because the disk was full.
  CommandsRejectedInvalidIndexCode The number of index actions that were rejected because their index code was not valid.
[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 server 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.
[Server] Class
[Tasks]
  Number The number of tasks set up in the configuration file.
  StartTask The first task that is performed.
  IndexCommands The number of index actions that have been processed (the number displayed includes any index action that is currently being processed).
  Documents The number of documents that have been processed (the number displayed includes any document that is currently being processed).
  DocumentSuccesses The number of documents that have been processed successfully.
  DocumentFailures The number of times that document processing has failed.
  Sections The number of document sections processed.
[Tasks] Class
[TaskName]
  Requests The number of requests sent to a specific task.
  Successes The number of requests processed successfully by a specific task.
  Failures The number of request-processing failures for a specific task.
[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.
[CHILDSTAT] Class
[AllChildren]  
  TotalUpEvents The number of times a DIH child server was marked up.
  TotalDownEvents The number of times a DIH child server was marked down.
[EngineN]  
  UpEvents The number of times this DIH child server was marked up.
  DownEvents The number of times this DIH child server was marked down.
  CommandsSent The number of actions that were sent to this DIH child server.
  Retries The number of times actions to this DIH child server were retried.
  TotalBytesSent The total number of bytes of data that were sent to this DIH child server.
  AvgSendCommandRate The average rate that actions were sent to this DIH child server.
  MinResponseTime The smallest time that DAH took to respond to a request.
  AvgResponseTime The average time that DAH took to respond to requests.
  MaxResponseTime The largest time that DAH took to respond to requests.
  SuccessfulActions The number of actions that were successfully completed.
  FailedActions The number of actions that failed.
  Timeouts The number of actions that timed out.

Example

action=GetStatistics

Parameters

None.


_HP_HTML5_bannerTitle.htm