Skip to content

Commit 08974a8

Browse files
authored
Merge pull request #290547 from Alej-b23/refstring
Refstring
2 parents b70a22a + e9d1c91 commit 08974a8

File tree

1 file changed

+7
-41
lines changed

1 file changed

+7
-41
lines changed

articles/frontdoor/refstring.md

Lines changed: 7 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Troubleshoot Azure Front Door with RefString
3-
description: This article provides information about what a RefString is and how to gather them.
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.
44
author: Alej-b23
55
ms.author: pagonzalez
66
ms.service: azure-frontdoor
@@ -10,7 +10,7 @@ ms.date: 09/06/2024
1010
#CustomerIntent: As a web developer, I want troubleshoot my web application using a RefString.
1111
---
1212

13-
# Troubleshoot Azure Front Door with RefString
13+
# Troubleshooting 4xx and 5xx errors using RefString
1414

1515
A guide to understand and use RefStrings for diagnosing and resolving issues with Azure Front Door.
1616

@@ -20,7 +20,7 @@ A guide to understand and use RefStrings for diagnosing and resolving issues wit
2020

2121
## What is a RefString?
2222

23-
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.
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.
2424

2525
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.
2626

@@ -29,7 +29,7 @@ RefStrings can help you troubleshoot and resolve issues with Azure Front Door, s
2929
3030
## How to gather a RefString
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 are a few examples of how to obtain a RefString from various browsers and applications:
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:
3333

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

@@ -49,24 +49,6 @@ Example of how to obtain a RefString 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

52-
#### [Google Chrome](#tab/chrome)
53-
54-
For Google Chrome browsers, see [Inspect network activity - Google Chrome Developer documentation](https://developer.chrome.com/docs/devtools/network).
55-
56-
#### [cURL](#tab/curl)
57-
58-
To obtain headers with cURL, use the **-I** or **—include** option to include the HTTP response headers in the output. Look for the **X-Azure-Ref** header in the output, and copy the value of the header.
59-
60-
#### [Fiddler](#tab/fiddler)
61-
62-
1. Launch Fiddler and start capturing HTTP traffic. Refresh the page or perform the action that generates the request.
63-
64-
1. Choose the request from the list and navigate to the Inspectors tab.
65-
66-
1. Switch to the Raw view, locate the **X-Azure-Ref** header in the response headers, copy its value, and decode it using a Base64 decoder.
67-
68-
To learn more about viewing and capturing network traffic with Fiddler, see [Web Debugging - Capture Network Traffic](https://www.telerik.com/fiddler/usecases/web-debugging).
69-
7052
---
7153

7254
## How to use a RefString with some of our troubleshooting tools
@@ -101,25 +83,9 @@ Azure Front Door uses a RefString to manage 4xx and 5xx errors. The following ar
10183
10284
### Alternative option
10385

104-
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. 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).
105-
106-
This article highlights specific fields in access logs that help identify various types of errors:
107-
108-
* **Cache misses:** RefString indicate whether a request was served from the cache and provide reasons if it wasn't.
109-
110-
Example: **NOCACHE** means the request wasn't eligible for caching, **MISS** means no valid cache entry existed, and **STALE** means the cache entry was expired.
111-
112-
* **Routing errors:** RefString can reveal if a request was routed correctly to the backend and the reason.
113-
114-
Example: **FALLBACK** means rerouted due to primary backend issues, and **OVERRIDE** means sent to an alternative backend against routing rules.
115-
116-
* **Backend failures:** RefString indicate if delivery to the backend succeeded and explain any issues.
117-
118-
Example: **TIMEOUT** means the response took too long, **CONNFAIL** means connection failed, and **ERROR** indicates an error response from the backend.
119-
120-
* **Latency problems:** RefString detail Azure Front Door's processing time and stage durations.
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.
12187

122-
Example: **DURATION** shows total handling time, **RTT** shows round-trip time, and **TTFB** shows the time taken to receive the first byte from the backend.
88+
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.
12389

12490
## Next steps
12591

0 commit comments

Comments
 (0)