Software AG Products 10.5 | Using API Gateway | API Gateway Analytics | Runtime Events and Metrics Data Model | CentraSite
 
CentraSite
The runtime events and metrics payload generated by API Gateway at run-time is published to the configured CentraSite destination. The columns that make up the events and metrics data model for CentraSite are listed below:
Transactional Events
Column
Description
ApiUserVersion
The system-assigned version identifier for the API.
Example: 1.0
Consumer
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
ConsumerId
The unique identifier for the consumer associated with the API invocation.
Example: be8b27d6-8f79-4c6e-b06c-a628d2ba30c3
Consumer IP Address
IP address of the consumer associated with the API invocation.
Example: 10.60.20.169
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
Created Time
Date and time when the event was generated in API Gateway.
Example: 2017-08-09 01:27:45 AM
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: Nativeserivce
Event Type
The type of event that occurred.
Example: Transaction Event
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 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
PartnerId
The unique identifier for the partner that generated the audit record.
Example: unknown
Provider Round Trip Time
Time in milliseconds required for API Gateway to invoke a native provider and receive a response. This time includes the overhead incurred by API Gateway. Overhead includes the time it takes for a provider to process a request and return a response, plus any network latency to or from the provider. Subtracting total time from provider time must give a rough indicator of the API Gateway overhead.
Example: 1700
queryParameters
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"
}
RequestPayload
The API request payload data.
Example: <RequestPayload>
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"
}
ResponsePayload
The API response payload data.
Example: <ResponsePayload>
Source Gateway Node
Source API Gateway's IP address.
Example: 10.0.75.1
Total Round Trip time
Time in milliseconds required to invoke the API provider. This time includes the overhead incurred by API Gateway. Overhead includes security overhead for encryption, decryption, and load-balance retries.
Example: 1707
Gateway
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Request Status
Status of the API request.
Possible values are: SUCCESS, FAILURE
Error Events
Column
Description
ApiUserVersion
The system-assigned version identifier for the API.
Example: 1.0
Consumer
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
ConsumerId
The unique identifier for the consumer associated with the API invocation.
Example: be8b27d6-8f79-4c6e-b06c-a628d2ba30c3
Consumer IP Address
IP address of the consumer associated with the API invocation.
Example: 10.60.20.169
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
Created Time
Date and time when the event was generated in API Gateway.
Example: 2017-08-09 08:24:04 AM
Error Source
The source where the error occurred.
Example: e1cc3c7b-495d-11e7-a5a6-88cf17308ba4
Error Description
Message that describes the error that occurred.
Example: Resource / not found
Event Type
The type of event that occurred.
Example: Error Event
Gateway
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Monitoring Events
Column
Description
ApiUserVersion
The system-assigned version identifier for the API.
Example: 1.0
Alert Source
Name of the API Gateway policy that generated the alert message.
Example: Monitorpolicy, EnforcePolicy-HardLimit
Alert Type
The type of alert generated for the event.
Possible values are: Monitor, Sla
Alert Description
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: MSLA_ALERT MESSAGE
Consumer
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: SUCRQ_App
ConsumerId
The unique identifier for the consumer associated with the API invocation.
Example: d0e2e008-1890-4f2c-8a91-7678cb92dbfb
Consumer IP Address
IP address of the consumer associated with the API invocation.
Example: 10.60.37.118
Created Time
Date and time when the event was generated in API Gateway.
Example: 2017-08-08 02:27:34 PM
Event Type
The type of event that occurred.
Example: Monitoring Event
Error Description
Message that describes the error that occurred.
Example: Resource / not found
Gateway
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Monitored Attribute
The monitored attribute which has breached the configured SLA.
Example: AVGRESPONSETIME GT 1.0, SUCCESSCOUNT EQ 3, REQUESTCOUNT GT 10
Policy Violation Events
Column
Description
ApiUserVersion
The system-assigned version identifier for the API.
Example: 1.0
Alert Source
Name of the API Gateway policy that generated the alert message.
Example: Unknown-Policy
Alert Type
The type of alert generated for the event.
Example: PolicyViolation
Alert Description
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: A violation of policy was detected : Unable to identify the application for the request
Consumer
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: unknown
ConsumerId
The unique identifier for the consumer associated with the API invocation.
Example: unknown
Consumer IP Address
IP address of the consumer associated with the API invocation.
Example: 10.60.37.118
Created Time
Date and time when the event was generated in API Gateway.
Example: 2017-08-09 08:25:52 AM
Event Type
The type of event that occurred.
Example: Policy Violation Event
Gateway
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Lifecycle Events
Column
Description
TimeStamp
Date and time when the event was generated in API Gateway.
Example: 2017-08-26 04:13:35 PM
Target
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
LifeCycleStatus
Status of the API Gateway instance.
Possible values are: STARTED or STOPPED
LifeCycleAlertDescription
The alert notification message for the lifecycle event.
Example: Alert_Message