Skip to content

Commit bb6b961

Browse files
author
Pablo Gonzalez
committed
fixed RefString abbreviations and alternative errors section
1 parent e9d1c91 commit bb6b961

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

articles/frontdoor/refstring.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
---
2-
title: Troubleshooting 4xx and 5xx erorrs using RefString
3-
description: This article provides information about what a RefString is, how to collect them, and use the Azure portal diagnostic tool for troubleshooting 4xx and 5xx errors.
2+
title: Troubleshooting 4xx and 5xx erorrs using Reference String
3+
description: This article provides information about what a Reference String is, how to collect them, and use the Azure portal diagnostic tool for troubleshooting 4xx and 5xx errors.
44
author: Alej-b23
55
ms.author: pagonzalez
66
ms.service: azure-frontdoor
77
ms.topic: concept-article
88
ms.date: 09/06/2024
99

10-
#CustomerIntent: As a web developer, I want troubleshoot my web application using a RefString.
10+
#CustomerIntent: As a web developer, I want troubleshoot my web application using a Reference String.
1111
---
1212

13-
# Troubleshooting 4xx and 5xx errors using RefString
13+
# Troubleshooting 4xx and 5xx errors using Reference String
1414

15-
A guide to understand and use RefStrings for diagnosing and resolving issues with Azure Front Door.
15+
A guide to understand and use Reference Strings for diagnosing and resolving issues with Azure Front Door.
1616

1717
## Prerequisites
1818

1919
* You must have an Azure Front Door profile. To create a profile, see [Creating an Azure Front Door profile](create-front-door-portal.md).
2020

21-
## What is a RefString?
21+
## What is a Reference String?
2222

23-
A RefString, also known as a Reference string, is a short string appended by Azure Front Door to the HTTP response headers of each request. It provides details on how the request was processed, including the point of presence (POP) and backend status.
23+
A Reference String, also known as a RefString, is a short string appended by Azure Front Door to the HTTP response headers of each request. It provides details on how the request was processed, including the point of presence (POP) and backend status.
2424

25-
RefStrings can help you troubleshoot and resolve issues with Azure Front Door, such as cache misses, routing errors, backend failures, and latency problems. You can identify the root cause and take appropriate actions to fix it by analyzing the RefStrings of the requests.
25+
Reference Strings can help you troubleshoot and resolve issues with Azure Front Door, such as cache misses, backend failures, and latency problems. You can identify the root cause and take appropriate actions to fix it by analyzing the Reference String of the requests.
2626

2727
> [!NOTE]
28-
> If you encounter an error page from Microsoft services, it will already include a RefString for the request that generated the error page. In such cases, you can skip directly to the diagnostic step.
28+
> If you encounter an error page from Microsoft services, it will already include a Reference String for the request that generated the error page. In such cases, you can skip directly to the diagnostic step.
2929
30-
## How to gather a RefString
30+
## How to gather a Reference String
3131

32-
To gather a RefString, you need to capture the HTTP response headers of the requests and look for the header named **X-Azure-Ref**. This header contains the RefString, encoded in Base64. You can use different methods to capture the HTTP response headers, depending on your preference and situation. Here is an example of how to obtain a RefString from the Microsoft Edge Browser:
32+
To gather a Reference String, you need to capture the HTTP response headers of the requests and look for the header named **X-Azure-Ref**. This header contains the Reference String, encoded in Base64. You can use different methods to capture the HTTP response headers, depending on your preference and situation. Here is an example of how to obtain a Reference String from the Microsoft Edge Browser:
3333

3434
#### [Microsoft Edge Browser](#tab/edge)
3535

@@ -41,49 +41,49 @@ To gather a RefString, you need to capture the HTTP response headers of the requ
4141

4242
1. Locate the specific request in the list and find the **X-Azure-Ref** header in the response headers section.
4343

44-
1. Copy the value of the **X-Azure-Ref** header to use with the RefString troubleshooting tool in the Azure portal.
44+
1. Copy the value of the **X-Azure-Ref** header to use with the Reference String troubleshooting tool in the Azure portal.
4545

4646
For more information, see [Inspect network activity - Microsoft Edge Developer documentation](/microsoft-edge/devtools-guide-chromium/network/).
4747

48-
Example of how to obtain a RefString from Microsoft Edge Browser:
48+
Example of how to obtain a Reference String from Microsoft Edge Browser:
4949

5050
:::image type="content" source="media/refstring/refstring-edge-browser-step.png" alt-text="Screenshot of RefString example in Microsoft Edge Browser." lightbox="media/refstring/refstring-edge-browser-step-expanded.png":::
5151

5252
---
5353

54-
## How to use a RefString with some of our troubleshooting tools
55-
Azure Front Door uses a RefString to manage 4xx and 5xx errors. The following are the steps to use the diagnostic tool with a RefString for tracking and diagnosing connectivity issues:
54+
## How to use a Reference String with some of our troubleshooting tools
55+
Azure Front Door uses a Reference String to manage 4xx and 5xx errors. The following are the steps to use the diagnostic tool with a Reference String for tracking and diagnosing connectivity issues:
5656

5757
1. Navigate to your Azure Front Door Profile.
5858

5959
1. Select the **Diagnose and solve problems** menu.
6060

61-
:::image type="content" source="media/refstring/refstring-step-one-portal.png" alt-text="Screenshot showing the first step in diagnosing problems using a RefString." lightbox="media/refstring/refstring-step-one-portal.png":::
61+
:::image type="content" source="media/refstring/refstring-step-one-portal.png" alt-text="Screenshot showing the first step in diagnosing problems using a Reference String." lightbox="media/refstring/refstring-step-one-portal.png":::
6262

6363
1. Scroll down and select **Connectivity** under the **Common problems** section.
6464

65-
:::image type="content" source="media/refstring/refstring-step-two-portal.png" alt-text="Screenshot showing the second step in diagnosing problems using a RefString." lightbox="media/refstring/refstring-step-two-portal.png":::
65+
:::image type="content" source="media/refstring/refstring-step-two-portal.png" alt-text="Screenshot showing the second step in diagnosing problems using a Reference String." lightbox="media/refstring/refstring-step-two-portal.png":::
6666

6767
1. In the box **What issue are you having?** select **Select a problem subtype** and choose **4xx and 5xx errors** on the drop down-menu, then select the **Next**.
6868

69-
:::image type="content" source="./media/refstring/refstring-step-three-portal.png" alt-text="Screenshot showing the third step in diagnosing problems using a RefString." lightbox="media/refstring/refstring-step-three-portal.png":::
69+
:::image type="content" source="./media/refstring/refstring-step-three-portal.png" alt-text="Screenshot showing the third step in diagnosing problems using a Reference String." lightbox="media/refstring/refstring-step-three-portal.png":::
7070

71-
1. Enter your RefString in the box within the **4xx and 5xx errors** section. You input the Restring given to you from your request under the **Tracking Reference – RefString** field.
71+
1. Enter your Reference String in the box within the **4xx and 5xx errors** section. You input the Reference String given to you from your request under the **Tracking Reference – RefString** field.
7272

73-
:::image type="content" source="media/refstring/refstring-step-four-portal.png" alt-text="Screenshot showing the fourth step in diagnosing problems using a RefString." lightbox="media/refstring/refstring-step-four-portal.png":::
73+
:::image type="content" source="media/refstring/refstring-step-four-portal.png" alt-text="Screenshot showing the fourth step in diagnosing problems using a Reference String." lightbox="media/refstring/refstring-step-four-portal.png":::
7474

7575
1. Finally, select **Run Diagnostics** to identify the cause of the issue, which explains the failure if it's a known problem.
7676

7777
An example of a result displaying an issue:
7878

79-
:::image type="content" source="media/refstring/refstring-example.png" alt-text="Screenshot showing an example of the diagnosis at work using a RefString." lightbox="media/refstring/refstring-example.png":::
79+
:::image type="content" source="media/refstring/refstring-example.png" alt-text="Screenshot showing an example of the diagnosis at work using a Reference String." lightbox="media/refstring/refstring-example.png":::
8080

8181
> [!NOTE]
8282
> The diagnostic capabilities may require up to 15 minutes to deliver results. We ask for your patience that you allow the process to finish before taking further action.
8383
8484
### Alternative option
8585

86-
If you choose not to use the diagnostic tool, you can include a RefString when submitting a support ticket. Additionally, you can enable the **Access Logs** feature to receive updates on RefString data directly in the Azure portal.
86+
If you choose not to use the diagnostic tool, you can include a Reference String when submitting a support ticket. Additionally, you can enable the **Access Logs** feature to receive updates on RefString data directly in the Azure portal.
8787

8888
For more information on tracking references and access log parameters, see [Monitor metrics and logs in Azure Front Door](front-door-diagnostics.md#access-log), which highlights specific fields in access logs that help identify various types of errors.
8989

0 commit comments

Comments
 (0)