This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

ARGetServerStatistics

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves the requested statistics for the specified server. The counts returned generally represent the number of occurrences since starting the server. If a statistic reaches the maximum value for a long integer, the system resets the counter and begins incrementing again.

Privileges

All users.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"

int ARGetServerStatistics(
   ARControlStruct *control,
   ARServerInfoRequestList *requestList,
   ARServerInfoList *serverInfo,
   ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

requestList

A list of one or more statistics to return (see the Statistics Options section that follows).

Return values

serverInfo

The statistics retrieved from the server (see the Statistic Options that follows). The system returns NULL (AR_DATA_TYPE_NULL) for statistics not retrieved due to error.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error checking.

Statistics options

Field Name (Server Statistics form)Statistics optionsDescription
API Calls CountAR_SERVER_STAT_API_REQUESTS (integer)The total number of API requests received.
Bad Password AttemptsAR_SERVER_STAT_BAD_PASSWORD (integer)The total number of times an incorrect password was specified during login.
API Requests Proc-TimeAR_SERVER_STAT_API_TIME (integer)The total processor time (in 1/100 of a second) spent performing API function calls.
Floating Write Token DeniedAR_SERVER_STAT_NO_WRITE_TOKEN (integer)The total number of times a user tried to connect and no floating write token was available.
Floating FTS Token DeniedAR_SERVER_STAT_NO_FULL_TOKEN (integer)The total number of times a user tried to connect and no floating FTS token was available.
Number of Current UsersAR_SERVER_STAT_CURRENT_USERS (integer)The total number of users currently accessing the system.
Fixed Write Lic ConnectionsAR_SERVER_STAT_WRITE_FIXED (integer)The total number of connected users with fixed write licenses.
Floating Write Lic ConnectionsAR_SERVER_STAT_WRITE_FLOATING (integer)The total number of connected users with floating write licenses.
Read Only Lic ConnectionsAR_SERVER_STAT_WRITE_READ (integer)The total number of connected users with no write license.
Fixed FTS Lic ConnectionsAR_SERVER_STAT_FULL_FIXED (integer)The total number of connected users with fixed FTS licenses.
Floating FTS Lic ConnectionsAR_SERVER_STAT_FULL_FLOATING (integer)The total number of connected users with floating FTS licenses.
Non FTS Lic ConnectionsAR_SERVER_STAT_FULL_NONE (integer)The total number of connected users with no FTS license.
Entries Calls Proc-TimeAR_SERVER_STAT_ENTRY_TIME (integer)The total processor time (in 1/100 of a second) spent performing API function calls that manipulate entries.
DB Restructure Proc-TimeAR_SERVER_STAT_RESTRUCT_TIME (integer)The total processor time (in 1/100 of a second) spent performing API function calls that restructure the database.
Non DB Restructure Proc-TimeAR_SERVER_STAT_OTHER_TIME (integer)The total processor time (in 1/100 of a second) spent performing API function calls that do not manipulate entries or restructure the database.
Cache Loading Proc-TimeAR_SERVER_STAT_CACHE_TIME (integer)The total processor time (in 1/100 of a second) spent loading the internal cache to improve performance.
Get Entry Calls CountAR_SERVER_STAT_GET_E_COUNT (integer)The total number of calls made to the ARGetEntry function.
Get Entry Proc-TimeAR_SERVER_STAT_GET_E_TIME (integer)The total processor time (in 1/100 of a second) spent performing the ARGetEntry function.
Set Entry Calls CountAR_SERVER_STAT_SET_E_COUNT (integer)The total number of calls made to the ARSetEntry function.
Set Entry Proc-TimeAR_SERVER_STAT_SET_E_TIME (integer)The total processor time (in 1/100 of a second) spent performing the ARSetEntry function.
Create Entry Calls CountAR_SERVER_STAT_CREATE_E_COUNT (integer)The total number of calls made to the ARCreateEntry function.
Create Entry Proc-TimeAR_SERVER_STAT_CREATE_E_TIME (integer)The total processor time (in 1/100 of a second) spent performing the ARCreateEntry function.
Delete Entry Calls CountAR_SERVER_STAT_DELETE_E_COUNT (integer)The total number of calls made to the ARDeleteEntry function.
Delete Entry Proc-timeAR_SERVER_STAT_DELETE_E_TIME (integer)The total processor time (in 1/100 of a second) spent performing the ARDeleteEntry function.
Merge Entry Calls CountAR_SERVER_STAT_MERGE_E_COUNT (integer)The total number of calls made to the ARMergeEntry function.
Merge Entry Proc-TimeAR_SERVER_STAT_MERGE_E_TIME (integer)The total processor time (in 1/100 of a second) spent performing the ARMergeEntry function.
Get List Entry Proc-TimeAR_SERVER_STAT_GETLIST_E_TIME (integer)The total processor time (in 1/100 of a second) spent performing the ARGetListEntry function.
Get List entry Calls CountAR_SERVER_STAT_GETLIST_E_COUNT (integer)The total number of calls made to the ARGetListEntry function.
Get Entry Stats Calls CountAR_SERVER_STAT_E_STATS_COUNT (integer)The total number of calls made to the ARGetEntryStatistics function.
Get Entry Stats Proc-TimeAR_SERVER_STAT_E_STATS_TIME (integer)The total processor time (in 1/100 of a second) spent performing the ARGetEntryStatistics function.
Filter Execute CountAR_SERVER_STAT_FILTER_PASSED (integer)The total number of filters that were executed (qualification criteria met).
Filter Skipped CountAR_SERVER_STAT_FILTER_FAILED (integer)The total number of filters that were skipped (qualification criteria not met).
Filter Execute Disable CountAR_SERVER_STAT_FILTER_DISABLE (integer)The total number of filters that were evaluated but skipped because they were marked disabled.
Filter Notify Action CountAR_SERVER_STAT_FILTER_NOTIFY (integer)The total number of notify filter actions performed.
Filter Msg Action CountAR_SERVER_STAT_FILTER_MESSAGE (integer)The total number of message filter actions performed.
Filter Logging Action CountAR_SERVER_STAT_FILTER_LOG (integer)The total number of log filter actions performed.
Filter Set Field Action CountAR_SERVER_STAT_FILTER_FIELDS (integer)The total number of Set Fields filter actions performed.
Filter Run Process Action CountAR_SERVER_STAT_FILTER_PROCESS (integer)The total number of run process filter actions performed.
Filter Proc-TimeAR_SERVER_STAT_FILTER_TIME (integer)The total processor time (in 1/100 of a second) spent checking and processing filters.
Escal Executed CountAR_SERVER_STAT_ESCL_PASSED (integer)The total number of escalations that were executed (qualification criteria met).
Escal Skipped CountAR_SERVER_STAT_ESCL_FAILED (integer)The total number of escalations that were skipped (qualification criteria not met).
Escal Execute Disable CountAR_SERVER_STAT_ESCL_DISABLE (integer)The total number of escalations that were evaluated but skipped because they were marked disabled.
Escal Notify Action CountAR_SERVER_STAT_ESCL_NOTIFY (integer)The total number of notify escalation actions performed.
Escal Log Action CountAR_SERVER_STAT_ESCL_LOG (integer)The total number of log escalation actions performed.
Escal Set Field Action CountAR_SERVER_STAT_ESCL_FIELDS (integer)The total number of Set Fields escalation actions performed.
Escal Run Process Action CountAR_SERVER_STAT_ESCL_PROCESS (integer)The total number of run process escalation actions performed.
Escal Proc-TimeAR_SERVER_STAT_ESCL_TIME (integer)The total processor time (in 1/100 of a second) spent checking and processing escalations.
Queue Items Blocked CountAR_SERVER_STAT_NUMBER_BLOCKED (integer)The total number of blocked processes. This statistic, in conjunction with the AR_SERVER_STAT_TIMES_BLOCKED statistic, enables you to determine the approximate number of processes being blocked per instance. For example, if AR_SERVER_STAT_TIMES_BLOCKED is three and AR_SERVER_STAT_NUMBER_BLOCKED is six, the six blocked processes could be distributed in the following possible ways:
  • Two blocked processes in each of the three instances (2+2+2 = 6).
  • Three blocked processes in one instance, two blocked processes in one instance, and one blocked process in one instance (3+2+1 = 6).
  • Four blocked processes in one instance and one blocked process in both of the other two instances (4+1+1 = 6). In this example, the blocked processes could not be distributed as five in one instance, one in one instance, and none in one instance because, by definition, the number of instances represents those times when at least one process is blocked.
Num Queue Items Blocked CountAR_SERVER_STAT_TIMES_BLOCKED (integer)The total number of instances in which at least one process was blocked by the current process. This statistic, in conjunction with the AR_SERVER_STAT_NUMBER_BLOCKED statistic, enables you to determine the approximate number of processes being blocked per instance.
ARServer CPU Proc-TimeAR_SERVER_STAT_CPU (integer)The total CPU time (in 1/100 of a second) used by the server.
DB SQL Commands CountAR_SERVER_STAT_SQL_DB_COUNT (integer)The total number of SQL commands sent to the database.
DB SQL Commands Proc-TimeAR_SERVER_STAT_SQL_DB_TIME (integer)The total processor time (in 1/100 of a second) spent performing SQL commands.
FTS Execution CountAR_SERVER_STAT_FTS_SRCH_COUNT (integer)The total number of FTS operations performed.
FTS Execution Proc-TimeAR_SERVER_STAT_FTS_SRCH_TIME (integer)The total processor time (in 1/100 of a second) spent performing FTS operations.
ARServer Idle TimeAR_SERVER_STAT_IDLE_TIME (integer)The total idle time (in 1/100 of a second) of the server threads when the threads are not processing any requests. The idle time for each thread is determined each time it begins to process a new request. The idle time accumulated after the most recent activity in each thread is not included in this value. Therefore, the total idle time value can grow in an unexpected manner depending on the frequency of requests being handled by the server threads and how those requests are distributed amongst various threads. The accuracy of the idle time value will increase as the level of activity on the server increases and all threads are handling requests.
Network Responding TimeAR_SERVER_STAT_NET_RESP_TIME (integer)The total time (in 1/100 of a second) spent on the network responding to the client.
Filter Push Field Action CountAR_SERVER_STAT_FILTER_FIELDP (integer)The total number of Push Fields filter actions performed.
Escal Push Field Action CountAR_SERVER_STAT_ESCL_FIELDP (integer)The total number of Push Fields escalation actions performed.
Filter Direct SQL Action CountAR_SERVER_STAT_FILTER_SQL (integer)The total number of direct SQL filter actions performed.
Escal Direct SQL Action CountAR_SERVER_STAT_ESCL_SQL (integer)The total number of direct SQL escalation actions performed.
Number of ThreadsAR_SERVER_STAT_NUM_THREADS (integer)The number of threads in a particular queue.
Filter Goto Action CountAR_SERVER_STAT_FILTER_GOTO_ACTION (integer)The number of filter actions that branch to another process.
Filter Call Guide Action CountAR_SERVER_STAT_FILTER_CALL_GUIDE (integer)The number of filter guide actions that call another process.
Filter Exit Guide Action CountAR_SERVER_STAT_FILTER_EXIT_GUIDE (integer)The number of filter guide actions that are terminated.
Filter Goto Guide Label Action Count

AR_SERVER_STAT_FILTER_GOTO_GUIDE_LB

The number of goto guide actions.
Filter Set Field Action - SQL Count

AR_SERVER_STAT_FILTER_FIELDS_SQL (integer)

The number of filters that modify SQL fields.

Filter Set Field Action - $Process$ CountAR_SERVER_STAT_FILTER_FIELDS_PROCESS (integer)The number of filter actions that modify fields.
Filter Set Field Action - Filter API CountAR_SERVER_STAT_FILTER_FIELDS_FLTAPI70 (integer)The number of filter actions that modify fields through the API.
Filter Set Field Action - Filter API Count

AR_SERVER_STAT_FILTER_FIELDS_FLTAPI

The number of filters that modify fields through the API.
Escalation Set Field Action - SQL CountAR_SERVER_STAT_ESCL_FIELDS_SQL (integer)The number of escalations that modify SQL fields.
Escalation Set Field Action - $Process$ CountAR_SERVER_STAT_ESCL_FIELDS_PROCESS (integer)The number of escalations that modify fields.
Escalation Set Field Action - Filter API Count

AR_SERVER_STAT_ESCL_FIELDS_FLTAPI

The number of escalations that modify fields through the API.
Restricted Read Only ConnectionsAR_SERVER_STAT_WRITE_RESTRICTED_READ (integer)The total number of connected users with restricted read licenses.

See also

ARGetServerInfo. See FreeAR for: FreeARServerInfoList, FreeARServerInfoRequestList, FreeARStatusList.

Was this page helpful? Yes No Submitting... Thank you

Comments