You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/frontdoor/front-door-http-headers-protocol.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,60 +5,60 @@ services: frontdoor
5
5
author: duongau
6
6
ms.service: frontdoor
7
7
ms.topic: how-to
8
-
ms.date: 01/16/2023
8
+
ms.date: 03/27/2024
9
9
ms.author: duau
10
10
---
11
11
12
12
# Protocol support for HTTP headers in Azure Front Door
13
13
14
-
This article outlines the protocol that Front Door supports with parts of the call path (see image). In the following sections, you'll find information about HTTP headers supported by Front Door.
14
+
This article outlines the protocol that Front Door supports with parts of the call path (see image). In the following sections, you find information about HTTP headers supported by Front Door.
15
15
16
-
:::image type="content" source="./media/front-door-http-headers-protocol/front-door-protocol-summary.png" alt-text="Diagram showing client making request to Front Door, which is forwarded to the backend. The response is sent from Front Door to the client." border="false":::
16
+
:::image type="content" source="./media/front-door-http-headers-protocol/front-door-protocol-summary.png" alt-text="Diagram showing client making request to Azure Front Door, which is forwarded to the backend. The response is sent from Azure Front Door to the client." border="false":::
17
17
18
18
> [!IMPORTANT]
19
-
> Front Door doesn't certify any HTTP headers that aren't documented here.
19
+
> Azure Front Door doesn't certify any HTTP headers that aren't documented here.
20
20
21
-
## From client to the Front Door
21
+
## From client to Azure Front Door
22
22
23
-
Azure Front Door accepts most headers for the incoming request without modifying them. Some reserved headers are removed from the incoming request if sent, including headers with the X-FD-* prefix.
23
+
Azure Front Door accepts most headers for the incoming request without modifying them. Some reserved headers are removed from the incoming request if sent, including headers with the `X-FD-*` prefix.
24
24
25
-
The debug request header, "X-Azure-DebugInfo", provides extra debugging information about the Front Door. You'll need to send "X-Azure-DebugInfo: 1" request header from the client to the AzureFront Door to receive [optional response headers](#optional-debug-response-headers) when Front Door response to the client.
25
+
The debug request header, `X-Azure-DebugInfo`, provides extra debugging information about the Front Door. You need to send `X-Azure-DebugInfo: 1` request header from the client to the Azure Front Door to receive [optional response headers](#optional-debug-response-headers) when Azure Front Door response to the client.
26
26
27
-
## From the Front Door to the backend
27
+
## From Azure Front Door to the backend
28
28
29
-
Azure Front Door includes headers for an incoming request unless they're removed because of restrictions. Front Door also adds the following headers:
29
+
Azure Front Door includes headers for an incoming request unless they're removed because of restrictions. Azure Front Door also appends the following headers:
30
30
31
31
| Header | Example and description |
32
32
| ------------- | ------------- |
33
-
| Via |*Via: 1.1 Azure* </br> Front Door adds the client's HTTP version followed by *Azure* as the value for the Via header. This header indicates the client's HTTP version and that Front Door was an intermediate recipient for the request between the client and the backend. |
34
-
| X-Azure-ClientIP |*X-Azure-ClientIP: 127.0.0.1* </br> Represents the client IP address associated with the request being processed. For example, a request coming from a proxy might add the X-Forwarded-For header to indicate the IP address of the original caller. |
35
-
| X-Azure-SocketIP |*X-Azure-SocketIP: 127.0.0.1* </br> Represents the socket IP address associated with the TCP connection that the current request originated from. A request's client IP address might not be equal to its socket IP address because the client IP can be arbitrarily overwritten by a user.|
36
-
| X-Azure-Ref |*X-Azure-Ref: 0zxV+XAAAAABKMMOjBv2NT4TY6SQVjC0zV1NURURHRTA2MTkANDM3YzgyY2QtMzYwYS00YTU0LTk0YzMtNWZmNzA3NjQ3Nzgz* </br> A unique reference string that identifies a request served by Front Door. It's used to search access logs and critical for troubleshooting.|
37
-
| X-Azure-RequestChain |*X-Azure-RequestChain: hops=1* </br> A header that Front Door uses to detect request loops, and users shouldn't take a dependency on it. |
38
-
| X-Azure-FDID |*X-Azure-FDID: 55ce4ed1-4b06-4bf1-b40e-4638452104da* <br/> A reference string that identifies the request came from a specific Front Door resource. The value can be seen in the Azure portal or retrieved using the management API. You can use this header in combination with IP ACLs to lock down your endpoint to only accept requests from a specific Front Door resource. See the FAQ for [more detail](front-door-faq.yml#what-are-the-steps-to-restrict-the-access-to-my-backend-to-only-azure-front-door-)|
39
-
| X-Forwarded-For |*X-Forwarded-For: 127.0.0.1* </br> The X-Forwarded-For (XFF) HTTP header field often identifies the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer. If there's an existing XFF header, then Front Door appends the client socket IP to it or adds the XFF header with the client socket IP. |
40
-
| X-Forwarded-Host |*X-Forwarded-Host: contoso.azurefd.net* </br> The X-Forwarded-Host HTTP header field is a common method used to identify the original host requested by the client in the Host HTTP request header. This is because the host name from Front Door may differ for the backend server handling the request. Any previous value will be overridden by Front Door. |
41
-
| X-Forwarded-Proto |*X-Forwarded-Proto: http* </br> The X-Forwarded-Proto HTTP header field is often used to identify the originating protocol of an HTTP request. Front Door based on configuration might communicate with the backend by using HTTPS. This is true even if the request to the reverse proxy is HTTP. Any previous value will be overridden by Front Door. |
42
-
| X-FD-HealthProbe | X-FD-HealthProbe HTTP header field is used to identify the health probe from Front Door. If this header is set to 1, the request is from the health probe. It can be used to restrict access from Front Door with a particular value for the X-Forwarded-Host header field. |
33
+
| Via |`Via: 1.1 Azure` </br> Front Door adds the client's HTTP version followed by *Azure* as the value for the Via header. This header indicates the client's HTTP version and that Front Door was an intermediate recipient for the request between the client and the backend. |
34
+
| X-Azure-ClientIP |`X-Azure-ClientIP: 127.0.0.1` </br> Represents the client IP address associated with the request being processed. For example, a request coming from a proxy might add the X-Forwarded-For header to indicate the IP address of the original caller. |
35
+
| X-Azure-SocketIP |`X-Azure-SocketIP: 127.0.0.1` </br> Represents the socket IP address associated with the TCP connection that the current request originated from. A request's client IP address might not be equal to its socket IP address because the client IP can be arbitrarily overwritten by a user.|
36
+
| X-Azure-Ref |`X-Azure-Ref: 0zxV+XAAAAABKMMOjBv2NT4TY6SQVjC0zV1NURURHRTA2MTkANDM3YzgyY2QtMzYwYS00YTU0LTk0YzMtNWZmNzA3NjQ3Nzgz` </br> A unique reference string that identifies a request served by Azure Front Door. This string is used to search access logs and critical for troubleshooting.|
37
+
| X-Azure-RequestChain |`X-Azure-RequestChain: hops=1` </br> A header that Front Door uses to detect request loops, and users shouldn't take a dependency on it. |
38
+
| X-Azure-FDID |`X-Azure-FDID: 55ce4ed1-4b06-4bf1-b40e-4638452104da` <br/> A reference string that identifies the request came from a specific Front Door resource. The value can be seen in the Azure portal or retrieved using the management API. You can use this header in combination with IP ACLs to lock down your endpoint to only accept requests from a specific Front Door resource. See the FAQ for [more detail](front-door-faq.yml#what-are-the-steps-to-restrict-the-access-to-my-backend-to-only-azure-front-door-)|
39
+
| X-Forwarded-For |`X-Forwarded-For: 127.0.0.1` </br> The X-Forwarded-For (XFF) HTTP header field often identifies the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer. If there's an existing XFF header, then Front Door appends the client socket IP to it or adds the XFF header with the client socket IP. |
40
+
| X-Forwarded-Host |`X-Forwarded-Host: contoso.azurefd.net` </br> The X-Forwarded-Host HTTP header field is a common method used to identify the original host requested by the client in the Host HTTP request header. This is because the host name from Azure Front Door might differ for the backend server handling the request. Any previous value is overridden by Azure Front Door. |
41
+
| X-Forwarded-Proto |`X-Forwarded-Proto: http` </br> The `X-Forwarded-Proto` HTTP header field is often used to identify the originating protocol of an HTTP request. Front Door based on configuration might communicate with the backend by using HTTPS. This is true even if the request to the reverse proxy is HTTP. Any previous value will be overridden by Front Door. |
42
+
| X-FD-HealthProbe |`X-FD-HealthProbe` HTTP header field is used to identify the health probe from Front Door. If this header is set to 1, the request is from the health probe. It can be used to restrict access from Front Door with a particular value for the `X-Forwarded-Host` header field. |
43
43
44
44
## From the Front Door to the client
45
45
46
46
Any headers sent to Azure Front Door from the backend are also passed through to the client. Front Door also attaches the following headers to all responses to the client:
47
47
48
48
| Header | Example and description |
49
49
| ------------- | ------------- |
50
-
| X-Azure-Ref |*X-Azure-Ref: 0zxV+XAAAAABKMMOjBv2NT4TY6SQVjC0zV1NURURHRTA2MTkANDM3YzgyY2QtMzYwYS00YTU0LTk0YzMtNWZmNzA3NjQ3Nzgz* </br> This is a unique reference string that identifies a request served by Front Door, which is critical for troubleshooting as it's used to search access logs.|
51
-
| X-Cache |*X-Cache:* This header describes the caching status of the request. For more information, see [Caching with Azure Front Door](front-door-caching.md#response-headers). |
50
+
| X-Azure-Ref |`X-Azure-Ref: 0zxV+XAAAAABKMMOjBv2NT4TY6SQVjC0zV1NURURHRTA2MTkANDM3YzgyY2QtMzYwYS00YTU0LTk0YzMtNWZmNzA3NjQ3Nzgz` </br> This is a unique reference string that identifies a request served by Front Door, which is critical for troubleshooting as it's used to search access logs.|
51
+
| X-Cache |`X-Cache:` This header describes the caching status of the request. For more information, see [Caching with Azure Front Door](front-door-caching.md#response-headers). |
52
52
53
53
### Optional debug response headers
54
54
55
-
You need to send "X-Azure-DebugInfo: 1" request header to enable the following optional response headers.
55
+
You need to send `X-Azure-DebugInfo: 1` request header to enable the following optional response headers.
56
56
57
57
| Header | Example and description |
58
58
| ------------- | ------------- |
59
-
| X-Azure-OriginStatusCode |*X-Azure-OriginStatusCode: 503* </br> This header contains the HTTP status code returned by the backend. Using this header you can identify the HTTP status code returned by the application running in your backend without going through backend logs. This status code might be different from the HTTP status code in the response sent to the client by Front Door. This header allows you to determine if the backend is misbehaving or if the issue is with the Front Door service. |
60
-
| X-Azure-InternalError | This header will contain the error code that Front Door comes across when processing the request. This error indicates the issue is internal to the Front Door service/infrastructure. Report issue to support. |
61
-
| X-Azure-ExternalError |*X-Azure-ExternalError: 0x830c1011, The certificate authority is unfamiliar.* </br> This header shows the error code that Front Door servers come across while establishing connectivity to the backend server to process a request. This header will help identify issues in the connection between Front Door and the backend application. This header will include a detailed error message to help you identify connectivity issues to your backend (for example, DNS resolution, invalid cert, and so on.). |
59
+
| X-Azure-OriginStatusCode |`X-Azure-OriginStatusCode: 503` </br> This header contains the HTTP status code returned by the backend. Using this header you can identify the HTTP status code returned by the application running in your backend without going through backend logs. This status code might be different from the HTTP status code in the response sent to the client by Front Door. This header allows you to determine if the backend is misbehaving or if the issue is with the Front Door service. |
60
+
| X-Azure-InternalError | This header contains the error code that Azure Front Door comes across when processing the request. This error indicates the issue is internal to the Azure Front Door service/infrastructure. Report issue to support. |
61
+
| X-Azure-ExternalError |`X-Azure-ExternalError: 0x830c1011, The certificate authority is unfamiliar` </br> This header shows the error code that Front Door servers come across while establishing connectivity to the backend server to process a request. This header helps identify issues in the connection between Front Door and the backend application. This header includes a detailed error message to help you identify connectivity issues to your backend (for example, DNS resolution, invalid cert, and so on.). |
Copy file name to clipboardExpand all lines: articles/frontdoor/standard-premium/how-to-logs.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,35 @@
1
1
---
2
-
title: 'Logs - Azure Front Door'
2
+
title: Configure Azure Front Door logs
3
3
description: This article explains how to configure Azure Front Door logs.
4
4
services: front-door
5
5
author: duongau
6
6
ms.service: frontdoor
7
7
ms.topic: how-to
8
-
ms.date: 02/23/2023
8
+
ms.date: 03/27/2024
9
9
ms.author: duau
10
10
---
11
11
12
12
# Configure Azure Front Door logs
13
13
14
14
Azure Front Door captures several types of logs. Logs can help you monitor your application, track requests, and debug your Front Door configuration. For more information about Azure Front Door's logs, see [Monitor metrics and logs in Azure Front Door](../front-door-diagnostics.md).
15
15
16
-
Access logs, health probe logs, and WAF logs aren't enabled by default. In this article, you'll learn how to enable diagnostic logs for your Azure Front Door profile.
16
+
Access logs, health probe logs, and Web Application Firewall (WAF) logs aren't enabled by default. In this article, you learn how to enable diagnostic logs for your Azure Front Door profile.
17
17
18
18
## Configure logs
19
19
20
20
1. Sign in to the [Azure portal](https://portal.azure.com).
21
21
22
-
1. Search for Azure Front Door and select the Azure Front Door profile.
22
+
1. Search for **Azure Front Door** and then select the relevant Azure Front Door profile.
23
23
24
-
1.In the profile, go to **Monitoring**, select **Diagnostic Setting**. Select**Add diagnostic setting**.
24
+
1.Within the profile, navigate to **Monitoring**, select **Diagnostic Setting** and then choose**Add diagnostic setting**.
25
25
26
26
:::image type="content" source="../media/how-to-logging/front-door-logging-1.png" alt-text="Screenshot of diagnostic settings landing page.":::
27
27
28
28
1. Under **Diagnostic settings**, enter a name for **Diagnostic settings name**.
29
29
30
-
1. Select the **log**from**FrontDoorAccessLog**, **FrontDoorHealthProbeLog**, and **FrontDoorWebApplicationFirewallLog**.
30
+
1. Select the **log**options for**FrontDoorAccessLog**, **FrontDoorHealthProbeLog**, and **FrontDoorWebApplicationFirewallLog**.
31
31
32
-
1. Select the **Destination details**. Destination options are:
32
+
1. Select the **Destination details**. The destination options are:
33
33
34
34
***Send to Log Analytics**
35
35
* Azure Log Analytics in Azure Monitor is best used for general real-time monitoring and analysis of Azure Front Door performance.
@@ -42,17 +42,17 @@ Access logs, health probe logs, and WAF logs aren't enabled by default. In this
42
42
* Select the *Subscription, Event hub namespace, Event hub name (optional)*, and *Event hub policy name*.
43
43
44
44
> [!TIP]
45
-
> Most Azure customers use Log Analytics.
45
+
> Microsoft recommends using Log Analytics for real-time monitoring and analysis of Azure Front Door performance.
46
46
47
47
:::image type="content" source="../media/how-to-logging/front-door-logging-2.png" alt-text="Screenshot of diagnostic settings page.":::
0 commit comments