【Azure|【Azure API 管理】在APIM 中添加 log-to-eventhub 策略，把 Request Body 信息全部记录在Event Hub中【AzureAPI管理】在APIM中添加l

问题描述根据文档 https://docs.azure.cn/zh-cn/api-management/api-management-howto-log-event-hubs ，可以将Azure API Management中的请求记录到Azure 事件中心。文档中有详细的步骤描述。但是在对于如何创建APIM的Logger，如何在API中配置策略描述非常不清楚，所以本文就补充如何创建Logger及在APIM的API中添加log-to-eventhub 策略。
前提条件

创建 Azure 事件中心：https://docs.azure.cn/zh-cn/event-hubs/event-hubs-create

Create APIM Logger： https://docs.microsoft.com/zh-cn/rest/api/apimanagement/2020-12-01/logger/create-or-update

Postman

下载 Service Bus Explorer查看事件中心消息：https://github.com/paolosalvatori/ServiceBusExplorer/releases

操作步骤 1) 创建APIM Logger 示例

PUT https://management.chinacloudapi.cn/subscriptions//resourceGroups//providers/Microsoft.ApiManagement/service//loggers/?api-version=2020-12-01

注：替换<>中的内容为自己的相应资源信息，同时也定义loggers的名称。
这里的Endpoint为中国区Azure的Endpoint： https://management.chinacloudapi.cn/，如果需要Global Azure，则为：https://management.azure.com/
Authorization
两种方式任选其一：

Azure Active Directory OAuth2 Flow :https://www.cnblogs.com/lulight/p/14279338.html
似乎用浏览器打开Azure APIM的门户，通过F12--开发者选项中的 Network，查看其中对API的请求，复制其中的Authorization 值

文章图片

【【Azure|【Azure API 管理】在APIM 中添加 log-to-eventhub 策略，把 Request Body 信息全部记录在Event Hub中】

Body

{ "properties": { "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "name": "", "connectionString": "Endpoint=sb://.servicebus.chinacloudapi.cn/; SharedAccessKeyName=xxxxxxxxxxxxxxxxx; SharedAccessKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } } }

Response - 201 Created

{ "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx-rg/providers/Microsoft.ApiManagement/service/xxxx/loggers/loggerideh01", "type": "Microsoft.ApiManagement/service/loggers", "name": "loggerideh01", "properties": { "loggerType": "azureEventHub", "description": "adding a new logger", "credentials": { "name": "xxxxxxxxxxxx", "connectionString": "{{Logger-Credentials--xxxxxxxxxxxx}}" }, "isBuffered": true, "resourceId": null } }

演示动画

2) 添加 log-to-eventhub 策略

浏览到自己的 APIM 实例。
选择“API”选项卡。
选择要将策略添加到的 API。
选择“所有操作”。
选择屏幕顶部的“设计”选项卡。
在“入站或出站处理”窗口中，单击三角形（铅笔旁边）。
选择“代码编辑器”。有关详细信息，请参阅如何设置或编辑策略。
将光标放在 inbound 或 outbound 策略部分中。
在右侧窗口中，选择“高级策略” > “记录到 EventHub”。这会插入 log-to-eventhub 策略语句模板。

文章图片

注: Log-to-eventhub 中的logger-id由上面第一步创建。 Request Body的信息一定要进行格式转换。所以需要使用context.Request.Body.As()

@{ return new JObject( new JProperty("EventTime", DateTime.UtcNow.ToString()), new JProperty("ServiceName", context.Deployment.ServiceName), new JProperty("RequestId", context.RequestId), new JProperty("RequestBody1", context.Request.Body.As()), new JProperty("OperationName", context.Operation.Name) ).ToString(); } @{ return new JObject( new JProperty("EventTime", DateTime.UtcNow.ToString()), new JProperty("ServiceName", context.Deployment.ServiceName), new JProperty("RequestId", context.RequestId), new JProperty("RequestBody2", context.Response.Body.As()), new JProperty("OperationName", context.Operation.Name) ).ToString(); }

3) 连接到Event Hub，查看 Request Body 信息下载zip包，解压后在里面找到文件名为：ServiceBusExplorer.exe。双击即可运行

文章图片

在下面的字符串框中输入Event Hub Namespace的连接字符串。点击Save/ OK后，即可连接到Event Hub中。

文章图片

进入保存日志的Event Hub中，找到合适的分区数，点击“Create Partitions Listener ”, 然后再弹出的页面中点击 “Strat”按钮，就可以收到Event Hub中所存储的消息

文章图片

参考资料
如何在 Azure API 管理中将事件记录到 Azure 事件中心 : https://docs.azure.cn/zh-cn/api-management/api-management-howto-log-event-hubs#configure-log-to-eventhub-policies
Logger - Create Or Update ： https://docs.microsoft.com/zh-cn/rest/api/apimanagement/2020-12-01/logger/create-or-update#apimanagementcreateehlogger
创建 Azure 事件中心：https://docs.azure.cn/zh-cn/event-hubs/event-hubs-create
下载 Service Bus Explorer查看事件中心消息：https://github.com/paolosalvatori/ServiceBusExplorer/releases