I am having following doubts in ApiManagementGatewayLogs under log analytics: In ApiManagementGatewayLogs what is actually TotalTime, BackendTime and Client Time which is captured? ( https://learn.microsoft.com/en-us/azure/api-management/gateway-log-schema-reference ) I got some reference from this link but still its not clear and we can't understand relation between the numbers captured in it ) In ApiManagementGatewayLogs the correlationId is captured, but its random GUID always . How to control the correlation ID we are using trace parent or request Id headers but the correlationId captured is always found different?

For the first part of the question, TotalTime : Time spent for an API request end to end at APIM side. BackendTime : Time spent for the roundtrip call to your backend for the API (includes the time taken by your backend API server). ClientTime : Time spent on the request for client operations i.e. client http request receive and response send. NOTE: It may not get logged always. Ideally, TotalTime = BackendTime + ClientTime + Time required for other processing e.g. APIM policy execution etc.. Please feel free to clarify if the above still not clear or you are looking for something else. For the next part of the question regarding 'CorrelationId' in ApiManagementGatewayLogs, it's APIM diagnostics logs and unfortunately, which does not infer it from http header like Request-Id or traceparent (W3C standard). Alternatively, you may want to look at Integrating Azure API Management with Azure Application Insights which supports Telemetry Correlation from http headers.

clarification regarding ApiManagementGatewayLogs log table fields

Accepted answer

Krish G 2,331 Reputation points

2021-01-16T08:22:21.663+00:00

For the first part of the question,
TotalTime: Time spent for an API request end to end at APIM side.
BackendTime: Time spent for the roundtrip call to your backend for the API (includes the time taken by your backend API server).
ClientTime: Time spent on the request for client operations i.e. client http request receive and response send. NOTE: It may not get logged always.
Ideally, TotalTime = BackendTime + ClientTime + Time required for other processing e.g. APIM policy execution etc..

Please feel free to clarify if the above still not clear or you are looking for something else.

For the next part of the question regarding 'CorrelationId' in ApiManagementGatewayLogs, it's APIM diagnostics logs and unfortunately, which does not infer it from http header like Request-Id or traceparent (W3C standard). Alternatively, you may want to look at Integrating Azure API Management with Azure Application Insights which supports Telemetry Correlation from http headers.
Please sign in to rate this answer.

1 person found this answer helpful.
MuhamedSalihSI 71 Reputation points

2021-01-18T05:34:33.493+00:00

just one about more ask,

TotalTime = BackendTime + ClientTime + Time required for other processing

In this above sum up of TotalTime.
sometimes the TotalTime is less than sum of BackendTime + ClientTime + Time required for other processing by some milliseconds
why is that so?

Krish G 2,331 Reputation points

2021-01-18T09:23:23.787+00:00

Let me check it. Can you please show an example in your case?

MuhamedSalihSI 71 Reputation points

2021-01-18T09:50:17.247+00:00

This are in split milli seconds diff but want to know it.
Not an issue if clear info provided.

Krish G 2,331 Reputation points

2021-01-18T10:14:00.267+00:00

In your screenshot, I do not see an example of TotalTime less than sum of BackendTime + ClientTime

MuhamedSalihSI 71 Reputation points

2021-01-18T12:15:23.84+00:00

sorry, My mistake wrongly mentioned it other way around.

its BE+CT < Total Time by 0.00xx milli seconds,
Can I consider those as log delay or network internal lattency?

If there is api call(JWT validation form external server) from apim ,those send-request time also added up with Backend time.
Is my understanding, right?
(cause I am observing it from my apim logs)

anyway thanks @KrishnenduGhosh-MSFT

Krish G 2,331 Reputation points

2021-01-18T12:51:59.767+00:00

Ideally, TotalTime = BackendTime + ClientTime + Time required for other processing. So, BE+CT < Total Time is normal as rest of the time is taken by that other part.

If there is api call(JWT validation form external server) from apim ,those send-request time also added up with Backend time.
Is my understanding, right?

Yes. (I guess you are referring https://learn.microsoft.com/en-us/azure/api-management/api-management-sample-send-request#send-request ?)

MuhamedSalihSI 71 Reputation points

2021-01-18T13:00:11.993+00:00

Exactly we are using this send-request to validateJWT from external server

Does its time also added to BackendTime?

Krish G 2,331 Reputation points

2021-01-19T09:47:06.333+00:00

Yes correct

MuhamedSalihSI 71 Reputation points

2021-01-22T15:55:29.083+00:00

Hi @KrishnenduGhosh-MSFT,
I have some questions again,

we recently found clientTime is populated with some values.
what does clientTime composed of? or what it means actually?

Sometime, we found some oddity that responseCode is 0 what it actually means in API management gateway logs?

Krish G 2,331 Reputation points

2021-01-25T06:01:10.677+00:00

clientTime is the duration of time for http operations (e.g. send, receive I/O etc.) required for the client i.e. your API caller.
Regarding responseCode 0, can you please show an example for me to see?

MuhamedSalihSI 71 Reputation points

2021-01-25T19:54:14.303+00:00

Yes, @KrishnenduGhosh-MSFT I can share a scrn shot.

APIMGatewayLog found to have ResultCode column populated with 0, which is not expected behavior right?

Krish G 2,331 Reputation points

2021-01-29T06:45:37.757+00:00

Can you check if those are success response, generally 0 response code can happen in case of cancelled/blocked requests.
https://stackoverflow.com/questions/872206
https://stackoverflow.com/questions/63572194

MuhamedSalihSI 71 Reputation points

2021-02-01T11:50:19.613+00:00

Sorry for the delay in response @KrishnenduGhosh-MSFT
Thanks, for the reference.
Yes, it's found to be the request that failed at APIM gateway layer.
It sometimes populate response code with 0.
Sign in to comment

Share via

clarification regarding ApiManagementGatewayLogs log table fields

0 additional answers