Local Log

Edit online

The runtime events and metrics payload generated by API Gateway at run-time is published to the configured Local Log destination. The columns that make up the events and metrics data model for Local Log are listed below:

Transactional Events

Column Description
ApiName Name of the API in which the event occurred.

Example: SampleAPI

ApiVersion The system-assigned version identifier for the API.

Example: 1.0.0

ApplicationID The unique identifier for the application associated with the API invocation.

Example: 7908eb44-d107-4670-929d-89111fc9347c

ApplicationIP IP address of the application associated with the API invocation.

Example: 10.60.37.42

ApplicationName Name of the application associated with the API invocation.

An application name is populated as unknown when API Gateway is unable to identify the application using a security policy that is configured for the API.

Example: SampleApplication

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"}

ErrorOrigin The origin of error.

Example: Nativeservice

EventSource

The source where the event occurred.

Example: API_Gateway_Instance

NativeHttpMethod The HTTP method used to invoke the native service.

Example: GET

nativeRequestPayload The native service request data.

Example: 


{ 
"param1" : "value1", 
"param2" : 10
}
nativeResponsePayload 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 API operation or resource that is invoked.

Example: /pet

Partner ID The unique identifier for the partner that generated the audit record.

Example: unknown

SessionId
queryParams 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"
}
Session Id A string the API Gateway server generates to uniquely identify each session. This is either the IS session token or the automatically generated GUID if the token is missing from the message context.

Example: 81439d366e874bc79d9f81490e30e6e0

Source Gateway Node Source API Gateway's IP address.

Example: 10.0.75.1

TargetEPR The endpoint URL of the native API that is invoked.

Example: http://petstore.swagger.io/v2/pet/55

Monitoring Events

Column Description
alertDesc 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: EnforcePolicy-HardLimit

alertSource Name of the API Gateway policy that generated the alert message.

Example: Unknown-Policy

apiName Name of the API in which the event occurred.Example:

Example: SampleAPI

apiVersion The system-assigned version identifier for the API.

Example: 1.0

applicationId The unique identifier for the application associated with the API invocation.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

applicationIp IP address of the application associated with the API invocation.

Example: 10.20.248.33

applicationName Name of the application associated with the API invocation.

An application name is populated as unknown when API Gateway is unable to identify the application using a security policy that is configured for the API.

Example: SampleApplication

creationDate

Date and time when the event was generated in API Gateway.

Example: 1501671101509

eventType

The type of event that occurred.

Example: Policy Violation Event

monitorAttr

The monitored attribute which has breached the configured SLA.

Example: AVGRESPONSETIME GT 1.0, SUCCESSCOUNT EQ 3, REQUESTCOUNT GT 10

Native Endpoint The endpoint URL of the native API that is invoked.

Example: http://petstore.swagger.io/v2/pet/55

Operation/Resource name Name of the API operation or resource that is invoked.

Example: /pet