Doca Ngauge

NVIDIAOfficialCreated by NVIDIA

Skill
Tool integration
Software development
Apache-2.0
Medium risk

From the author

Use this skill when the operator is driving the DOCA ngauge tool to analyze, visualize, and debug network performance on a single node by probing NIC hardware counters and storing collected data in HDF5 format. Trigger even when the user does not say "DOCA ngauge" — implicit phrasings include "probe NIC hardware counters", "collect HDF5 performance data", "plot ngauge output", "sample counters on BlueField/ConnectX", "measure network performance on a single node", "debug network performance with hardware counters", "run ngauge YAML config", "parse ngauge HDF5 output". Refuse and route elsewhere: DOCA install/bring-up to doca-setup, version questions to doca-version, hardware/firmware state changes to doca-hardware-safety, raw packet I/O to doca-eth, and host-DPU messaging to doca-comch.

— the description by NVIDIA

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The doca-ngauge skill provides guidance for using the DOCA ngauge tool to probe NIC hardware counters on supported NVIDIA devices, including BlueField-3 and ConnectX-7. It enables users to collect performance data in HDF5 format, visualize metrics, and debug network performance on a single node. The skill covers YAML-based configuration, execution workflows, and the interpretation of counter data, while maintaining strict boundaries against hardware state changes or raw packet I/O operations.

What it does

Probes NIC hardware counters for network performance analysis.
Stores collected performance telemetry in HDF5 format.
Supports YAML-based configuration for sampling parameters and counter selection.
Provides methods for visualizing and parsing collected HDF5 data.
Interprets CLI progress indicators and counter summary statistics.
Diagnoses common runtime issues such as fwctl driver conflicts.

When to use it

When you need to measure network performance on a single node using hardware counters.
When configuring sampling periods and counter IDs via YAML files.
When you need to plot or analyze previously collected ngauge HDF5 output.
When troubleshooting performance issues that require deep NIC hardware telemetry.
When resolving conflicts involving the fwctl driver.

Advantages

Enables granular network performance monitoring via hardware-level probes.
Standardizes data collection using the HDF5 format for consistent analysis.
Provides a structured approach to debugging performance bottlenecks.
Integrates with existing DOCA toolsets for streamlined operations.

Usage examples

“Probe NIC hardware counters on a BlueField-3 and save HDF5 data.”: The agent will guide you through creating a YAML configuration file with the appropriate device address and counter IDs, then show you how to execute the ngauge command.
“Plot the collected counter data from an ngauge output file.”: The agent will direct you to use the sample plugins provided in the ngauge installation to parse and visualize your HDF5 data.
“ngauge cannot start because fwctl is in use.”: The agent will help identify conflicting services using the fwctl driver and advise on how to resolve the dependency.

Install

Download the skill as a ZIP:
https://autogineer.com/agent-skills/nvidia/doca-ngauge/download

Unzip it into the cross-client skills folder of your project:

mkdir -p .agents/skills && unzip doca-ngauge.zip -d .agents/skills

Documentation by NVIDIA

DOCA ngauge

Scope boundaries

These requests are out of scope: say so, name the skill that owns the request, and stop.

raw Ethernet packet send/receive at line rate: doca-eth/SKILL.md.
host-DPU control-plane messaging (Comch): doca-comch/SKILL.md.
DOCA install and bring-up: doca-setup/SKILL.md.
which DOCA version is installed, version compatibility: doca-version/SKILL.md.
NIC or BlueField mode and firmware changes: doca-hardware-safety/SKILL.md.
general DOCA orientation and documentation lookup: doca-public-knowledge-map/SKILL.md.

Examples

"Probe NIC hardware counters on a BlueField-3 and save HDF5 data." — this is in scope. Configure the YAML file and run ngauge; do not attempt to change hardware or firmware state here.
"Plot the collected counter data from an ngauge output file." — use the sample plugins under /usr/share/doc/ngauge/examples/plugins; dependencies may need separate installation.
"ngauge cannot start because fwctl is in use." — check for other tools or services that also use fwctl; route install and driver conflict resolution to doca-setup.

Quick facts

The authoritative source for the binary name, flags, paths, and configuration schema is the public DOCA ngauge guide at https://docs.nvidia.com/doca/archive/3-5-0/doca-ngauge/index.html. Confirm details with the installed tool's --help and the sample configuration files before quoting them.

ngauge analyzes, visualizes, and debugs network performance on a single node by probing NIC hardware counters and storing collected data in HDF5 format with relevant metadata.
Supported hardware: NVIDIA BlueField-3, NVIDIA ConnectX-7, and above; firmware version xx.43.1000 or higher.
ngauge relies on the fwctl driver and cannot run simultaneously with other tools or services that also use fwctl.
All configurations are defined in an input YAML file. Sample configuration files are under /usr/share/doc/ngauge/examples/settings.
The device is specified by its PCIe address, for example device: "0000:03:00.0".
Output path and file prefix are mandatory. The output file is saved as /path/to/output/directory/<prefix>_<DATE>_<TIME>.h5; the exact file name is printed after each run.
The silent option suppresses CLI progress indications when set to true (default false).
Runtime parameters include mode (repetitive or single) and period_us (sampling period in microseconds; decimal or scientific notation accepted, e.g. 1e2 = 100 μs).
Counter definitions require id (data ID); optional fields are desc, unit, accumulating, normalizer (time, a non-zero number, or a configured data ID with an id/ prefix), cutoff_min, and cutoff_max.
All supported performance counters are listed in the public guide's "Supported Data IDs" section.
Run ngauge with:
```
ngauge <configuration YAML file>
```
To end a run early, use Ctrl+C (SIGINT). This is a normal and supported way to stop; all results collected up to that point are saved as usual.
During a run, progress bars for each counter are displayed. Color coding: blue for low values, red for high values, gradient for intermediate values, solid gray for no changes. Data is updated once per second, showing mean, standard deviation (σ), minimum, and maximum observed during the last second.
To reference the most recent results when the output directory is /tmp (the default), use:
```
$(ls -1 /tmp/ngauge_data_*.h5 | tail -n1)
```

Instructions

Follow Loading order below. Open the tasks companion for configure / run / parse / debug. Open the capabilities companion for what ngauge measures and reports. Do not open every companion file.

Where to start: This is a tool skill for invoking DOCA ngauge — the single-node network performance analysis, visualization, and debugging tool that probes NIC hardware counters and stores HDF5 data. Open the tasks companion and start at ## configure for the YAML configuration decision, then ## run for the execution flow. Open the capabilities companion when the question is what counters can be measured, what metadata is stored, and what the progress display implies. If the user has not installed ngauge or fwctl, route to doca-setup/SKILL.md first. If the user is asking about hardware/firmware state changes, route to doca-hardware-safety/SKILL.md. If the user is asking about version compatibility, route to doca-version/SKILL.md.

How to use this skill. Read this file, then search the companion file for the ## <name> heading the question needs and read that whole section. Answer completely from it, quoting only its symbols and commands. Do not browse docs; use the entry points in doca-public-knowledge-map. Give environment checks as commands for the user's DOCA host. For out-of-scope requests, name the skill that owns them and stop.

Example questions this skill answers well

The CLASSES of ngauge questions this skill is built to answer, each with one worked example. The class is the load-bearing piece; the worked example is one instance.

"How do I configure ngauge to sample specific NIC hardware counters?" — worked example: "I need to measure RX bytes port 0 and TX bytes port 0 on a BlueField-3 at a 100 μs period, save to /tmp with prefix ngauge_data_." Answered by the YAML configuration model in the capabilities companion + the tasks companion step 2.
"How do I run ngauge and stop it early without losing data?" — worked example: "I started ngauge with a YAML config, want to stop after 10 seconds and still get HDF5 output." Answered by the execution flow and Ctrl+C behavior in the tasks companion.
"How do I plot the collected HDF5 data?" — worked example: "I have /tmp/ngauge_data_2026-09-01_12-00-00.h5 and want to plot counter 0x1020000100000000." Answered by the parse/plot workflow in the tasks companion using simple_plot.py or simple_text_plot.py.
"What do the progress bar colors mean?" — worked example: "During a run, some bars are red, some blue, some gray; what does that indicate?" Answered by the progress display semantics in the capabilities companion.
"Why can't ngauge run alongside another tool?" — worked example: "ngauge fails to start because fwctl is in use by another service." Answered by the fwctl dependency and conflict section in the capabilities companion + route to doca-setup.
"What hardware and firmware are required?" — worked example: "Will ngauge work on ConnectX-6 or BlueField-2?" Answered by the prerequisites in the capabilities companion.

When to load this skill

Load this skill when the user is — or the agent needs to — drive DOCA ngauge on a real host or BlueField Arm with ngauge installed. Concretely:

Probing NIC hardware counters on BlueField-3 or ConnectX-7 and above.
Configuring the ngauge YAML file (device, output, params, counters).
Running ngauge and interpreting the CLI progress bars and summary.
Parsing or plotting the HDF5 output with the sample plugins.
Diagnosing fwctl driver conflicts or missing prerequisites.
Cross-checking counter data against expected network performance.

Do not load this skill for general DOCA orientation, raw packet I/O, the comch control plane, DOCA install, version questions, or hardware/firmware state changes. For those, route to doca-public-knowledge-map/SKILL.md, doca-eth/SKILL.md, doca-comch/SKILL.md, doca-setup/SKILL.md, doca-version/SKILL.md, or doca-hardware-safety/SKILL.md.

What this skill provides

This is a thin loader. Substantive material lives in two companion files:

the capabilities companion — what ngauge measures and reports: supported hardware and firmware, the fwctl dependency and conflict, the YAML configuration model (device, output, params, counters), counter field semantics (id, desc, unit, accumulating, normalizer, cutoff_min, cutoff_max), HDF5 output format, progress display semantics, sample plugins, and the safety posture that ngauge itself is read-only probing while any step that changes hardware or firmware state routes to doca-hardware-safety.
the tasks companion — step-by-step workflows for the in-scope task verbs: configure (YAML setup), run (execution and Ctrl+C), parse / plot (simple_plot.py and simple_text_plot.py), debug (fwctl conflict, missing dependencies), plus a Command appendix that honors the bundle's doca-structured-tools-contract/SKILL.md preamble.

The skill assumes a host or BlueField where ngauge and fwctl are already installed and the operator has whatever privileges the public DOCA ngauge guide requires for the chosen device.

What this skill deliberately does not ship

This skill is agent guidance, not a samples or scripts bundle. To keep the boundary clean, it deliberately does not contain — and pull requests should not add:

Verbatim counter ID inventories, flag lists, or output column names. The public DOCA ngauge guide on docs.nvidia.com and the installed --help on the user's version are the joint source of truth; copying them here pins the skill to one release and silently rots when ngauge evolves. The skill routes the agent at those sources instead.
Pre-baked example output. Output is install-, version-, and device-specific. A captured example will mislead an operator on a different platform or state.
Wrappers, parsers, or scripts in any language that consume ngauge output. The output format is documented; users who want to script against it should read the live guide and write the parser against their installed version.
A samples/ or reference/ subtree. This is a thin loader for a documented DOCA artifact; substantive material lives on the public page and in --help.

Loading order

Read this skill first to confirm the user's question is in scope (the user wants to probe NIC hardware counters, collect HDF5 data, or plot ngauge output, not learn the eth / comch / RDMA APIs).
For what ngauge measures, the YAML configuration model, the read-only vs state-changing split, version availability, the fwctl conflict surface, observability, and safety posture, see the capabilities companion.
For the documented invocations and the configure → run → parse/plot workflow — configure, run, parse, debug, plus the Command appendix — see the tasks companion.

doca-setup/SKILL.md — env preparation, install verification, fwctl driver installation and conflict resolution, and the I have no install yet path. This skill assumes its preconditions are satisfied.
doca-version/SKILL.md — canonical DOCA version-handling rules. The ## Version compatibility section in the capabilities companion is a concise overlay that redirects here for the body.
doca-hardware-safety/SKILL.md — any step that changes hardware or firmware state routes here. ngauge itself is read-only probing, but if a workflow includes firmware updates or device state changes, use this skill.
doca-public-knowledge-map/SKILL.md — routing to the public DOCA ngauge guide and the rest of the public DOCA documentation set. The canonical URL is reached via doca-public-knowledge-map ## DOCA tools (doca-public-knowledge-map/SKILL.md#doca-tools).
doca-structured-tools-contract/SKILL.md — the bundle's detect → prefer → fall back → report contract for structured helper tools. The Command appendix in the tasks companion honors this contract.
doca-debug/SKILL.md — the cross-cutting debug ladder. ngauge slots in at the runtime layer as a single-node telemetry tool whose fwctl conflict surface escalates to the cross-cutting ladder when the cause is below DOCA.
doca-eth/SKILL.md — the line-rate raw packet I/O surface. ngauge is for hardware counter telemetry, not packet I/O; use doca-eth when the application needs to operate on packets directly.
doca-comch/SKILL.md — the host ↔ DPU control-plane primitive. ngauge is single-node performance telemetry, not a control-plane channel; pair them only when coordinating a measurement across host and DPU.

Files

ATTRIBUTION.mdAdded by AutoGineer891 B
BENCHMARK.md10.9 KiB
CAPABILITIES.md12.2 KiB
LICENSELicence file added by AutoGineer11.2 KiB
SKILL.md13.7 KiB
SKILLCARD.yaml2.4 KiB
TASKS.md13.7 KiB
evals/evals.json3.0 KiB
skill-card.md4.8 KiB
skill.oms.sig5.1 KiB

LICENSE

Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.


                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Node.js

The author says: Requires a host with ngauge installed (sudo apt-get install ngauge or sudo dnf install ngauge on x86 or Arm 64 hosts; pre-installed on the DPU) and a BlueField-3 or ConnectX-7 or above device with firmware version xx.43.1000 or higher. The fwctl driver must be installed on the host; on Linux kernel 6.15 and above it is available by default unless explicitly disabled during kernel configuration. ngauge cannot run simultaneously with other tools or services that also use fwctl.

Security

What our scanner noticed· Medium risk

Large base64-encoded blobs

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by

NVIDIA

Publisher

NVIDIA (Official)

Source

NVIDIA/skills · skills/doca-ngauge · commit fce3cca

Licence

Apache License 2.0 (redistribution allowed)

LICENSE (added by AutoGineer from LICENSE-APACHE)
ATTRIBUTION.md (written by AutoGineer)

Synced

2026-11-09

AutoGineer is not affiliated with or endorsed by NVIDIA or NVIDIA.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download doca-ngauge.zip