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 for Linux hosts — 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.
— 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 operational on Linux hosts. It gathers live data from the host environment and the Datadog backend to validate agent status, process injection, service tagging, and trace ingestion. The skill culminates in a summary report that includes direct links to relevant Datadog UI views for monitoring and troubleshooting.

What it does

  • Verifies the Datadog Agent status and API key validity on the target host.
  • Checks for proper SSI library injection in the system preload configuration.
  • Confirms that the target service process has the necessary libraries and environment tags loaded.
  • Validates that the Datadog Agent is actively receiving traces from the service.
  • Queries the Datadog backend to confirm the service is visible and traces are being indexed.
  • Generates a report with deep links to the Datadog UI for service, trace, and infrastructure monitoring.

When to use it

  • After completing the initial agent installation and SSI enablement on a Linux host.
  • When you need to confirm that APM instrumentation is working 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 been successfully resolved.

Advantages

  • Provides a centralized, standardized report for APM onboarding status.
  • Reduces manual effort by automating the collection of host-level and backend data.
  • Ensures consistency in verification checks across different Linux environments.
  • Facilitates quick navigation to the Datadog UI for further investigation.

Usage examples

“Is everything working for the APM setup on my Linux host?”
The agent will run a series of diagnostic checks and present a table confirming the status of the agent, process injection, and trace reception, along with links to the Datadog dashboard.
“Confirm APM is set up correctly for the web-service.”
The agent verifies the service tags and trace ingestion for the specified service and provides a summary report confirming the configuration is active.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/datadog-labs/onboarding-summary/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 — Linux Host

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
HOSTNAMEhostname -f on the target host
DD_HOSTNAMEHostname as Datadog sees it — from sudo datadog-agent status
SERVICE_NAMEDD_SERVICE value from /proc/<PID>/environ or the systemd unit
ENVDD_ENV value from /proc/<PID>/environ or the systemd unit
DD_SITEgrep "^site:" /etc/datadog-agent/datadog.yaml
SSH_KEYPath to SSH private key
SSH_USERSSH username
SSH_HOSTHostname or IP of the target host

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 version and status
sudo datadog-agent status 2>&1 | grep -E "Agent \(v|Status:|API Keys status"

# Inject library armed in ld.so.preload
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> "cat /etc/ld.so.preload"

# Process confirmed injected — launcher + language library in /proc/<PID>/maps
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "pgrep -a -f '<SERVICE_NAME>' | head -3"

Use the PID from above:

ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "sudo cat /proc/<PID>/maps | grep -E 'launcher|apm-library|datadog'"

# UST vars in process environment
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "sudo cat /proc/<PID>/environ | tr '\0' '\n' | grep -E 'DD_SERVICE|DD_ENV|DD_VERSION'"

# Agent APM receiver — trace counts
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "sudo datadog-agent status 2>&1 | grep -A 10 'Receiver (previous minute)'"

# Service visible and traced in APM backend
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 Agentv<VERSION> running on <HOSTNAME>, API key validOK
SSI armed/etc/ld.so.preload contains launcher pathOK
Process injectedlauncher + language library in /proc/<PID>/maps for <SERVICE_NAME>OK
Unified Service TagsDD_SERVICE=<SERVICE_NAME> DD_ENV=<ENV> DD_VERSION=<VERSION>OK
Agent receiving traces<N> trace(s)/min in APM receiverOK
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>
Infrastructure hosthttps://app.<DD_SITE>/infrastructure?q=host:<HOSTNAME>
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

SKILL.md

APM Onboarding Summary — Linux Host

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
HOSTNAMEhostname -f on the target host
DD_HOSTNAMEHostname as Datadog sees it — from sudo datadog-agent status
SERVICE_NAMEDD_SERVICE value from /proc/<PID>/environ or the systemd unit
ENVDD_ENV value from /proc/<PID>/environ or the systemd unit
DD_SITEgrep "^site:" /etc/datadog-agent/datadog.yaml
SSH_KEYPath to SSH private key
SSH_USERSSH username
SSH_HOSTHostname or IP of the target host

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 version and status
sudo datadog-agent status 2>&1 | grep -E "Agent \(v|Status:|API Keys status"

# Inject library armed in ld.so.preload
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> "cat /etc/ld.so.preload"

# Process confirmed injected — launcher + language library in /proc/<PID>/maps
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "pgrep -a -f '<SERVICE_NAME>' | head -3"

Use the PID from above:

ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "sudo cat /proc/<PID>/maps | grep -E 'launcher|apm-library|datadog'"

# UST vars in process environment
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "sudo cat /proc/<PID>/environ | tr '\0' '\n' | grep -E 'DD_SERVICE|DD_ENV|DD_VERSION'"

# Agent APM receiver — trace counts
ssh -o StrictHostKeyChecking=no -i <SSH_KEY> <SSH_USER>@<SSH_HOST> \
  "sudo datadog-agent status 2>&1 | grep -A 10 'Receiver (previous minute)'"

# Service visible and traced in APM backend
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 Agentv<VERSION> running on <HOSTNAME>, API key validOK
SSI armed/etc/ld.so.preload contains launcher pathOK
Process injectedlauncher + language library in /proc/<PID>/maps for <SERVICE_NAME>OK
Unified Service TagsDD_SERVICE=<SERVICE_NAME> DD_ENV=<ENV> DD_VERSION=<VERSION>OK
Agent receiving traces<N> trace(s)/min in APM receiverOK
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>
Infrastructure hosthttps://app.<DD_SITE>/infrastructure?q=host:<HOSTNAME>
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

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

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/linux-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