Generated banner for Onboarding Summary
Generated logo for Onboarding Summary

Onboarding Summary

DatadogOfficialCreated by datadog-labs

  • Skill
  • Content generator
  • Cloud and DevOps
  • MIT
  • No issues found

From the author

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.
— the description by datadog-labs

AutoGineer summary

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

The onboarding-summary skill provides a structured verification process to confirm that Datadog Single Step Instrumentation (SSI) is correctly configured and reporting data. It performs a series of live checks against the Kubernetes cluster and Datadog platform to validate agent status, init container injection, and trace ingestion. The skill concludes by generating a comprehensive status report with direct deep links into the Datadog UI for service monitoring and troubleshooting.

What it does

  • Verifies the status and pod count of the Datadog Agent in the cluster.
  • Confirms the presence of the required init container in the application pod specification.
  • Validates that the service is correctly identified and traced within the Datadog APM platform.
  • Checks for recent trace ingestion to ensure end-to-end data flow.
  • Optionally verifies Data Streams Monitoring (DSM) latency metrics if enabled.
  • Produces a formatted report with direct links to service maps, trace explorers, and service overviews.

When to use it

  • After completing the agent installation and enabling SSI.
  • When you need to confirm that APM instrumentation is working correctly end-to-end.
  • When a user requests a status update or verification of the APM setup.
  • Only after all prerequisite verification and troubleshooting steps have passed.

Advantages

  • Provides a centralized, live confirmation of complex instrumentation setups.
  • Reduces manual effort by automating the collection of configuration and telemetry data.
  • Ensures consistency in verification reporting across different environments.
  • Facilitates immediate navigation to relevant Datadog UI views via deep links.

Usage examples

“Is everything working with the APM setup?”
The agent runs a series of checks to verify agent pods, init containers, and trace ingestion, then presents a status table and links to the Datadog dashboard.
“Show me the status of the Datadog APM instrumentation.”
The agent generates a report confirming the service is traced and providing direct links to the service map and traces explorer.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/datadog-labs/onboarding-summary-xltz/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip onboarding-summary.zip -d .agents/skills

Documentation by datadog-labs

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

VariableHow to resolve
AGENT_NAMESPACENamespace where Datadog Agent is installed
APP_NAMESPACENamespace of the application
APP_LABELCheck spec.selector.matchLabels.app in the Deployment manifest
CLUSTER_NAMEspec.global.clusterName in datadog-agent.yaml
SERVICE_NAMEtags.datadoghq.com/service label on the Deployment
ENVtags.datadoghq.com/env label on the Deployment
DD_SITEspec.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

CheckDetailStatus
Datadog Agent<N> pod(s) Running in <AGENT_NAMESPACE>OK
SSI enabledTargeting namespace <APP_NAMESPACE>, language <LANGUAGE> v<MAJOR_VERSION>OK
Init container injecteddatadog-lib-<language>-init present in pod specOK
Tracer reportingService <SERVICE_NAME> appears in pup apm services list with isTraced: trueOK
APM service visible<SERVICE_NAME> in env <ENV>OK
Traces arriving<N> trace(s) found in the last hourOK
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.

ViewURL
Service overviewhttps://app.<DD_SITE>/apm/services/<SERVICE_NAME>?env=<ENV>
Traces explorerhttps://app.<DD_SITE>/apm/traces?query=service:<SERVICE_NAME>%20env:<ENV>
Service maphttps://app.<DD_SITE>/apm/map?env=<ENV>&service=<SERVICE_NAME>
Agent fleethttps://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

Files

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 an API key, Needs a command-line tool

Security

No issues found by our static scan· No issues found

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
datadog-labs
Publisher
Datadog (Official)
Source
datadog-labs/agent-skills · dd-apm/k8s-ssi/onboarding-summary · commit 8e1306a
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by datadog-labs or Datadog.

Download ZIP

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