Merge pull request #265274 from Saglodha/saglodha-diagnosticerrorlogs

Adding Content for upcoming feature - Diagnostic User Error Logs

Author: prmerger-automator[bot]

articles/event-hubs/monitor-event-hubs-reference.md

@@ -179,6 +179,63 @@ Name | Description
 `OffsetCommit` | Number of offset commit calls made to the event hub 
 `OffsetFetch` | Number of offset fetch calls made to the event hub.
 
+## Diagnostic Error Logs
+Diagnostic error logs capture error messages for any client side, throttling and Quota exceeded errors. They provide detailed diagnostics for error identification.
+
+Diagnostic Error Logs include elements listed in below table:
+
+Name | Description | Supported in Azure Diagnostics | Supported in AZMSDiagnosticErrorLogs (Resource specific table)
+---|---|---|---|
+`ActivityId` | A randomly generated UUID that ensures uniqueness for the audit activity. | Yes | Yes
+`ActivityName` | Operation name  | Yes | Yes
+`NamespaceName` | Name of Namespace | Yes | yes
+`EntityType` | Type of Entity | Yes | Yes 
+`EntityName` | Name of Entity | Yes | Yes  
+`OperationResult` | Type of error in Operation (Clienterror or Serverbusy or quotaexceeded) | Yes | Yes
+`ErrorCount` | Count of identical errors during the aggregation period of 1 minute. | Yes | Yes 
+`ErrorMessage` | Detailed Error Message | Yes | Yes 
+`ResourceProvider` | Name of Service emitting the logs. Possible values: Microsoft.Eventhub and Microsoft.Servicebus | Yes | Yes 
+`Time Generated (UTC)` | Operation time | No | Yes
+`EventTimestamp` | Operation Time | Yes | No
+`Category` | Log category | Yes | No
+`Type`  | Type of Logs emitted | No | Yes
+
+Here's an example of Diagnostic error log entry:
+
+```json
+{
+    "ActivityId": "0000000000-0000-0000-0000-00000000000000",
+    "SubscriptionId": "<Azure Subscription Id",
+    "NamespaceName": "Name of Event Hubs Namespace",
+    "EntityType": "EventHub",
+    "EntityName": "Name of Event Hub",
+    "ActivityName": "SendMessage",
+    "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event hub namespace name>",,
+    "OperationResult": "ServerBusy",
+    "ErrorCount": 1,
+    "EventTimestamp": "3/27/2024 1:02:29.126 PM +00:00",
+    "ErrorMessage": "the request was terminated because the entity is being throttled by the application group with application group name <application group name> and policy name <throttling policy name>.error code: 50013.",
+    "category": "DiagnosticErrorLogs"
+ }
+
+```
+Resource specific table entry:
+```json
+{
+    "ActivityId": "0000000000-0000-0000-0000-00000000000000",
+    "NamespaceName": "Name of Event Hubs Namespace",
+    "EntityType": "Event Hub",
+    "EntityName": "Name of Event Hub",
+    "ActivityName": "SendMessage",
+    "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event hub namespace name>",,
+    "OperationResult": "ServerBusy",
+    "ErrorCount": 1,
+    "TimeGenerated [UTC]": "1/27/2024 4:02:29.126 PM +00:00",
+    "ErrorMessage": "The request was terminated because the entity is being throttled by the application group with application group name <application group name> and policy name <throttling policy name>.error code: 50013.",
+    "Type": "AZMSDiagnosticErrorLogs"
+ }
+
+```
 
 ## Azure Monitor Logs tables
 Azure Event Hubs uses Kusto tables from Azure Monitor Logs. You can query these tables with Log Analytics. For a list of Kusto tables the service uses, see [Azure Monitor Logs table reference](/azure/azure-monitor/reference/tables/tables-resourcetype#event-hubs).

articles/event-hubs/monitor-event-hubs.md

@@ -74,13 +74,11 @@ For metrics that support dimensions, you can apply filters using a dimension val
 :::image type="content" source="./media/monitor-event-hubs/metrics-filter-split.png" alt-text="Screenshot showing the Metrics Explorer for an Event Hubs namespace with a filter." lightbox="./media/monitor-event-hubs/metrics-filter-split.png":::
 
 ## Analyze logs
-Using Azure Monitor Log Analytics requires you to create a diagnostic configuration and enable __Send information to Log Analytics__. For more information, see the [Collection and routing](#collection-and-routing) section. Data in Azure Monitor Logs is stored in tables, with each table having its own set of unique properties. Azure Event Hubs stores data in the following tables: **AzureDiagnostics** and **AzureMetrics**.
+Using Azure Monitor Log Analytics requires you to create a diagnostic configuration and enable __Send information to Log Analytics__. For more information, see the [Collection and routing](#collection-and-routing) section. Data in Azure Monitor Logs is stored in tables, with each table having its own set of unique properties. Azure Event Hubs has the capability to dispatch logs to either of two destination tables - Azure Diagnostic or Resource specific tables in Log Analytics.For a detailed reference of the logs and metrics, see [Azure Event Hubs monitoring data reference](monitor-event-hubs-reference.md).
 
 > [!IMPORTANT]
 > When you select **Logs** from the Azure Event Hubs menu, Log Analytics is opened with the query scope set to the current workspace. This means that log queries will only include data from that resource. If you want to run a query that includes data from other databases or data from other Azure services, select **Logs** from the **Azure Monitor** menu. See [Log query scope and time range in Azure Monitor Log Analytics](../azure-monitor/logs/scope.md) for details.
 
-For a detailed reference of the logs and metrics, see [Azure Event Hubs monitoring data reference](monitor-event-hubs-reference.md).
-
 ### Sample Kusto queries
 
 > [!IMPORTANT]

articles/service-bus-messaging/monitor-service-bus-reference.md

@@ -298,6 +298,64 @@ Resource specific table entry:
 
 ```
 
+## Diagnostic Error Logs
+Diagnostic error logs capture error messages for any client side, throttling and Quota exceeded errors. They provide detailed diagnostics for error identification.
+
+Diagnostic Error Logs include elements listed in below table:
+
+Name | Description | Supported in Azure Diagnostics | Supported in AZMSDiagnosticErrorLogs (Resource specific table)
+---|---|---|---|
+`ActivityId` | A randomly generated UUID that ensures uniqueness for the audit activity. | Yes | Yes
+`ActivityName` | Operation name  | Yes | Yes
+`NamespaceName` | Name of Namespace | Yes | yes
+`EntityType` | Type of Entity | Yes | Yes 
+`EntityName` | Name of Entity | Yes | Yes  
+`OperationResult` | Type of error in Operation (Clienterror or Serverbusy or quotaexceeded) | Yes | Yes
+`ErrorCount` | Count of identical errors during the aggregation period of 1 minute. | Yes | Yes 
+`ErrorMessage` | Detailed Error Message | Yes | Yes 
+`Provider` | Name of Service emitting the logs. Possible values: eventhub, relay, and servicebus | Yes | Yes 
+`Time Generated (UTC)` | Operation time | No | Yes
+`EventTimestamp` | Operation Time | Yes | No
+`Category` | Log category | Yes | No
+`Type`  | Type of Logs emitted | No | Yes
+
+Here's an example of Diagnostic error log entry:
+
+```json
+{
+    "ActivityId": "0000000000-0000-0000-0000-00000000000000",
+    "SubscriptionId": "<Azure Subscription Id",
+    "NamespaceName": "Name of Service Bus Namespace",
+    "EntityType": "Queue",
+    "EntityName": "Name of Service Bus Queue",
+    "ActivityName": "SendMessage",
+    "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<service bus namespace name>",,
+    "OperationResult": "ClientError",
+    "ErrorCount": 1,
+    "EventTimestamp": "3/27/2024 1:02:29.126 PM +00:00",
+    "ErrorMessage": "the sessionid was not set on a message, and it cannot be sent to the entity. entities that have session support enabled can only receive messages that have the sessionid set to a valid value.",
+    "category": "DiagnosticErrorLogs"
+ }
+
+```
+Resource specific table entry:
+```json
+{
+    "ActivityId": "0000000000-0000-0000-0000-00000000000000",
+    "NamespaceName": "Name of Service Bus Namespace",
+    "EntityType": "Queue",
+    "EntityName": "Name of Service Bus Queue",
+    "ActivityName": "SendMessage",
+    "ResourceId": "/SUBSCRIPTIONS/xxx/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.SERVICEBUS/NAMESPACES/<service bus namespace name>",,
+    "OperationResult": "ClientError",
+    "ErrorCount": 1,
+    "TimeGenerated [UTC]": "1/27/2024 4:02:29.126 PM +00:00",
+    "ErrorMessage": "the sessionid was not set on a message, and it cannot be sent to the entity. entities that have session support enabled can only receive messages that have the sessionid set to a valid value.",
+    "Type": "AZMSDiagnosticErrorLogs"
+ }
+
+```
+
 [!INCLUDE [service-bus-amqp-support-retirement](../../includes/service-bus-amqp-support-retirement.md)]
 
 ## Azure Monitor Logs tables

articles/service-bus-messaging/monitor-service-bus.md

@@ -109,18 +109,12 @@ For reference, you can see a list of [all resource metrics supported in Azure Mo
 For metrics that support dimensions, you can apply filters using a dimension value. For example, add a filter with `EntityName` set to the name of a queue or a topic. You can also split a metric by dimension to visualize how different segments of the metric compare with each other. For more information of filtering and splitting, see [Advanced features of Azure Monitor](../azure-monitor/essentials/metrics-charts.md).
 
 ## Analyzing logs
-Using Azure Monitor Log Analytics requires you to create a diagnostic configuration and enable __Send information to Log Analytics__. For more information, see the [Collection and routing](#collection-and-routing) section. Data in Azure Monitor Logs is stored in tables, with each table having its own set of unique properties. Azure Service Bus stores data in the following tables: **AzureDiagnostics** and **AzureMetrics**.
+Using Azure Monitor Log Analytics requires you to create a diagnostic configuration and enable __Send information to Log Analytics__. For more information, see the [Collection and routing](#collection-and-routing) section. Data in Azure Monitor Logs is stored in tables, with each table having its own set of unique properties.Azure Service Bus has the capability to dispatch logs to either of two destination tables - Azure Diagnostic or Resource specific tables in Log Analytics. For a detailed reference of the logs and metrics, see [Azure Service Bus monitoring data reference](monitor-service-bus-reference.md).
 
 > [!IMPORTANT]
 > When you select **Logs** from the Azure Service Bus menu, Log Analytics is opened with the query scope set to the current workspace. This means that log queries will only include data from that resource. If you want to run a query that includes data from other databases or data from other Azure services, select **Logs** from the **Azure Monitor** menu. See [Log query scope and time range in Azure Monitor Log Analytics](../azure-monitor/logs/scope.md) for details.
 
-
-For a detailed reference of the logs and metrics, see [Azure Service Bus monitoring data reference](monitor-service-bus-reference.md).
-
-### Sample Kusto queries
-
-> [!IMPORTANT]
-> When you select **Logs** from the Azure Service Bus menu, Log Analytics is opened with the query scope set to the current Azure Service Bus namespace. This means that log queries will only include data from that resource. If you want to run a query that includes data from other workspaces or data from other Azure services, select **Logs** from the **Azure Monitor** menu. See [Log query scope and time range in Azure Monitor Log Analytics](../azure-monitor/logs/scope.md) for details.
+### Additional Kusto queries
 
 Following are sample queries that you can use to help you monitor your Azure Service Bus resources: