search

Azure / api-management-developer-portal

Developer portal provided by the Azure API Management service.
MIT License
488 stars 318 forks source link

Add support for Application Insights in the managed portal #835

Closed JanneMattila closed 4 years ago

JanneMattila commented 4 years ago

In hosted developer portal you do not see insights about end user interactions with the portal. And you do not want to use self-hosted developer portal just to enable this scenario.

Possible solutions:

mikebudzynski commented 4 years ago

@JanneMattila - what insights are you specifically looking for?

You can plug-in Google Analytics to your portal (both managed and self-hosted): https://github.com/Azure/api-management-developer-portal/wiki/Integrate-Google-Tag-Manager

We also have plans for enhancing the developer ecosystem reporting in API Management - but that's further on the roadmap.

JanneMattila commented 4 years ago

I was hoping to use App Insights but did not find any documentation how to do that. For customers it makes sense to use Azure services instead of others (common deployment story with ARM, defined geo-locations etc. benefits).

mikebudzynski commented 4 years ago

Makes sense. Are you looking for any specific telemetry or just general telemetry App Insights provides?

JanneMattila commented 4 years ago

Starting off with basics but then many things would follow:

etc.

mikebudzynski commented 4 years ago

If you have n APIs then which of those are most interesting from the doc page point of view

What do you mean by "the most interesting" and how would you measure it? Do you mean "most useful" instead and would you track it by the number of page views?

JanneMattila commented 4 years ago

Oh sorry let me clarify this:

If you have n APIs then which of those are most interesting from the doc page point of view

By that I mean that if people are viewing different APIs the urls are something like this:

https://devportal/api-details#api=echo-api&operation=modify-resource

https://devportal/api-details#api=products&operation=get

So technically they are in the "same page" (api-details) but of course as provider of the APIs you would like to see how many have viewed the api=products.

If you would get these into App Insights you could create KQL queries and enable you to analyze this information. Hopefully this made more sense.

azaslonov commented 4 years ago

In the last release, we added basic integration for App Insights, which currently logs just generic events. The next step will be emitting specific events across dev portal functionality.

Integration instructions can be found here: https://github.com/Azure/api-management-developer-portal/wiki/Integrate-Application-Insights

mikebudzynski commented 4 years ago

ETA for configuring Application Insights logging in the developer portal via the Azure portal interface is 1-3 months. For emitting more specific events, the current ETA is the first half of 2021.