Monitoring API calls
To enable API monitoring
- In a browser, open the AR System Administration Console, and select System > General > Server Information.
The AR System Administration: Server Information form appears. - Click the Advanced tab.
- In the API Recording Client Types box, enter the client types for which you want to monitor the API calls.
Specify values (separated by semicolons) in the following format:
clientType;IPAddressExpression;clientType;IPAddressExpression
- The clientType parameter indicates the client type to be monitored. This takes an integer value. An asterisk (*) value for this parameter indicates that API calls from all client types must be monitored. For information about supported client types and their values, see the Client types table below.
- (Optional) The IPAddressExpression parameter indicates a regular expression used to match the source address. If you do not specify a value, all source addresses are matched.
By default, the API Recording Client Types box does not have any value, which means that the calls from all client types are monitored.
- The clientType parameter indicates the client type to be monitored. This takes an integer value. An asterisk (*) value for this parameter indicates that API calls from all client types must be monitored. For information about supported client types and their values, see the Client types table below.
- In the Enable API Recording box, select Yes to enable the system for monitoring.
By default, monitoring is disabled. - Save the changes.
For more information about options on the Advanced tab, see Setting-performance-and-security-options.
To view API call details
To open the AR System API Statistics, enter the URL in a browser in the following format: http://midTier:port/arsys/forms/server/AR+System+API+Statistics.
The AR System API Statistics form displays the following information:
Field name | Description |
|---|---|
Client type | Type of client that initiated an API call (see the following table) |
Total count | Total number of successful and failed calls |
Error count | Number of unsuccessful calls |
Client IP Address | IP address of the client making a call |
End client IP Address | IP address of the client using the Mid Tier or the web service |
Data In | Total number of bytes sent as a request from the source IP address |
Data Out | Total number of bytes sent out as a response to the API call |
Start Timestamp | Time when the API call monitoring started, specified in hours. The monitoring time frame is 1 hour. |
End Timestamp | End time of API call monitoring; for example, if the start time is 03:00, the end time will be 04:00. |
Server | IP address of the computer where the AR System server is running |
The following table lists the supported client types and the value associated with each client type:
Client type | Value |
|---|---|
Unknown | 0 |
Pre-5.0 AR System clients | 1 |
Administrator | 2 |
User | 3 |
Data Import | 4 |
Distributed Server Option (DSO) | 5 |
AR System Open Database Connectivity (ODBC) | 6 |
Approval Server | 7 |
AR Web Server | 8 |
Mid Tier | 9 |
Palm Pilot | 10 |
Flashboards | 11 |
FlashboardsMid Tier | 12 |
Enterprise Integration Engine | 13 |
arcache | 15 |
ardist | 16 |
runmacro | 17 |
armail | 18 |
Command-line import tool | 19 |
Report Creator plug-in | 20 |
Alert Tool | 21 |
Email Engine | 22 |
arsignal | 23 |
Debugger | 24 |
Object Store API | 25 |
Object Store Sync Utility | 26 |
Server Administration plug-in | 27 |
Service Impact Management Publishing server | 28 |
Service Impact Management Service Model Editor | 29 |
CMDB Engine | 30 |
CMDB Driver | 31 |
CMDB Reconciliation Engine | 32 |
Assignment Engine | 33 |
AR System Web Service | 34 |
CMDB Normalization Engine | 35 |
Developer Studio | 36 |
Full Text Reader | 37 |
Atrium Single Sign-On Server | 38 |
AR Migrator | 39 |
AR UDM Adapter | 40 |
Knowledge Management Operations plug-in | 41 |
Knowledge Management Form Permissions plug-in | 42 |
Knowledge Management Document Migrator plug-in | 43 |
Knowledge Management File System plug-in | 44 |
Knowledge Management File System Sync plug-in | 45 |
Knowledge Management Group plug-in | 46 |
Knowledge Management Registration plug-in | 47 |
Asset Management SWLM Rule Engine plug-in | 48 |
Asset Management Software Usage plug-in | 49 |
Asset Management RLE Configuration plug-in | 50 |
Asset Management Charge Back plug-in | 51 |
IT Service Management (ITSM) Common plug-in | 52 |
ITSM CAI plug-in | 53 |
ITSM Utility plug-in | 54 |
ITSM AppQuery plug-in | 55 |
ITSM Next ID plug-in | 56 |
Atrium Integrator | 57 |
Discovery | 58 |
Proactive Performance Management | 59 |
ODBC driver | 60 |
DWP | 61 |
Service Context plug-in | 62 |
CMDB Impact Simulator | 63 |
Unified Service Model | 64 |
Notification Engine | 65 |
Deprecation Plug-in | 66 |
Dynamic Service Model plug-in | 67 |
Drift Management | 68 |
Federation plug-n | 69 |
Event Engine Channels plug-in | 70 |
Server Group Management Console Utility plug-in | 71 |
Server Group Management Console Action plug-in | 72 |
File Deployer | 73 |
arsrename | 74 |
Chatbot Provider Twilio | 75 |
Chatbot Provider Slack | 76 |
Chatbot Provider Skype | 77 |
Innovation Suite REST API | 78 |
Driver | 4000 |
Dispatcher | 4001 |
arhelp | 4002 |
arjanitor | 4003 |
armenu | 4004 |
arstruct | 4005 |
artext | 4006 |
arsqled | 4007 |
archgsel | 4008 |
archgid | 4009 |
arlabel | 4010 |
AR System Installer | 4011 |
Install Kit (RIK) | 4012 |
Smart Reporting | 4013 |
JDBC Driver | 4014 |
D2P | 4015 |
GDPR | 4016 |
Palm Pilot Parallel | 4017 |
Health Monitor | 4018 |
Plug-in server | 4019 |
Progressive App | 4020 |
Helix Dashboards | 2021 |
Reserved range | 5000 |