Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Mail thread: (CSIPEMDEVSPRT-340) info on api manager statistics model

...

Code Block
titleorg.wso2.apimgt.statistics.request
consumerKey     :       STRING			: 			Consumer key of API invoked client application	
context         :       STRING			: 			API context depending on the user's request
api_version     :       STRING			: 			API synapse artifact contained name [API Provider +"--"+API Name]
api             :       STRING			: 			API Name
resourcePath    :       STRING			: 			API resource URL pattern of API request
method          :       STRING			: 			HTTP Verb of API request [e.g.:GET/POST]
version         :       STRING			: 			API version
request         :       INT				: 			Request count (e.g. 1)
requestTime     :       LONG			: 			API request hit time in APIM
userId          :       STRING			: 			API invoked end user name
tenantDomain    :       STRING			: 			Tenant domain of API provider
host    hostName        :       STRING			: 			API Manager server host
apiPublisher    :       STRING			: 			API provider
application  applicationName   :       STRING			: 			Name of the client application
applicationId   :       STRING			: 			ID of the client application
userAgent       :       STRING			: 			User agent of the user
tier            :       STRING			: 			Name of the throttling policy assigned to the request	
throttledOut    :       BOOL			: 			Describes whether this is a throttled request or not

org.wso2.apimgt.statistics.response

This stream tracks information for the API response. It includes the time taken for the response to get back, the received time etc.

Code Block
titleorg.wso2.apimgt.statistics.response
consumerKey
clientip        :       STRING			: 			Consumer key of the client application invoking the API context:         :   IP Adress of the Client
applicationOwner:       STRING          :            Name of the Owner of the Application


org.wso2.apimgt.statistics.response

This stream tracks information for the API response. It includes the time taken for the response to get back, the received time etc.

Code Block
titleorg.wso2.apimgt.statistics.response
consumerKey     :       STRING			: 			Consumer key of the client application invoking the API
context         :       STRING			: 			API context depending on the user's request
api_version     :       STRING			: 			API synapse artifact contained name [API Provider +"--"+API Name]	
api             :       STRING			: 			API Name
resourcePath    :       STRING			: 			API resource URL pattern of API request
resourceTemplate:       STRING          :           API resource URL template of the API request
method          :       STRING			: 			HTTP Verb of API request [e.g.:GET/POST]
version         :       STRING			: 			API version
response        :       INT				: 			Response count (e.g. 1)
responseTime    :       LONG			: 			Total time taken for request/response flow[serviceTime+backendTime]
serviceTime     :       LONG			: 			Time taken to serve the API request in APIM side
backendTime     :       LONG			: 			Time taken process the request at the backend	
user    username        :       STRING			: 			API invoked end user name	
eventTime       :       LONG			: 			Timestamp of response event published
tenantDomain    :       STRING			: 			Tenant domain of API provider
host  hostname          :       STRING			: 			API Manager server hostname
apiPublisher    :       STRING			: 			API provider
application  provider
 applicationName :       STRING			: 			Name of the client application
applicationId   :       STRING			: 			ID of the client application
cacheHit        :       BOOL			: 			Describes if response caching is enabled or not
responseSize    :       LONG			: 			Response message size in bytes	
protocol        :       STRING 			: 			Protocol used to send the response (HTTP/HTTPS) and the port
responseCode    :       STRING          :           HTTP Response Code
destination     :       STRING          :           URL of the Desination IP

org.wso2.apimgt.statistics.fault

...