Index of every page on this site: llms.txt
All skills
datadog-labs avatar

/onboarding-summary

@618fae3 official
Run it yourself

Generate a live Single Step Instrumentation (SSI) onboarding confirmation report — verifies APM instrumentation is working end-to-end with deep links into the Datadog UI. Only use after agent-install and enable-ssi have both completed successfully.

Use this Skill: https://skilld.dev/gh/datadog-labs/agent-skills/onboarding-summary

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈68 tokens for metadata: the name and description. ≈954 when used: this file.

Description uses 3.4% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈269 characters, or 3.4%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

APM Onboarding Summary

Triggers

Invoke this skill when:

  • All steps in verify-ssi have passed
  • All checks in troubleshoot-ssi have been resolved
  • The user asks "is everything working?", "show me the status", or "confirm APM is set up"

Do NOT invoke this skill if any verification or troubleshooting check is still failing — resolve those first.


Context to resolve before acting

Variable How to resolve
AGENT_NAMESPACE Namespace where Datadog Agent is installed
APP_NAMESPACE Namespace of the application
APP_LABEL Check spec.selector.matchLabels.app in the Deployment manifest
CLUSTER_NAME spec.global.clusterName in datadog-agent.yaml
SERVICE_NAME tags.datadoghq.com/service label on the Deployment
ENV tags.datadoghq.com/env label on the Deployment
DD_SITE spec.global.site in datadog-agent.yaml

Prerequisites

Claude runs

pup auth status --site <DD_SITE>

If valid token — proceed.

ERROR: Not authenticated:

Claude runs

pup auth login --site <DD_SITE>

This opens a browser tab for OAuth. Complete the login there — Claude will continue once the command exits.


Collect live confirmation data

Run all of the following. Each populates a row in the final report.

Claude runs

# Agent pod count and status
kubectl get pods -n <AGENT_NAMESPACE> \
  -l app.kubernetes.io/component=agent \
  --no-headers

# SSI instrumentation config live in cluster
kubectl get datadogagent datadog -n <AGENT_NAMESPACE> \
  -o jsonpath='{.spec.features.apm.instrumentation}'

# Init container confirmed in app pod spec
kubectl get pod -l app=<APP_LABEL> -n <APP_NAMESPACE> \
  -o jsonpath='{.items[0].spec.initContainers[*].name}'

# Service visible and traced in APM
DD_SITE=<DD_SITE> pup apm services list --env <ENV> --from 1h

# Traces arriving in the last hour
DD_SITE=<DD_SITE> pup traces search --query "service:<SERVICE_NAME>" --from 1h --limit 5

Only if DSM was enabled via enable-dsm:

# DSM pipeline data for the service
DD_SITE=<DD_SITE> pup metrics query \
  --query "avg:data_streams.latency{service:<SERVICE_NAME>,env:<ENV>} by {pathway_type}" \
  --from 15m --to now

Present the report

Fill in every value from live command output. Do not leave any placeholder unfilled. If a value cannot be confirmed, mark that row as failed and link to troubleshoot-ssi.


APM onboarding complete

Check Detail Status
Datadog Agent <N> pod(s) Running in <AGENT_NAMESPACE> OK
SSI enabled Targeting namespace <APP_NAMESPACE>, language <LANGUAGE> v<MAJOR_VERSION> OK
Init container injected datadog-lib-<language>-init present in pod spec OK
Tracer reporting Service <SERVICE_NAME> appears in pup apm services list with isTraced: true OK
APM service visible <SERVICE_NAME> in env <ENV> OK
Traces arriving <N> trace(s) found in the last hour OK
Data Streams (only if enabled) data_streams.latency series for <SERVICE_NAME>, or "pending first message" OK

Your service in Datadog — click to open:

Construct each URL by substituting real values. Do not print placeholder URLs.

View URL
Service overview https://app.<DD_SITE>/apm/services/<SERVICE_NAME>?env=<ENV>
Traces explorer https://app.<DD_SITE>/apm/traces?query=service:<SERVICE_NAME>%20env:<ENV>
Service map https://app.<DD_SITE>/apm/map?env=<ENV>&service=<SERVICE_NAME>
Agent fleet https://app.<DD_SITE>/fleet-automation
Data Streams (only if enabled) https://app.<DD_SITE>/data-streams

Security constraints

  • Never write a raw API key into any file or chat message

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts1mo3 checks · Risk SAFE
  • Gen Agent Trust Hub1mo

    The skill is a monitoring and verification tool for Datadog APM instrumentation on Kubernetes. It uses standard CLI tools (kubectl and the Datadog pup CLI) to check the status of agents and traces and generate a summary report. No security issues were detected.

  • Socket2mo

    No alerts

  • Snyk1mo

    Risk: LOW · No issues

Signed by skilld at 618fae3. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 days ago.

Activeupdated 2 months ago
Other metadata
metadata
{
  "version": "1.0.0",
  "author": "datadog-labs",
  "repository": "https://github.com/datadog-labs/agent-skills",
  "tags": "datadog,apm,kubernetes,ssi,summary,verification",
  "alwaysApply": "false"
}
  • datadog
  • apm
  • linux
  • ssi
  • instrumentation
  • verification
  • observability
  • agent

README badge

README badge for datadog-labs/agent-skills/onboarding-summary

Generates a live APM onboarding confirmation report for Linux hosts using Datadog's Single Step Instrumentation (SSI), verifying end-to-end trace collection and providing deep links into the Datadog UI. Runs after agent-install and enable-ssi skills complete, collecting agent status, process injection state, and trace arrival metrics to confirm the setup is working.

Generated from the current SKILL.md.

What prerequisites must be met before running this skill?
Both agent-install and enable-ssi skills must have completed successfully, and all checks in verify-ssi and troubleshoot-ssi must be passing. Do not invoke this skill if any verification or troubleshooting checks are still failing.
Does this skill work with non-Linux hosts?
No. This skill is designed specifically for Linux hosts running Single Step Instrumentation (SSI) with the Datadog Agent.
What authentication is required?
You must be authenticated to your Datadog site via pup auth. The skill will prompt for OAuth login if no valid token exists.
Does this skill modify any configuration or just report status?
This skill only collects live data and generates a read-only confirmation report. It does not modify agent configuration or instrumentation settings.

Generated from the current SKILL.md. These answers refresh after source changes.