Skip to content

Commit 7f24aae

Browse files
authored
Merge pull request #291402 from Alej-b23/refstring
Refstring
2 parents 2755f90 + a904d80 commit 7f24aae

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

articles/frontdoor/refstring.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,36 @@
11
---
2-
title: Troubleshooting 4xx and 5xx errors 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.
4+
45
author: Alej-b23
56
ms.author: pagonzalez
67
ms.service: azure-frontdoor
78
ms.topic: concept-article
8-
ms.date: 09/06/2024
9+
ms.date: 12/03/2024
910

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

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

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

1718
## Prerequisites
1819

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

21-
## What is a RefString?
22+
## What is a Reference String?
2223

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.
24+
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.
2425

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.
26+
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.
2627

2728
> [!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.
29+
> 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.
2930
30-
## How to gather a RefString
31+
## How to gather a Reference String
3132

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:
33+
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:
3334

3435
#### [Microsoft Edge Browser](#tab/edge)
3536

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

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

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

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

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

5051
:::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":::
5152

5253
---
5354

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:
55+
## How to use a Reference String with some of our troubleshooting tools
56+
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:
5657

5758
1. Navigate to your Azure Front Door Profile.
5859

5960
1. Select the **Diagnose and solve problems** menu.
6061

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":::
62+
:::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":::
6263

6364
1. Scroll down and select **Connectivity** under the **Common problems** section.
6465

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":::
66+
:::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":::
6667

6768
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**.
6869

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":::
70+
:::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":::
7071

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.
72+
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.
7273

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":::
74+
:::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":::
7475

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

7778
An example of a result displaying an issue:
7879

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":::
80+
:::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":::
8081

8182
> [!NOTE]
8283
> 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.
8384
8485
### Alternative option
8586

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.
87+
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.
8788

8889
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.
8990

0 commit comments

Comments
 (0)