Skip to content

Commit c6465eb

Browse files
committed
added to the Service Bus content set
1 parent c9befe9 commit c6465eb

File tree

3 files changed

+43
-17
lines changed

3 files changed

+43
-17
lines changed

articles/event-hubs/event-hubs-messaging-exceptions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,26 +100,26 @@ ExceptionId: 00000000000-00000-0000-a48a-9c908fbe84f6-ServerBusyException: The r
100100
```
101101

102102
## Connectivity, certificate, or timeout issues
103-
The following steps may help you with troubleshooting connectivity/certificate/timeout issues to all services under *.servicebus.windows.net.
103+
The following steps may help you with troubleshooting connectivity/certificate/timeout issues for all services under *.servicebus.windows.net.
104104

105105
- Browse to or [wget](https://www.gnu.org/software/wget/) `https://sbwagn2.servicebus.windows.net/`. It helps with checking whether you have IP filtering or virtual network or certificate chain issues (most common when using java SDK).
106106
- Run the following command to check if any port is blocked on the firewall. Depending on the library you use, other ports are also used. For example: 443, 5672, 9354.
107107

108-
```shell
109-
tnc sbwagn2.servicebus.windows.net -port 5671 (Powershell)
108+
```powershell
109+
tnc sbwagn2.servicebus.windows.net -port 5671
110110
```
111111
112112
On Linux:
113113
114114
```shell
115-
telnet sbwagn2.servicebus.windows.net 5671 (linux)
115+
telnet sbwagn2.servicebus.windows.net 5671
116116
```
117-
- When there are intermittent connectivity issues, run the following command to check if there's any packets dropped. Keep it running for approximately 1 minute to know if the connections are partially blocked. You can download the `psping` tool from [here](/sysinternals/downloads/psping).
117+
- When there are intermittent connectivity issues, run the following command to check if there are any dropped packets. Keep it running for approximately 1 minute to know if the connections are partially blocked. You can download the `psping` tool from [here](/sysinternals/downloads/psping).
118118
119119
```shell
120120
psping.exe -t -q ehedhdev.servicebus.windows.net:9354 -nobanner
121121
```
122-
You can use equivalent commands if you're using other tools `tnc`, `ping`, and so on.
122+
You can use equivalent commands if you're using other tools such as `tnc`, `ping`, and so on.
123123
- Obtain a network trace if the previous steps don't help and analyze it or contact [Microsoft Support](https://support.microsoft.com/).
124124
125125
## Next steps

articles/service-bus-messaging/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@
205205
href: service-bus-resource-manager-namespace-topic-with-rule.md
206206
- name: Troubleshoot
207207
items:
208-
- name: Exceptions
208+
- name: Troubleshooting guide
209209
href: service-bus-messaging-exceptions.md
210210
- name: Reference
211211
items:

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

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Azure Service Bus messaging exceptions | Microsoft Docs
2+
title: Troubleshooting guide for Azure Service Bus | Microsoft Docs
33
description: List of Service Bus messaging exceptions and suggested actions.
44
services: service-bus-messaging
55
documentationcenter: na
@@ -17,18 +17,22 @@ ms.date: 09/21/2018
1717
ms.author: aschhab
1818

1919
---
20-
# Service Bus messaging exceptions
21-
This article lists some exceptions generated by the Microsoft Azure Service Bus messaging APIs. This reference is subject to change, so check back for updates.
2220

23-
## Exception categories
21+
# Troubleshooting guide for Azure Service Bus
22+
This article provides some of the .NET exceptions generated by Service Bus .NET Framework APIs and also other tips for troubleshooting issues.
23+
24+
## Service Bus messaging exceptions
25+
This section lists the .NET exceptions generated by .NET Framework APIs.
26+
27+
### Exception categories
2428
The messaging APIs generate exceptions that can fall into the following categories, along with the associated action you can take to try to fix them. The meaning and causes of an exception can vary depending on the type of messaging entity:
2529

2630
1. User coding error ([System.ArgumentException](https://msdn.microsoft.com/library/system.argumentexception.aspx), [System.InvalidOperationException](https://msdn.microsoft.com/library/system.invalidoperationexception.aspx), [System.OperationCanceledException](https://msdn.microsoft.com/library/system.operationcanceledexception.aspx), [System.Runtime.Serialization.SerializationException](https://msdn.microsoft.com/library/system.runtime.serialization.serializationexception.aspx)). General action: try to fix the code before proceeding.
2731
2. Setup/configuration error ([Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException](/dotnet/api/microsoft.azure.servicebus.messagingentitynotfoundexception), [System.UnauthorizedAccessException](https://msdn.microsoft.com/library/system.unauthorizedaccessexception.aspx). General action: review your configuration and change if necessary.
2832
3. Transient exceptions ([Microsoft.ServiceBus.Messaging.MessagingException](/dotnet/api/microsoft.servicebus.messaging.messagingexception), [Microsoft.ServiceBus.Messaging.ServerBusyException](/dotnet/api/microsoft.azure.servicebus.serverbusyexception), [Microsoft.ServiceBus.Messaging.MessagingCommunicationException](/dotnet/api/microsoft.servicebus.messaging.messagingcommunicationexception)). General action: retry the operation or notify users. Note that the `RetryPolicy` class in the client SDK can be configured to handle retries automatically. See [Retry guidance](/azure/architecture/best-practices/retry-service-specific#service-bus) for more information.
2933
4. Other exceptions ([System.Transactions.TransactionException](https://msdn.microsoft.com/library/system.transactions.transactionexception.aspx), [System.TimeoutException](https://msdn.microsoft.com/library/system.timeoutexception.aspx), [Microsoft.ServiceBus.Messaging.MessageLockLostException](/dotnet/api/microsoft.azure.servicebus.messagelocklostexception), [Microsoft.ServiceBus.Messaging.SessionLockLostException](/dotnet/api/microsoft.azure.servicebus.sessionlocklostexception)). General action: specific to the exception type; please refer to the table in the following section:
3034

31-
## Exception types
35+
### Exception types
3236
The following table lists messaging exception types, and their causes, and notes suggested action you can take.
3337

3438
| **Exception Type** | **Description/Cause/Examples** | **Suggested Action** | **Note on automatic/immediate retry** |
@@ -57,10 +61,10 @@ The following table lists messaging exception types, and their causes, and notes
5761
| [TransactionException](https://msdn.microsoft.com/library/system.transactions.transactionexception.aspx) |The ambient transaction (*Transaction.Current*) is invalid. It may have been completed or aborted. Inner exception may provide additional information. | |Retry does not help. |
5862
| [TransactionInDoubtException](https://msdn.microsoft.com/library/system.transactions.transactionindoubtexception.aspx) |An operation is attempted on a transaction that is in doubt, or an attempt is made to commit the transaction and the transaction becomes in doubt. |Your application must handle this exception (as a special case), as the transaction may have already been committed. |- |
5963

60-
## QuotaExceededException
64+
### QuotaExceededException
6165
[QuotaExceededException](/dotnet/api/microsoft.azure.servicebus.quotaexceededexception) indicates that a quota for a specific entity has been exceeded.
6266

63-
### Queues and topics
67+
#### Queues and topics
6468
For queues and topics, this is often the size of the queue. The error message property contains further details, as in the following example:
6569

6670
```Output
@@ -72,7 +76,7 @@ Message: The maximum entity size has been reached or exceeded for Topic: ‘xxx-
7276

7377
The message states that the topic exceeded its size limit, in this case 1 GB (the default size limit).
7478

75-
### Namespaces
79+
#### Namespaces
7680

7781
For namespaces, [QuotaExceededException](/dotnet/api/microsoft.azure.servicebus.quotaexceededexception) can indicate that an application has exceeded the maximum number of connections to a namespace. For example:
7882

@@ -92,14 +96,36 @@ There are two common causes for this error: the dead-letter queue, and non-funct
9296
To resolve the issue, read and complete the messages from the dead-letter queue, as you would from any other queue. You can use the [FormatDeadLetterPath](/dotnet/api/microsoft.azure.servicebus.entitynamehelper.formatdeadletterpath) method to help format the dead-letter queue path.
9397
2. **Receiver stopped**. A receiver has stopped receiving messages from a queue or subscription. The way to identify this is to look at the [QueueDescription.MessageCountDetails](/dotnet/api/microsoft.servicebus.messaging.messagecountdetails) property, which shows the full breakdown of the messages. If the [ActiveMessageCount](/dotnet/api/microsoft.servicebus.messaging.messagecountdetails.activemessagecount) property is high or growing, then the messages are not being read as fast as they are being written.
9498

95-
## TimeoutException
99+
### TimeoutException
96100
A [TimeoutException](https://msdn.microsoft.com/library/system.timeoutexception.aspx) indicates that a user-initiated operation is taking longer than the operation timeout.
97101

98102
You should check the value of the [ServicePointManager.DefaultConnectionLimit](https://msdn.microsoft.com/library/system.net.servicepointmanager.defaultconnectionlimit) property, as hitting this limit can also cause a [TimeoutException](https://msdn.microsoft.com/library/system.timeoutexception.aspx).
99103

100-
### Queues and topics
104+
#### Queues and topics
101105
For queues and topics, the timeout is specified either in the [MessagingFactorySettings.OperationTimeout](/dotnet/api/microsoft.servicebus.messaging.messagingfactorysettings) property, as part of the connection string, or through [ServiceBusConnectionStringBuilder](/dotnet/api/microsoft.azure.servicebus.servicebusconnectionstringbuilder). The error message itself might vary, but it always contains the timeout value specified for the current operation.
102106

107+
## Connectivity, certificate, or timeout issues
108+
The following steps may help you with troubleshooting connectivity/certificate/timeout issues for all services under *.servicebus.windows.net.
109+
110+
- Browse to or [wget](https://www.gnu.org/software/wget/) `https://sbwagn2.servicebus.windows.net/`. It helps with checking whether you have IP filtering or virtual network or certificate chain issues (most common when using java SDK).
111+
- Run the following command to check if any port is blocked on the firewall. Depending on the library you use, other ports are also used. For example: 443, 5672, 9354.
112+
113+
```powershell
114+
tnc sbwagn2.servicebus.windows.net -port 5671
115+
```
116+
117+
On Linux:
118+
119+
```shell
120+
telnet sbwagn2.servicebus.windows.net 5671
121+
```
122+
- When there are intermittent connectivity issues, run the following command to check if there are any dropped packets. Keep it running for approximately 1 minute to know if the connections are partially blocked. You can download the `psping` tool from [here](/sysinternals/downloads/psping).
123+
124+
```shell
125+
psping.exe -t -q ehedhdev.servicebus.windows.net:9354 -nobanner
126+
```
127+
You can use equivalent commands if you're using other tools such as `tnc`, `ping`, and so on.
128+
- Obtain a network trace if the previous steps don't help and analyze it or contact [Microsoft Support](https://support.microsoft.com/).
103129
104130
105131
## Next steps

0 commit comments

Comments
 (0)