OpenParable
Skip to content
← Back to skills

Create Status Provider

Development
create-status-provider

Create Status Provider is an Agent Skill for development published in the DataDog/datadog-agent repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Add a new section to the agent status output (agent status command)

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/DataDog/datadog-agent/blob/HEAD/.claude/skills/create-status-provider/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/create-status-provider, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Add a new status provider to the Datadog Agent. Status providers contribute sections to the agent status output in JSON, plain text, and HTML formats.

Instructions

Step 1: Gather information from the user

Use AskUserQuestion to collect the following. If $ARGUMENTS provides the provider name, skip that question.

  1. Provider name: Display name for this status section (e.g. "DogStatsD", "Forwarder").
  2. Section name: Grouping key. Providers with the same section are grouped. "collector" always appears first.
  3. What data to display: What information should this section show?
  4. Placement: Inside an existing component's Provides struct (most common) or standalone module?
  5. Conditional?: Should the provider only appear when a feature is enabled?

Step 2: Read reference examples

Before writing any code, read the appropriate reference files to follow existing patterns:

WhatReference file
Provider interfacecomp/core/status/component.go
Provider implementation + templatescomp/dogstatsd/status/statusimpl/status.go and its status_templates/ directory
Registration in component Providescomp/trace/status/statusimpl/status.go
Template helpers (humanize, etc.)comp/core/status/render_helpers.go

Step 3: Implement the provider

Create the provider implementation following the reference. Also create the status_templates/<name>.tmpl and status_templates/<name>HTML.tmpl files following the templates in the reference's status_templates/ directory.

To make a provider conditional, return nil from the constructor when the feature is disabled.

Step 4: Register the provider

Register using status.NewInformationProvider(yourProvider{...}) — either in an existing component's Provides struct (most common) or as a standalone Module(). The reference files show both patterns.

Step 5: Verify

  1. Build: dda inv agent.build --build-exclude=systemd
  2. Lint: dda inv linter.go
  3. Report the results to the user.

Important Notes

  • Template directory must be named exactly status_templates and embedded via //go:embed status_templates.
  • Use a top-level key (e.g. "myFeatureStats") to namespace data in the shared stats map.
  • For HeaderProvider (rarely needed), use NewHeaderInformationProvider() instead.

Usage

  • /create-status-provider — Interactive: prompts for all details
  • /create-status-provider "My Feature" — Pre-fills the provider name