Skip to main content
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.
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:
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:
    config.yaml
    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.
    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:
    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.
    If you’re using the default socket path, omit the --socket PATH flag.

​
Windows

To query the CXDOT Collector’s debug interface on Windows, follow these steps.
  1. In your configuration file, configure a socket path:
    config.yaml
    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. For example, if the Collector runs on drive C:, the socket value /cxdot-debug/debug.sock resolves to C:\cxdot-debug\debug.sock.
  2. Use the following command to query that socket:
    Replace RESOURCE with 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:
values.yaml