Column | Description |
API | Name of the API in which the event occurred. Example: SampleAPI |
CorrelationID | The unique identifier that is automatically generated for every request coming to API Gateway and can be used to query the log. Example: MED38e9cfa4-2348-408b-9462-124b2181c1a6:656 |
CustomFields | The custom fields an API Provider can provide to log a new field and value for a transaction event. Example: {"customfield":"customvalue"} |
Description | Message that describes the date and time the API was invoked and the application associated with the API invocation. Example: Invoked at 4/24/18 1:50 PM Consumer Name: Unknown Consumer ID: Unknown |
ErrorOrigin | The origin of error. Example: Nativeserivce |
External Calls | List the external calls from API Gateway. These external calls can be to a native service or service registry. Example: [{ "externalCallType":"SERVICE_REGISTRY_CALL", "externalURL":"http://service.registry.com", "callDuration":49, "callStartTime":1562244570486, "callEndTime":1562244570535, "responseCode": "200" }, { "externalCallType":"NATIVE_SERVICE_CALL", "externalURL": "https://petstore.swagger.io/v2/store/inventory", "callDuration":1285, "callStartTime":1562244569252, "callEndTime":1562244570537, "responseCode":"200" }] |
Native Endpoint | The endpoint URL of the native API being invoked. Example: http://petstore.swagger.io/v2/pet/55 |
Native HTTP Method | The HTTP method used to invoke the native service. Example: GET |
Native Request Headers | Request header in the incoming request from the API Gateway to native service. Example: { "Authorization":"**************", "Accept": "*/*", "Authorization": "**************", "Accept":"*/*", "Cache-Control": "no-cache", "User-Agent": "PostmanRuntime/7.13.0", "Postman-Token": "381424fa-e3b3-4058-8df9-4abf9d72c899", "postmanHeader": "hello", "accept-encoding": "gzip, deflate", "Content-Type": "application/x-www-form-urlencoded" } |
Native Req Payload | The native service request data. Example: { "param1" : "value1", "param2" : 10 } |
Native Response Headers | Response header in the outgoing response from the native service to API Gateway. Example: { "Server":"Jetty(9.2.9.v20150224)", "Access-Control-Allow-Origin":"*", "Access-Control-Allow-Methods": "GET, POST, DELETE, PUT", "Connection":"close", "Date": "Fri, 07 Jun 2019 12:44:13 GMT", "Access-Control-Allow-Headers": "Content-Type, api_key, Authorization", "Content-Type": "application/json" } |
Native Res Payload | The native service response data. Example: { "id":2, "category": { "id":2, "name":"string" }, "name":"pysen", "photoUrls":["string"], "tags": [{ "id":0, "name":"string" }], "status":"available" } |
Native URL | URL of the native service. Example: http://petstore.swagger.io/v2/pet/2 |
Operation/Resource Name | Name of the operation or resource that is being invoked on the API. Example: /pet/{petId} |
QueryParameteres | This is applicable only for REST APIs. Query parameters present in the incoming REST request. Example: {"status":"available"} |
RequestHeaders | Request header in the incoming request from the client. Example: { "Cache-Control":"max-age=0", "Accept":"text/plain,application/json; q=0.9,image/webp,image/apng,*/*; q=0.8", "Upgrade-Insecure-Requests":"1", "Connection":"keep-alive", "User-Agent":"Mozilla/5.0(Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.181Safari/537.36", "Host":"mcdaso02:5555", "Accept-Encoding":"gzip,deflate", "Accept-Language":"en-US,en;q=0.9,ta;q=0.8", "Content-Type":"application/x-www-form-urlencoded" } |
ResponseHeaders | Response header in the outgoing response. Example: { "Server":"Jetty(9.2.9.v20150224)", "Access-Control-Allow-Origin":"*", "Access-Control-Allow-Methods":"GET,POST,DELETE, PUT", "Connection":"close", "Date":"Fri, 30 Mar 2018 08:25:45 GMT", "Access-Control-Allow-Headers":"Content-Type,api_key, Authorization", "Content-Type":"application/xml" } |
Runtime Policy | Name of the runtime policy that is enforced on the API. Example: Log Invocation |
Source Gateway Node | Source API Gateway's IP address. Example: 10.0.75.1 |
Status | Status of the API invocation. Possible values are: SUCCESS, FAILURE |
Version | The system-assigned version identifier for the API. Example: 1.0 |
Column | Description |
API | Name of the API in which the event occurred. Example: SampleAPI |
Action Type | The type of alert generated for the event. Example: Monitor |
Alert Message | Text of the alert message sent to a configured destination when the performance conditions are violated. The alert message is specified in the policy definition of an API. Example: Test |
Attribute | The monitored attribute which has breached the configured SLA. Example: AVGRESPONSETIME GT 1.0, SUCCESSCOUNT EQ 3, REQUESTCOUNT GT 10 |
Consumer ID | The unique identifier for the consumer associated with the API invocation. Example: c0f84954-9732-11e5-b9f4-f159eafe47b2 |
Consumer Name | Name of the consumer associated with the API invocation. A consumer name is populated as unknown when API Gateway is unable to identify the consumer using a policy that is configured for the API. Example: SampleApplication |
Native Endpoint | The endpoint URL of the native API that is being invoked. Example: http://petstore.swagger.io/v2/pet/55 |
Operation/Resource Name | Name of the operation or resource that is being invoked on the API. Example: /pet/{petId} |
Runtime Policy | Name of the runtime policy that is enforced on the API. Example: Log Invocation |
Version | The system-assigned version identifier for the API. Example: 1.0 |