
DOCA Debug
OfficialFreeStreamline your DOCA debugging process with structured guidance.
Free · Opens the source repo
What DOCA Debug does
The DOCA Debug skill is designed for developers working with NVIDIA's DOCA framework who encounter various debugging challenges. This skill provides a structured approach to identifying and resolving symptoms related to builds, links, runtime errors, and more. It acts as a reference point for users to navigate through the layered debugging process, ensuring that they can pinpoint the source of their issues effectively.
When a user experiences a problem such as a build failure or an undefined reference to a DOCA symbol, this skill guides them through a canonical layered ladder. This ladder categorizes the debugging process into distinct layers: install, version, build, link, runtime, and program. By following this structure, users can systematically determine which layer is causing the issue and take appropriate action. For example, if a user encounters an error during linking, they can quickly identify it as a link layer issue and refer to the relevant documentation.
In addition to guiding users through the debugging layers, the skill also helps with verbosity controls. Developers often need to increase logging levels to gather more information about silent tools or services. This skill outlines how to adjust log levels for various DOCA libraries and tools, providing users with the necessary commands and workflows to enhance their debugging experience. Furthermore, it offers guidance on capturing state for forum questions or bug reports, ensuring that users can provide reproducible context when seeking help.
However, this skill is not intended for library-specific debugging or environmental issues. It does not cover error code explanations or problems related to package configurations. Instead, it serves as a cross-cutting resource that directs users to the appropriate skills or documentation for more specialized debugging tasks.
When to use it
Use this skill when encountering DOCA build failures, runtime errors, or when needing to increase logging verbosity for troubleshooting.
When not to use it
This skill is not suitable for library-specific debugging or environmental configuration issues; those should be handled by other dedicated skills.
What you can build with it
Identifying Build Failures
When a developer encounters a build failure with an undefined reference, they can use this skill to trace the issue back to the linking layer.
Increasing Verbosity for Silent Tools
A user experiencing silent output from a DOCA tool can follow the skill's guidance to adjust logging settings for better insights.
Preparing for Forum Questions
When needing to report an issue on the Developer Forum, users can utilize the skill to gather the necessary context and state information.
How to install DOCA Debug
View source1. Install with the skills CLI
npx skills add nvidia/skills/doca-debug --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by nvidiaDOCA debug
Where to start: This skill is the canonical layered-ladder
reference both doca-setup ## debug
and doca-programming-guide ## debug
escalate to. If the symptom does not fit cleanly in env-class or
program-class, start at TASKS.md ## debug — the
full layered ladder lives there.
Example questions this skill answers well
The CLASSES of debug questions this skill is built to answer, each with one worked example.
- "My DOCA build / link / runtime / program failed — which layer is
it?" — worked example: "
ldsaysundefined reference to doca_flow_init— which layer?" Answered by the canonical layered ladder inTASKS.md ## debug(layer 4 = Link). - "How do I turn up verbosity for any DOCA library or tool?" —
worked example: "My DOCA Flow program is silent — where do I get
more log output?" Answered by the trace-flavor / log-level surface
in
CAPABILITIES.md ## Observability- the run-with-verbosity workflow in
TASKS.md ## run.
- the run-with-verbosity workflow in
- "How do I capture state for a forum question or bug report?" —
worked example: "I'd like to file a forum question with reproducible
context — what should I include?" Answered by the
capture-a-reproducible-state workflow in
TASKS.md ## test. - "What does this DOCA tool's output mean / which tool answers
this?" — worked example: "
doca_capsreturned nothing for RDMA — does that mean unsupported?" Answered by the tool-vs-capability decision tree inCAPABILITIES.md ## Capabilities and modes- cross-link to doca-caps.
- "I'm debugging inside the NGC container — what's
observable?" — worked example: "
hugepagesis empty inside the container; is that a real problem or a container thing?" Answered by the container-specific debug constraints inCAPABILITIES.md ## Safety policyTASKS.md ## debuglayer 5 (Runtime).
- "Where do I ask for help with this?" — worked example: "Where
is the customer-facing DOCA forum and what should the post
contain?" Answered by the Developer-Forum routing rule in
TASKS.md ## debugplus doca-public-knowledge-map.
If the symptom is purely env-class, route to
doca-setup ## debug; if purely
program-class, route to
doca-programming-guide ## debug.
This skill is the cross-cutting layer both call into.
When to load this skill
Load this skill when the user is debugging anything DOCA-related — a build that won't compile, a link step that can't resolve a doca_* symbol, a runtime call that returns DOCA_ERROR_*, a packet that does not appear on the wire, a service that won't start, or a tool that returns no useful output. Concretely:
- The user reports a symptom and needs to find the layer that caused it (install / version / build / link / runtime / program).
- The user asks "how do I get more logs?" or "how do I turn up the verbosity?" for any DOCA library or tool.
- The user wants to capture state for a forum question or an internal bug report (the bundle does not own the internal-bug-report channel; it routes to the public DOCA Developer Forum).
- The user is reading a stack trace, a
valgrindoutput, or a core dump from a DOCA program and wants to know where to look first. - The user is debugging inside the NGC DOCA container and needs to know what is and is not observable from inside it.
Do not load this skill for:
- "What is
DOCA_ERROR_BAD_STATE?", "what error codes does DOCA return?" — that is the cross-library error taxonomy, owned bydoca-programming-guide CAPABILITIES.md ## Error taxonomy. This skill consumes that taxonomy; it does not redefine it. - "My
pkg-configcannot finddoca-flow", "hugepages are not mounted", "my representor isn't visible" — those are env-class symptoms, owned bydoca-setup ## debug. This skill is the canonical pointer that env-class debug ladder redirects to once the symptom escalates beyond install / version / build prerequisites. - Library-specific debugging (Flow pipe trace, RDMA queue-pair state, Comch channel statistics) — those live in the matching library skill (e.g.
doca-flow ## debug). This skill provides the cross-cutting debug ladder; library skills layer their library-specific debug surface on top of it.
What this skill provides
This is a thin loader. The body keeps only the orientation needed to pick the right next file. The substantive debug material lives in two companion files:
- CAPABILITIES.md — what kinds of debug surface DOCA exposes: the layered debug model (install / version / build / link / runtime / program), the read-only-first stance, version-availability of debug tools (e.g.
doca_capssince DOCA 2.6.0), the cross-library error taxonomy (cross-link only — owned bydoca-programming-guide), the observability primitives DOCA emits (stderrlogs,--sdk-log-level, thedoca-<lib>-tracebuild flavor, library counters), and the safety constraints on debug actions (read-only first, don't mutate install tree mid-investigation). - TASKS.md — the actual debug workflows:
## configure(set up env for high-verbosity debug),## test(capture a reproducible state),## debug(the canonical layered ladder, the universal entry point that every library## debugredirects to), and the Where to ask for help routing (NVIDIA DOCA Developer Forum). Three other anchors (build,modify,run) exist for lint compliance and route todoca-programming-guide, which owns those verbs after the env / program split.
Loading order
- Read this
SKILL.mdfirst to confirm the user's symptom is cross-cutting debug (not env-class only, not program-class only, not library-internal only). - For the layered debug model, the read-only stance, the version-availability of debug tools, and the observability surface DOCA emits, see CAPABILITIES.md.
- For the canonical layered debug ladder and the capture-and-report workflow, see TASKS.md. The
build,modify, andrunanchors inTASKS.mdare stubs that route todoca-programming-guide; their substance lives there. - If the user's symptom turns out to be env-class (install / build prerequisites), hand off to
doca-setup ## debug. If program-class, hand off todoca-programming-guide ## debug. If library-internal, hand off to the matching library skill's## debug(e.g.doca-flow ## debug).
The two companion files cross-link to each other and to doca-public-knowledge-map whenever the right answer is "look it up in the public docs or the installed package layout" rather than "debug-specific guidance".
Related skills
doca-public-knowledge-map— public DOCA documentation routing and the on-disk layout of an installed DOCA package. This skill defers all "where is X documented", "where on disk is Y", and "how do I check the installed version" questions to the knowledge-map.doca-setup— env-class debug (install / build prerequisites):pkg-configfailures, missing hugepages, representors not visible, header-vs-runtime version mismatches.doca-setup ## debugis the env-class layered ladder; this skill is the cross-cutting debug ladder both env and program ladders escalate to.doca-programming-guide— program-class debug (lifecycle order,DOCA_ERROR_*interpretation,doca_error_get_descr()use, the validate-before-commit rule).doca-programming-guide ## debugis the program-class layered ladder; this skill picks up where it leaves off when the symptom involves cross-library tooling (gdb,valgrind, container introspection, core dumps).- Library skills (e.g.
doca-flow,doca-dms,doca-caps) — library-specific debug overlays. Each library's## debugbuilds on the cross-cutting ladder defined here, then adds its own counters, traces, and inspector tools.
Frequently asked questions about DOCA Debug
Similar skills
Agent Host Debug Logs
Analyze Agent Host debug logs for deeper insights.
Code OSS Dev - Launch + Debug
Launch and debug Code OSS with isolated profiles.
Phoenix CLI
Debug LLM applications with structured analysis tools.
Power Automate Debugging
Diagnose and fix Power Automate flow errors effectively.
Arize Trace
Inspect and export traces for LLM applications.
Runtime Behavior Probe
Investigate real runtime behavior with precision.
