Intercept and enrich (with custom data) messages logged in AppInsights by Azure APIM.

Question

Intercept and enrich (with custom data) messages logged in AppInsights by Azure APIM.

Kumar 111

In Azure API Management, we have configured Diagnostic Logs (request, response, trace, headers etc.) to be sent to Application Insights.

We would like to add some custom data to every log sent to Application Insights.

Within APIM is there an option to intercept the log message and add custom properties before sending to Application Insights?

If not, what would be an alternative. Am looking for a more generic solution where we don't have to make changes to policies in each API.

Please clarify.

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-03-16T15:03:19.93+00:00

Kumar Thank you for posting your question in Microsoft Q&A. It looks like you are already aware of telemetry such as trace, headers, request/response being sent to Application Insights from APIM. Can you elaborate more on custom data/properties you are looking to send? If you can describe more about use case/scenario, that would help us in understanding it better.
Kumar 111 Reputation points

2023-03-16T18:51:47.95+00:00
We have some static meta-data that we would like to ingest into application insights/log analytics as part of every log entry.

The intent is to provide better dashboards(workbooks) to business users. That said the ask is

At a global level can we intercept all log from APIM (trace, exception, request, response logs etc.) going into AppInsights and ingest the metadata as opposed to adding logic in each of the policies for every API?

or Is there a way to create a custom table in log analytics and load with the static metadata so that we can join against the table when building queries for dashboard.

or is there another better way?

Hope this clarifies the ask.

Thanks

Kumar
MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-03-20T15:08:17.6333333+00:00

Kumar If you have any other questions related to this, let me know. Would be happy to answer them.

1 answer

Your answer

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-03-16T15:03:19.93+00:00

Kumar Thank you for posting your question in Microsoft Q&A. It looks like you are already aware of telemetry such as trace, headers, request/response being sent to Application Insights from APIM. Can you elaborate more on custom data/properties you are looking to send? If you can describe more about use case/scenario, that would help us in understanding it better.
Kumar 111 Reputation points

2023-03-16T18:51:47.95+00:00

We have some static meta-data that we would like to ingest into application insights/log analytics as part of every log entry.

The intent is to provide better dashboards(workbooks) to business users. That said the ask is

At a global level can we intercept all log from APIM (trace, exception, request, response logs etc.) going into AppInsights and ingest the metadata as opposed to adding logic in each of the policies for every API?

or Is there a way to create a custom table in log analytics and load with the static metadata so that we can join against the table when building queries for dashboard.

or is there another better way?

Hope this clarifies the ask.

Thanks

Kumar
MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2023-03-20T15:08:17.6333333+00:00

Kumar If you have any other questions related to this, let me know. Would be happy to answer them.

Answer 1

Kumar Use trace policy to add custom trace to request tracing output and this creates a Trace telemetry in App Insights based on severity level. Check out doc: Trace for more info on this (Policy scopes: global, product, API, operation) and you can apply this policy at the global level so that you don't have add it in each API.

Currently, it is not possible to add custom data to App Insights without writing policy. If you have any feedback or suggestions, you can directly submit to our product team via https://aka.ms/apimwish and others with similar interests can upvote your idea too. I hope this helps with your question and let me know if any other questions.

Share via

Intercept and enrich (with custom data) messages logged in AppInsights by Azure APIM.

1 answer

Your answer