Skip to content

Commit 79f3885

Browse files
committed
updated based on feedback from Bryan
1 parent dd1789c commit 79f3885

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

articles/service-bus-relay/diagnostic-logs.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Azure Relay - diagnostics logs | Microsoft Docs
2+
title: Diagnostics logs for Hybrid Connections
33
description: This article provides an overview of all the operational and diagnostics logs that are available for Azure Relay.
44
services: service-bus-messaging
55
author: spelluru
@@ -14,21 +14,23 @@ ms.date: 04/27/2020
1414
ms.author: spelluru
1515

1616
---
17-
# Enable diagnostics logs for Azure Relay
18-
When you start using your Azure Relay 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.
17+
# Enable diagnostics logs for Azure Relay Hybrid Connections
18+
When you start using your Azure Relay Hybrid Connections, you might want to monitor how and when your listeners and senders are opened and closed, and how your Hybrid Connections messages are created and sent. This article provides an overview of all the operational and diagnostics logs that are available.
1919

2020
You can view two types of logs for Azure Relay:
2121

2222
- [Activity logs](../azure-monitor/platform/platform-logs-overview.md): These logs have information about operations performed against your namespace in the Azure portal or through Azure Resource Manager template. These logs are always enabled. For example: "Create or update namespace", "Create or update hybrid connection".
23-
- [Diagnostic logs](../azure-monitor/platform/platform-logs-overview.md): You can configure diagnostic logs for a richer view of everything that happens with operations and actions that are conducted against your namespace by using the API, or through management clients on the language SDK.
23+
- [Diagnostic logs](../azure-monitor/platform/platform-logs-overview.md): You can configure diagnostic logs for a richer view of everything that happens with operations and actions that are conducted against your namespace by using the API, or through language SDK.
2424

2525
## View activity logs
2626
To view activity logs for your Azure Relay namespace, switch to the **Activity log** page in the Azure portal.
2727

2828
![Azure Relay - activity log](./media/diagnostic-logs/activity-log.png)
2929

3030
## Enable diagnostic logs
31-
Only one category: Hybrid Connections
31+
32+
> [!NOTE]
33+
> Diagnostic logs are available only for hybrid connections, not for Windows Communication Foundation (WCF() relays.
3234
3335
To enable diagnostics logs, do the following steps:
3436

@@ -39,7 +41,7 @@ To enable diagnostics logs, do the following steps:
3941

4042
1. Configure the diagnostics settings by doing the following steps:
4143
1. In the **Name** box, enter a name for the diagnostics settings.
42-
2. Select **HybridConnectionsEvent** for the type of log. It's the only type supported.
44+
2. Select **HybridConnectionsEvent** for the type of log.
4345
3. Select one of the following three **destinations** for your diagnostics logs:
4446
1. If you select **Archive to a storage account**, configure the storage account where the diagnostics logs will be stored.
4547
2. If you select **Stream to an event hub**, configure the event hub that you want to stream the diagnostics logs to.
@@ -59,10 +61,10 @@ Hybrid connections event log JSON strings include the elements listed in the fol
5961
| ResourceId | Azure Resource Manager resource ID |
6062
| ActivityId | Internal ID, used to identify the specified operation. May also be known as "TrackingId" |
6163
| Endpoint | The address of the Relay resource |
62-
| OperationName | The type of the HybridConnection operation that’s  being logged |
64+
| OperationName | The type of the Hybrid Connections operation that’s  being logged |
6365
| EventTimeString | The UTC timestamp of the log record |
6466
| Message | The detailed message of the event |
65-
| Category | Category of the event. Currently, it's only `HybridConnectionsEvents`.
67+
| Category | Category of the event. Currently, there is only `HybridConnectionsEvents`.
6668

6769

6870
## Sample hybrid connections event
@@ -72,7 +74,7 @@ Here's a sample hybrid connections event in JSON format.
7274
{
7375
"resourceId": "/SUBSCRIPTIONS/0000000000-0000-0000-0000-0000000000000/RESOURCEGROUPS/MyResourceGroup/PROVIDERS/MICROSOFT.RELAY/NAMESPACES/MyRelayNamespace",
7476
"ActivityId": "7006a0db-27eb-445c-939b-ce86133014cc",
75-
"endpoint": "sb://myrelayns.servicebus.windows.net/mhybridconnection/7006a0db-27eb-445c-939b-ce86133014cc_G5",
77+
"endpoint": "sb://myrelaynamespace.servicebus.windows.net/myhybridconnection/7006a0db-27eb-445c-939b-ce86133014cc_G5",
7678
"operationName": "Microsoft.Relay/HybridConnections/NewSenderRegistering",
7779
"EventTimeString": "2020-04-27T20:27:57.3842810Z",
7880
"message": "A new on-premises sender is registering.",
@@ -86,25 +88,25 @@ Here's a sample hybrid connections event in JSON format.
8688
| --------- | ----------- |
8789
| AuthorizationFailed | Authorization failed.|
8890
| InvalidSasToken | Invalid SAS token. |
89-
| ListenerAcceptingConnection | The listener is accepting connection. |
90-
| ListenerAcceptingConnectionTimeout | The listener accepting connection timed out. |
91-
| ListenerAcceptingHttpRequestFailed | The listener accepting HTTP request failed. |
92-
| ListenerAcceptingRequestTimeout | The listener accepting request timed out. |  
93-
| ListenerClosingFromExpiredToken | The listener is closing because of an expired token. | 
94-
| ListenerRejectedConnection | The listener rejected connection. |
95-
| ListenerReturningHttpResponse | The listener returning an HTTP response. |  
96-
| ListenerReturningHttpResponseFailed | The listener returning an HTTP response failed. |
97-
ListenerSentHttpResponse | The listener sent an HTTP response. |
91+
| ListenerAcceptingConnection | The on-prem listener is accepting connection. |
92+
| ListenerAcceptingConnectionTimeout | The on-prem listener accepting connection has timed out. |
93+
| ListenerAcceptingHttpRequestFailed | The listener accepting HTTP request failed due to an exception. |
94+
| ListenerAcceptingRequestTimeout | The listener accepting request has timed out. |  
95+
| ListenerClosingFromExpiredToken | The listener is closing because the security token has expired. | 
96+
| ListenerRejectedConnection | The on-prem listener has rejected the connection. |
97+
| ListenerReturningHttpResponse | The on-prem listener is returning an HTTP response. |  
98+
| ListenerReturningHttpResponseFailed | The listener is returning an HTTP response with a failure code. |
99+
ListenerSentHttpResponse | Relay service has received an HTTP response from the on-prem listener. |
98100
| ListenerUnregistered | The listener is unregistered. |
99-
| ListenerUnresponsive | The listener is unresponsive. |
101+
| ListenerUnresponsive | The on-prem listener is unresponsive when returning a response. |
100102
| MessageSendingToOnPremListener | Message is being sent to on-premises listener. |
101103
| MessageSentToOnPremListener | Message is sent to on-premises listener. |
102104
| NewListenerRegistered | New listener registered. |
103-
| NewSenderRegistering | New listener registering. |
104-
| ProcessingRequestFailed | The processing request failed. |
105+
| NewSenderRegistering | New on-prem sender is registering. |
106+
| ProcessingRequestFailed | The processing of a Hybrid Connection operation has failed. |
105107
| SenderConnectionClosed | The sender connection is closed. |
106-
| SenderListenerConnectionEstablished | The sender and listener established connection. |
107-
| SenderSentHttpRequest | The sender sent HTTP request. |
108+
| SenderListenerConnectionEstablished | The sender and listener established connection successfully. |
109+
| SenderSentHttpRequest | The sender sent an HTTP request. |
108110

109111

110112
## Next steps

0 commit comments

Comments
 (0)