---
title: "Debug Info"
slug: "debug-info-rule"
updated: 2025-05-21T10:09:54Z
published: 2025-05-21T10:09:54Z
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qwilt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Debug Info

## Overview
Use this feature to include helpful debugging information in the client response -- but only when it's explicitly requested.

When a client request includes the specified header (name and value), the server adds debug information to the response in the ```X-OC-Debug-Info``` header.



## Configure the Rule
Here, we'll describe how to configure the rule with the Delivery Service Management UI.

API Users may choose to [build the site configuration offline](https://api-docs.qwilt.cqloud.com/docs/CDN%20APIs/Sites%20API/prepare-the-configuration-json).

**To configure a Debug Info rule:**
1. [Navigate to the Select Rule dialog](/v1/docs/add-a-rule).
2. In the Select Rule dialog, choose **Debug Info**. 
3. Set the rule parameters:
    - **Request Header Name** - Enter the name of the HTTP header that the client request must include to trigger debugging.
    - **Request Header Value** - Enter the value the header must have to enable debugging.
    
    ![DebugInfoRule.png](https://cdn.document360.io/fa039225-513b-46a1-ba78-a57a1f1cb7c6/Images/Documentation/DebugInfoRule.png){height="" width=""}

    When the client request includes the specified header name and value, the CDN adds the ```X-OC-Debug-Info``` header to the response. The header contains debugging data such as internal identifiers and transaction details. 

5. Choose **Add Rule**.

## Example Response
```json
< x-oc-debug-info: {
  "listenSock": "127.0.0.1:8080",
  "trxId": "1000000000047b22-1234567-1",
  "sig": "abc123fakeSig",
  "serviceType": "LIVE",
  "disk": "1",
  "cacheStatus": "MISS",
  "cacheKey": "59a6c1bb29e77bd1a34b027fd1234567",
  "cacheKeyStr": "stream1/fakevideo.isml/dash/3-5-video=450000.dash&filter=none&t=0&vbegin=0",
  "cacheExpiry": "0",
  "proxyType": "ORIGIN",
  "proxyDest": "origin.example.com",
  "proxyAddr": "203.0.113.42:80",
  "proxyStatus": "404",
  "rr": "kProxyResponse4xx",
  "prr": "kNginxCacheMiss",
  "cpFailure": "kStatus4xx"
}
```
## SVTA Component: QW.DebugHeaderRule
When you save the configuration version, the *QW.DebugHeaderRule* SVTA component is added to the configuration JSON. This is a [private feature developed by Qwilt](https://api-docs.qwilt.cqloud.com/docs/CDN%20APIs/Sites%20API/Site%20Configuration%20JSON%20Format/prepare-the-configuration-json#qwilt-private-features). 

The configuration object specifies the header and value as match conditions. In this example, debugging information is included when the client requests includes the ```X-Qwilt-Debug``` header with the value ```true```. The response will include an ```X-OC-Debug-Info``` header with additional data.

```json
{
  "generic-metadata-type": "MI.PrivateFeature.Qwilt.QW.DebugHeaderRule",
  "generic-metadata-value": {
    "request-header-name": "X-Qwilt-Debug",
    "request-header-value": "true"
  }
}
```