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
[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.
[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.

The following statistics are returned by all connectors.

NOTE: Connectors can return a considerable number of statistics, especially if you configure several fetch tasks.

The autnid attribute in the response describes the fetch action and task to which a statistic belongs:

<autn:stat class="Connector" autnid="SYNCHRONIZE:MYTASK" name="IngestAddsTotal" metric="6" value="2937" />

For each of the statistics described in the tables below, the connector returns totals and averages for various time durations (by default 10Second, 60Second, 5Minute, 30Minute, 1Hour, 3Hour, 24Hour, and 7Day). Using the IngestAdds statistic as an example:

  • IngestAddsTotal is the total number of ingest-adds recorded since the connector started. If the total is zero, the entire IngestAdds group of statistics is omitted from the response.
  • IngestAddsCurrentTotals is the number of ingest-adds for actions that are currently running. You cannot run simultaneous synchronize actions for the same task, but you might run simultaneous collect actions for the same task. This statistic is returned only when at least one action is running.
  • IngestAddsPreviousTotals is a comma-separated list describing the number of ingest-adds resulting from previous actions. The list contains up to 24 values, and the first value is the oldest. New values are added to the end of the list when actions finish. This statistic is returned only if a task has completed at least once since the connector started.
  • 5MinuteIngestAddsPerSecond is the average number of ingest-adds per second over the last 5 minutes.
  • 24HourIngestAddsPerSecond is the average number of ingest-adds per second over the last 24 hours. If the connector has been running for less than 24 hours, the value is averaged over the actual uptime.
Connector Class
Statistic Description

IngestAdds

IngestAdds:IdentifierType

The number of ingest-adds (new documents found in the repository, and changes to the content of existing documents).

Some connectors return a value for each identifier type. For example 5MinuteIngestAdds:FilePerSecond is the average number of ingest adds per second (for files) over the last 5 minutes. The identifier types are different for each connector. For more information about identifier types, see the documentation for the Identifiers fetch action.

IngestUpdates

IngestUpdates:IdentifierType

The number of ingest-updates (existing documents where the metadata has changed but the content has not).

Some connectors return a value for each identifier type. For example 30MinuteIngestUpdates:FilePerSecond is the average number of ingest updates per second (for files) over the last 30 minutes. The identifier types are different for each connector. For more information about identifier types, see the documentation for the Identifiers fetch action.

IngestDeletes

IngestDeletes:IdentifierType

The number of ingest-deletes (documents that were deleted from the repository).

Some connectors return a value for each identifier type. For example 3HourIngestDeletes:FilePerSecond is the average number of ingest deletes per second (for files) over the last 3 hours. The identifier types are different for each connector. For more information about identifier types, see the documentation for the Identifiers fetch action.

IngestFailures The number of documents that failed ingestion.
ErrorsReported The number of errors logged.

The following statistics are returned by File System Connector:

Connector Class
Statistic Description
NewFiles The number of new files found by the connector.
FilesAnalyzed The number of files the connector has seen (which may be changed or unchanged).
DirectoriesRejected The number of folders that the connector did not process due to the task configuration.
FilesRejected The number of files that the connector did not process due to the task configuration.

Example

action=GetStatistics

Parameters

None.