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

# Debug the CXDOT Collector

> Query the CXDOT Collector debug interface for configuration and health details.

The CXDOT Collector exposes a debug interface that provides diagnostic information,
including the CXDOT Collector's current configuration settings, component health, and
runtime statistics. This debug interface is separate from runtime logs produced by
the Collector.

The CXDOT Collector's debug interface is enabled by default. The installation
process for the Collector also installs the `cxdot-admin` command-line tool,
which you can use to query the debug interface.

> [!WARNING]
>
> Debug responses redact the values of known secrets, but these responses can
> still expose endpoints, component names, and other deployment details.

## Query the debug interface

The steps to query the debug interface vary based on the environment where the
CXDOT Collector is deployed.

### Kubernetes

Each of the CXDOT Collector's Pods exposes its own debug interface. To query the
debug interface for a Pod, use the following command:

```shell theme={null}
kubectl exec --namespace cxdot POD -- \
  /bin/cxdot-admin debug get RESOURCE
```

Replace these values:

* *`POD`*: The name of the Pod whose debug interface you want to query.
* *`RESOURCE`*: The diagnostic resource you want to retrieve (for example,
  `health/component_status.json`). If you omit this value, the command returns a
  list of the available diagnostic resources.

### Linux

To query the CXDOT Collector's debug interface on Linux, follow these steps.

1. In your configuration file, configure a socket path:

   ```yaml title="config.yaml" theme={null}
   cxdot:
     debug:
       socket_path: PATH
   ```

   Replace *`PATH`* with the complete path where the CXDOT Collector should create the
   socket. This must be a Unix-style absolute path that begins with `/`. The
   nearest existing parent directory must be writable by the Collector process.

   > [!NOTE]
   >
   > If the CXDOT Collector runs as the root user, it can write to the default
   > socket path at `/var/run/cxdot-collector/debug.sock`.

2. Use the following command to query that socket:

   ```shell theme={null}
   cxdot-admin debug get RESOURCE --socket PATH
   ```

   Replace these values:

   * *`RESOURCE`*: The diagnostic resource you want to retrieve (for example,
     `health/component_status.json`). If you omit this value, the command returns
     a list of the available diagnostic resources.
   * *`PATH`*: The socket path that you configured in the previous step.

   > [!NOTE]
   >
   > If you're using the default socket path, omit the `--socket PATH` flag.

### Windows

> Debug paths that begin with a drive letter require CXDOT Collector v1.16 or later.

To query the CXDOT Collector's debug interface on Windows, follow these steps.

1. In your configuration file, configure a socket path:

   ```yaml title="config.yaml" theme={null}
   cxdot:
     debug:
       socket_path: PATH
   ```

   Replace *`PATH`* with the complete path where the CXDOT Collector should
   create the socket.

   This path can either be a Windows-style path that begins with a drive letter
   (for example, `C:\`) or a Unix-style path that begins with `/`. If you specify
   a Unix-style path, the Collector resolves it as a Windows-style absolute path on
   the same drive where the Collector is running. For example, if you specify the path
   `/cxdot-debug/debug.sock`, and the Collector is running on the `C` drive, this
   path resolves to `C:\cxdot-debug\debug.sock`.

2. Use the following command to query that socket:

   ```shell theme={null}
   .\cxdot-admin.exe debug get --socket "PATH" RESOURCE
   ```

   Replace the following values:

   * *`PATH`*: The socket path that you configured in the previous step.
   * *`RESOURCE`*: The diagnostic resource you want to retrieve (for
     example, `health/component_status.json`). If you omit this value, the command
     returns a list of the available diagnostic resources.

## Disable debugging

The debug interface is enabled by default. To disable it, set `debug.enabled` to
`false` in your configuration file:

> [tab] Helm values file
>
> ```yaml title="values.yaml" theme={null}
> config:
>   debug:
>     enabled: false
> ```

> [tab] Configuration file
>
> ```yaml title="config.yaml" theme={null}
> cxdot:
>   debug:
>     enabled: false
> ```


## Related topics

- [Set the CXDOT Collector schema version](https://docs-xcor.paloaltonetworks.com/ingest/xcor/collector/configure/schema-version.md)
- [CXDOT Collector](https://docs-xcor.paloaltonetworks.com/ingest/xcor/collector.md)
- [CXDOT Collector integrations](https://docs-xcor.paloaltonetworks.com/ingest/xcor/integrations/collector.md)
- [Install the CXDOT Collector on Windows](https://docs-xcor.paloaltonetworks.com/ingest/xcor/collector/install/windows.md)
- [Install the CXDOT Collector on Linux](https://docs-xcor.paloaltonetworks.com/ingest/xcor/collector/install/linux.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.