Skip to content

Commit 7706acd

Browse files
authored
Merge pull request #98239 from itechedit/service-bus-diagnostic-logs
edit pass: service-bus-diagnostic-logs
2 parents f3f0fcf + 9b28133 commit 7706acd

File tree

1 file changed

+35
-33
lines changed

1 file changed

+35
-33
lines changed
Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Azure Service Bus diagnostic logs | Microsoft Docs
3-
description: Learn how to set up diagnostic logs for Service Bus in Azure.
2+
title: Azure Service Bus diagnostics logs | Microsoft Docs
3+
description: Learn how to set up diagnostics logs for Service Bus in Azure.
44
keywords:
55
documentationcenter: .net
66
services: service-bus-messaging
@@ -18,20 +18,20 @@ ms.date: 01/23/2019
1818
ms.author: aschhab
1919

2020
---
21-
# Enable diagnostic logs for Service Bus
21+
# Enable diagnostics logs for Service Bus
2222

23-
When you start using your Azure Service Bus namespace, you may want to monitor how and when your namespace is created, deleted or accessed. This article provides an overview of all the operational/diagnostic logs that are available.
23+
When you start using your Azure Service Bus namespace, you might want to monitor how and when your namespace is created, deleted, or accessed. This article provides an overview of all the operational and diagnostics logs that are available.
2424

25-
Azure Service Bus currently supports activity/operational logs which capture **management operations** performed on the Azure Service Bus namespace. Specifically, these logs capture the operation type, including queue creation, resources used, and the status of the operation.
25+
Azure Service Bus currently supports activity and operational logs, which capture *management operations* that are performed on the Azure Service Bus namespace. Specifically, these logs capture the operation type, including queue creation, resources used, and the status of the operation.
2626

2727
## Operational logs schema
2828

29-
All logs are stored in JavaScript Object Notation (JSON) format in the below 2 locations.
29+
All logs are stored in JavaScript Object Notation (JSON) format in the following two locations:
3030

31-
- **AzureActivity** - displays logs from operations/actions conducted against your namespace on the portal or through Azure Resource Manager template deployments.
32-
- **AzureDiagnostics** - displays logs from operations/actions conducted against your namespace using the API, or through management clients on the language SDK.
31+
- **AzureActivity**: Displays logs from operations and actions that are conducted against your namespace in the Azure portal or through Azure Resource Manager template deployments.
32+
- **AzureDiagnostics**: Displays logs from operations and actions that are conducted against your namespace by using the API, or through management clients on the language SDK.
3333

34-
Operational log JSON strings include elements listed in the following table:
34+
Operational log JSON strings include the elements listed in the following table:
3535

3636
| Name | Description |
3737
| ------- | ------- |
@@ -42,7 +42,7 @@ Operational log JSON strings include elements listed in the following table:
4242
| EventTimeString | Operation time |
4343
| EventProperties | Operation properties |
4444
| Status | Operation status |
45-
| Caller | Caller of operation (Azure portal or management client) |
45+
| Caller | Caller of operation (the Azure portal or management client) |
4646
| Category | OperationalLogs |
4747

4848
Here's an example of an operational log JSON string:
@@ -61,14 +61,14 @@ Here's an example of an operational log JSON string:
6161
}
6262
```
6363

64-
## What events/operations are captured in operational logs?
64+
## Events and operations captured in operational logs
6565

66-
Operation logs capture all management operations performed on the Azure Service Bus namespace. Data operations are not captured because of the high volume of data operations that are conducted on Azure Service Bus.
66+
Operational logs capture all management operations that are performed on the Azure Service Bus namespace. Data operations are not captured, because of the high volume of data operations that are conducted on Azure Service Bus.
6767

6868
> [!NOTE]
69-
> To better track data operations, we recommend using client side tracing.
69+
> To help you better track data operations, we recommend using client-side tracing.
7070
71-
The below management operations are captured in operational logs -
71+
The following management operations are captured in operational logs:
7272

7373
| Scope | Operation|
7474
|-------| -------- |
@@ -78,40 +78,42 @@ The below management operations are captured in operational logs -
7878
| Subscription | <ul> <li> Create Subscription </li> <li> Update Subscription </li> <li> Delete Subscription </li> </ul> |
7979

8080
> [!NOTE]
81-
> Currently, **Read** operations are not tracked in the operational logs.
81+
> Currently, *Read* operations are not tracked in the operational logs.
8282
83-
## How to enable operational logs?
83+
## Enable operational logs
8484

85-
Operational logs are disabled by default. To enable diagnostic logs, perform the following steps:
85+
Operational logs are disabled by default. To enable diagnostics logs, do the following:
8686

87-
1. In the [Azure portal](https://portal.azure.com), navigate to your Azure Service Bus namespace and under **Monitoring**, click **Diagnostics settings**.
87+
1. In the [Azure portal](https://portal.azure.com), go to your Azure Service Bus namespace and then, under **Monitoring**, select **Diagnostic settings**.
8888

89-
![blade navigation to diagnostic logs](./media/service-bus-diagnostic-logs/image1.png)
89+
![The "Diagnostic settings" link](./media/service-bus-diagnostic-logs/image1.png)
9090

91-
2. Click **Add diagnostic setting** to configure the diagnostic settings.
91+
1. In the **Diagnostics settings** pane, select **Add diagnostic setting**.
9292

93-
![turn on diagnostic logs](./media/service-bus-diagnostic-logs/image2.png)
93+
![The "Add diagnostic setting" link](./media/service-bus-diagnostic-logs/image2.png)
9494

95-
3. Configure the diagnostic settings
96-
1. Type a **name** to identify the diagnostic settings.
97-
2. Pick a destination for the diagnostics.
98-
- If you pick **Storage account**, you need to configure the storage account where the diagnostics will be stored.
99-
- If you pick **Event hubs**, you need to configure the appropriate Event Hub where the diagnostics settings will be streamed to.
100-
- If you pick **Log Analytics**, you need to specify which instance of Log Analytics the diagnostics will be sent.
101-
3. Check **OperationalLogs**.
95+
1. Configure the diagnostics settings by doing the following:
10296

103-
![change status diagnostic logs](./media/service-bus-diagnostic-logs/image3.png)
97+
a. In the **Name** box, enter a name for the diagnostics settings.
10498

105-
4. Click **Save**.
99+
b. Select one of the following three destinations for your diagnostics logs:
100+
- If you select **Archive to a storage account**, you need to configure the storage account where the diagnostics logs will be stored.
101+
- If you select **Stream to an event hub**, you need to configure the event hub that you want to stream the diagnostics logs to.
102+
- If you select **Send to Log Analytics**, you need to specify which instance of Log Analytics the diagnostics will be sent to.
106103

104+
c. Select the **OperationalLogs** check box.
107105

108-
New settings take effect in about 10 minutes. After that, logs appear in the configured archival target, on the **Diagnostics logs** blade.
106+
![The "Diagnostics settings" pane](./media/service-bus-diagnostic-logs/image3.png)
109107

110-
For more information about configuring diagnostics, see the [overview of Azure diagnostic logs](../azure-monitor/platform/diagnostic-logs-overview.md).
108+
1. Select **Save**.
109+
110+
The new settings take effect in about 10 minutes. The logs are displayed in the configured archival target, in the **Diagnostics logs** pane.
111+
112+
For more information about configuring diagnostics settings, see the [overview of Azure diagnostics logs](../azure-monitor/platform/diagnostic-logs-overview.md).
111113

112114
## Next steps
113115

114-
See the following links to learn more about Service Bus:
116+
To learn more about Service Bus, see:
115117

116118
* [Introduction to Service Bus](service-bus-messaging-overview.md)
117119
* [Get started with Service Bus](service-bus-dotnet-get-started-with-queues.md)

0 commit comments

Comments
 (0)