Skip to content

Commit e821de8

Browse files
authored
improve scorecard
1 parent 8aa1b3b commit e821de8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

articles/azure-web-pubsub/howto-troubleshoot-common-issues.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.devlang: csharp
1111

1212
# Troubleshooting guide for common issues
1313

14-
This article provides troubleshooting guidance for some of the common issues that customers might encounter. Listed errors are available to check by turn on `LiveTrace` tool or collect from diagnostics following [Capture resource logs](https://learn.microsoft.com/azure/azure-web-pubsub/howto-troubleshoot-resource-logs).
14+
This article provides troubleshooting guidance for some of the common issues that customers might encounter. Listed errors are available to check when you turn on `LiveTrace` tool or collect from diagnostics following [Capture resource logs](https://learn.microsoft.com/azure/azure-web-pubsub/howto-troubleshoot-resource-logs).
1515

1616
## 404 from HttpHandlerUnexpectedResponse
1717

@@ -25,8 +25,8 @@ This error indicates the event is registered in Web PubSub settings but fail to
2525

2626
### Troubleshooting guide
2727

28-
- Check your upstream server function or method whether it is good to work.
29-
- Check whether this event is intended to register. If not, simply remove it from the hub settings in Web PubSub side.
28+
- Check your upstream server function or method whether it's good to work.
29+
- Check whether this event is intended to register. If not, remove it from the hub settings in Web PubSub side.
3030

3131
## 500 from HttpHandlerUnexpectedResponse
3232

@@ -45,7 +45,7 @@ This error indicates event request get a `500` response from registered upstream
4545

4646
## AbuseProtectionResponseMissingAllowedOrigin
4747

48-
Web PubSub follows the [CloudEvents Abuse Protection](https://github.com/cloudevents/spec/blob/v1.0/http-webhook.md#4-abuse-protection) to validate the upstream webhook. Every registered upstream webhook URL will be validated by this mechanism. The `WebHook-Request-Origin` request header is set to the service domain name `<web-pubsub-name>.webpubsub.azure.com`, and it expects the response to have a header `WebHook-Allowed-Origin` to contain this domain name or `*`.
48+
Web PubSub follows the [CloudEvents Abuse Protection](https://github.com/cloudevents/spec/blob/v1.0/http-webhook.md#4-abuse-protection) to validate the upstream webhook. Every registered upstream webhook URL will be validated. The `WebHook-Request-Origin` request header is set to the service domain name `<web-pubsub-name>.webpubsub.azure.com`, and it expects the response to have a header `WebHook-Allowed-Origin` to contain this domain name or `*`.
4949

5050
### Possible errors
5151

@@ -55,9 +55,9 @@ Web PubSub follows the [CloudEvents Abuse Protection](https://github.com/cloudev
5555

5656
Review the upstream side code to ensure when upstream receives the `OPTIONS` preflight request from Web PubSub service, it's correctly handled following the rule that contains the expected header `WebHook-Allowed-Origin` and value.
5757

58-
Besides, you can update to convenience server SDK which automatically handles `Abuse Protection` for you.
58+
Besides, you can update to convenience server SDK, which automatically handles `Abuse Protection` for you.
5959

60-
- [@web-pubsub-express for JaveScript ](https://www.npmjs.com/package/@azure/web-pubsub-express)
60+
- [@web-pubsub-express for Javascript ](https://www.npmjs.com/package/@azure/web-pubsub-express)
6161
- [Microsoft.Azure.WebPubSub.AspNetCore for C#](https://www.nuget.org/packages/Microsoft.Azure.WebPubSub.AspNetCore)
6262

6363
## 401 Unauthorized from AbuseProtectionResponseInvalidStatusCode
@@ -68,7 +68,7 @@ Besides, you can update to convenience server SDK which automatically handles `A
6868

6969
### Root cause
7070

71-
This error indicates the `Abuse Protection` request get a `401` response from the registered upstream URL. See [`Abuse Protection`](https://learn.microsoft.com/azure/azure-web-pubsub/howto-develop-eventhandler#upstream-and-validation) for more details.
71+
This error indicates the `Abuse Protection` request get a `401` response from the registered upstream URL. For me information, see [`Abuse Protection`](https://learn.microsoft.com/azure/azure-web-pubsub/howto-develop-eventhandler#upstream-and-validation).
7272

7373
### Troubleshooting guide
7474

@@ -79,12 +79,12 @@ This error indicates the `Abuse Protection` request get a `401` response from th
7979

8080
When the client is connected to Azure Web PubSub, the persistent connection between the client and Azure Web PubSUb can sometimes drop for different reasons. This section describes several possibilities causing such connection drop and provides some guidance on how to identify the root cause.
8181

82-
You can check the metric `Connection Close Count` from Azure Portal.
82+
You can check the metric `Connection Close Count` from Azure portal.
8383

8484
### Possible reasons and root cause
8585

8686
| Reason | Root cause |
87-
| -- | -- |
87+
|--|--|
8888
| Normal | Close by clients |
8989
| ClosedByAppServer | Close by server triggered Rest API call like [`CloseConnection`](https://learn.microsoft.com/rest/api/webpubsub/dataplane/web-pub-sub/close-connection?tabs=HTTP) |
9090
| ServiceReload | Close by service due to regular maintenance or backend auto scales |
@@ -101,5 +101,5 @@ Web PubSub different tiers have a hard limit on concurrent connection. This erro
101101

102102
### Solution
103103

104-
Scale up to a paid tier(Standard or Premium) to have at least 1000 connections or scale out to more units that supports more connections.
104+
Scale up to a paid tier(Standard or Premium) to have at least 1000 connections or scale out to more units that support more connections.
105105

0 commit comments

Comments
 (0)