The next series of contents will cover the basic Knowledge of Monitor APIs in different Platform.
Understanding API Monitoring
Objective
After completing this lesson, you will be able to explore fundamental concepts of API monitoring to enhance performance across multiple platforms.
Introduction
OData and SOAP API Log
Before you want to monitor the OData/SOAP API logs you should ensure you have already enabled the permissions for them.
Overview
You will learn the API log details from the following several slides. To view the payload information, in the log table select the button under the "HTTP" or "REST" columns. You will see the HTTP payload or the REST payload details. The Request ID column in the log table can be used to record and display the request id for each recorded OData API call. You can use request ids as search criteria when needed.
Request
This is the OData API Audio Logs request, you can check the request details, it always easy to find the Select clause in the request detail.
Response
The corresponding is the response detail, also you can check the response detail to easy get the valuable information.
Response Log
Sometimes there are some error or warning information in the tail of response, you canknow the exception through these messages.
SOAP API Header
Audit Debug Log in Provisioning
Also we can monitor the process and service via the Audit Debug Log in Provisioning.Here you need to enter session ID to get exceptions caused by API calls from server log (same information available in splunk)
Monitor Jobs
The screenshot give us another way to monitor the APIs by monitor jobs in the provisioning. For this monitor you can get/download the status of job status (Import/Export/Sync) in the provisioning.
Monitor Message Processing
The message monitor provides an overview of the messages processed on a tenant and allows you to display the details for individual messages. You open the message monitor with the following actions: Click a tile in the Monitor Message Processing area. Messages are displayed according to the filter settings of the tile, you can control which messages are displayed by changing the filter.
Filter Settings
- You can control which messages are displayed by changing the filter.
- You can filter messages by Status, Time, Artifact, or by ID.
Manage Integration Content
The Manage Integration Content section provides an overview of integration content artifacts, such as integration flows, that have been deployed on the tenant. Artifacts with the corresponding status and type (of the tile) are displayed. You can adapt the set of displayed artifacts by changing the filter. When you click on the Status of an artifact, the artifact details are displayed in full page mode, and the following additional details are displayed (such as processing time and integration flow name).
Integration Content Overview
As a result of the filter settings, a list of integration artifacts is displayed in a table with the following attributes:
- Status
- Type
- Artifact
Security Material Overview
The Manage Security Material area provides an overview of security-related artifacts.
To create/deploy a new artifact, choose Add and select the artifact type (possible for the following artifact types: Credential, and Known Hosts (SSH)).
To edit and redeploy an existing artifact, select the artifact in the table and choose Edit (only supported for editable artifacts).
To download an artifact, select the artifact in the table and choose Download (not available for Credentials).
You can also delete an artifact (supported for all artifact types except Keystore).
A list of security material is displayed in a table. For each artifact, the following attributes are displayed:
- Type
- Status
- Deployed by
- Deployed on
HTTP Response Codes
| Error Types Eligible for Retry | Additional Notes |
|---|---|
| HTTP Response Code 5XX (other than 500) | A 500 error will not recover because it is due to a problem with your query or payload. Note 503 Service Not Available may occur when a server is overloaded but it may also occur during maintenance periods.
|
| HTTP Response Code 412 | For edit operations can occur during optimistic locking on back-end transactions. This includes specific transaction in a $batch and specific instances in an multi record Upsert payload.
|
| HTTP Timeout errors | Can be retried but only if your client timeout matches the SuccessFactors infrastructure timeout of 5 minutes. If you retry a timeout before this period you will be stacking transactions on top of each other and will be performing a possible denial of service attack. |
| HTTP Connection Reset and no response is from server side | |
| Invalid Session | This can occur when a server fails and load balancer moves requests to a new server. |
| HTTP 401 Response Code | Do not retry 401 Authentication Failed errors, your credentials won’t be accepted on the 2nd try either. |
| HTTP 404 Response Code | Resource not found as there will be no chance of recovery if you are querying something that does not exist. |
| HTTP 400 Response Code (data problems) | These can occur for edit operations that are missing required data or have incorrect formats. |
| Do not retry Create/POST nor Upsert Operations where the object has an auto-increment key. Both can result in duplicate data. |
Monitor APIs
Process Overview
This simulation demonstrates the basic configuration steps required to manually set up the configuration for SAP SuccessFactors Employee Central. You will get the basic knowledge of OData API call & Tools. How to monitor the APIs for different partners.
Prerequisites
The following configuration and customization must have been completed before implementing Basic Settings in SAP SuccessFactors.
- Access to OData SFAPI
- Access to Audio Log
- Access to API Tools
Result
As part of this demonstration, we will cover configuration section in EC, which is: Monitoring APIs.