search

Azure / api-management-self-hosted-gateway

Home of Azure API Management's Self-Hosted Gateway
https://docs.microsoft.com/en-gb/azure/api-management/self-hosted-gateway-overview
Other
65 stars 25 forks source link

Please provide documentation on how to get the Trace button in the portal GUI to work #297

Open qfyra opened 3 weeks ago

qfyra commented 3 weeks ago

Proposal

Tracing works using a managed gateway. When using a self-hosted gateway, it does not seem tracing works out of the box, as regardless of config, the message "Trace is not available because response does not contain Apim-Trace-Id header" is shown when pressing the button. Please provide documentation on how to get the Trace button in the portal GUI to work.

Use-Case

Already works with managed gateway. Should work with self-hosted gateway. And although crafting API calls with e.g. REST Client and setting Ocp-Apim-Trace: true is possible, it is vastly more cumbersome compared to having the corresponding functionality readily available in the Trace button.

Anything else?

No response

tomkerkhove commented 3 weeks ago

The trace button only works for managed gateway given the portal does not know where your self-hosted gateway is running.

New tracing API is not supported yet in self-hosted gateway.

Does that answer your question?

qfyra commented 3 weeks ago

Yes it does, thank you. I was under the impression that tracing via the portal GUI was supposed to work with self-hosted gateways, but I'm not sure why I was under that impression 😄

Is there a Github issue that I can add a notification on for the new tracing API?

tomkerkhove commented 3 weeks ago

Not for now but we include things in the release notes