Writing Skills
writing-skills
效率与协作技能,来自 obra/superpowers,查看原文获取完整用途和操作说明。
enable-ssi【部署与运维】Enable Single Step Instrumentation (SSI) on Kubernetes — automatically instruments applications for APM without code changes. Only use if the Datadog Agent is already running on the cluster — if not, use agent-install first.
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
Before doing anything else: Fully resolve all variables in
## Context to resolve before acting. Do not begin Step 0 until every variable has a concrete value.
Silent failure — check this before any other step:
If the application has
ddtrace,dd-trace, or any OpenTelemetry SDK in its dependency manifest (requirements.txt,package.json,Gemfile,go.mod,pom.xml) — even with no import statements in code — SSI will silently disable itself at runtime.The failure is invisible: init containers run and complete, the pod starts healthy, no errors appear in
kubectlorpup, but no traces arrive. The injector detects the user-installed tracer and exits cleanly without logging anything.Claude runs
grep -rE "ddtrace|dd-trace|opentelemetry" \ requirements.txt package.json Gemfile go.mod pom.xml 2>/dev/null \ || echo "No tracer dependency found"If any match — stop. Remove the package entirely (not just the import), rebuild the image, reload it into the cluster, and restart the pod before continuing. A package present in the manifest is enough to trigger this even if it is never imported.
Invoke this skill when the user expresses intent to:
Do NOT invoke this skill if:
agent-install firstverify-ssienable-dsmdd-apm-k8s-sdk-featuresThese are not a reading exercise — actively verify each one before proceeding.
Environment
agent-install completeLanguage and runtime
-javaagent JVM flagExisting instrumentation — confirmed clean by the check at the top of this skill. If you skipped that check, go back and run it now.
Discover from the cluster — do not ask the user for information you can find yourself.
| Variable | How to resolve |
|---|---|
AGENT_NAMESPACE | Same namespace used in agent-install (e.g. datadog) |
APP_NAMESPACE | Run kubectl get namespaces --no-headers | awk '{print $1}' | grep -vE '^(kube-system|kube-public|kube-node-lease|datadog|local-path-storage)#x27; — instrument all non-system namespaces, or use the namespace(s) the user mentioned |
TARGET_LANGUAGES | Run kubectl get pods -A -o jsonpath='{.items[*].spec.containers[*].image}' and infer language from image names, or check Dockerfiles/manifests in the workspace. If uncertain, enable all languages. |
DEPLOYMENT_NAME | Run kubectl get deployments -A --no-headers — identify application deployments (exclude system components) |
APP_LABEL | Check spec.selector.matchLabels in the Deployment manifest via kubectl get deployment <DEPLOYMENT_NAME> -n <APP_NAMESPACE> -o yaml |
CLUSTER_NAME | Check spec.global.clusterName in datadog-agent.yaml, or kubectl config current-context — needed for kind clusters in Step 0 |
ENV | Use apm-evals if running in an eval cluster (kind cluster names contain "evalya"). Otherwise use production unless the user specifies otherwise. |
SERVICE_NAME | Use the deployment name (e.g. python-app → service python-app). Do not ask the user. |
VERSION | Use 1.0.0 as the default. Do not ask the user. |
Scan all source files for: import ddtrace, from ddtrace, require 'ddtrace', require("dd-trace"), opentelemetry, tracer.trace(
Also check dependency manifests for ddtrace / dd-trace / OTel SDK packages.
If found — remove the import/package, then rebuild and reload:
docker build -f <DOCKERFILE_PATH> -t <IMAGE_NAME> <BUILD_CONTEXT>
[DECISION: how does this cluster get local images?]
Check the repo's setup script (e.g. create.sh, Makefile, justfile) for how images are loaded — do not guess from the cluster name or context. Common patterns:
| What you find in the setup script | Load command |
|---|---|
minikube image load or minikube cache add | minikube -p <PROFILE> image load <IMAGE_NAME> — profile is the -p flag value in the script, NOT necessarily the kubectl context name |
kind load docker-image | kind load docker-image <IMAGE_NAME> --name <CLUSTER_NAME> |
docker push to a registry | Push the new image; the cluster will pull on restart — skip local load |
k3d image import | k3d image import <IMAGE_NAME> -c <CLUSTER_NAME> |
| No image load step (cloud cluster, always pulls from registry) | Skip — image will be pulled on next deployment |
If the setup script is ambiguous, run the load command it uses exactly as written.
Confirm with the user before restarting. Tell the user: "I need to restart
<DEPLOYMENT_NAME>in<APP_NAMESPACE>to pick up the rebuilt image. Ready to proceed?" Wait for confirmation.
kubectl rollout restart deployment/<DEPLOYMENT_NAME> -n <APP_NAMESPACE>
kubectl wait --for=condition=Ready pod \
-l app=<APP_LABEL> \
-n <APP_NAMESPACE> \
--timeout=120s
SSI is configured on the existing DatadogAgent resource — do not create a separate manifest.
Choose targeting scope based on what the user asked for:
Default is cluster-wide (Option A). If the user said "all my applications", "my whole cluster", or didn't restrict scope, use Option A with no
enabledNamespacesortargets.
Recommended ddTraceVersions: java: "1", python: "2", js: "5", dotnet: "3", ruby: "2", php: "1"
Option A — Cluster-wide (default):
features:
apm:
instrumentation:
enabled: true
Option B — Specific namespaces only:
features:
apm:
instrumentation:
enabled: true
enabledNamespaces:
- <APP_NAMESPACE>
Option C — Cluster-wide with exclusions:
features:
apm:
instrumentation:
enabled: true
disabledNamespaces:
- jenkins
- kube-system
Option D — Target specific workloads:
features:
apm:
instrumentation:
enabled: true
targets:
- name: <TARGET_NAME>
namespaceSelector:
matchNames:
- <APP_NAMESPACE>
ddTraceVersions:
<LANGUAGE>: "<MAJOR_VERSION>"
Note:
ddTraceVersionsonly applies inside atargets[]entry (Option D). It is not valid alongsideenabledNamespacesor at theinstrumentationlevel directly.
kubectl apply -f datadog-agent.yaml
If datadogagent.datadoghq.com/datadog configured — continue to Step 2.
ERROR: Validation error — check YAML. enabledNamespaces and disabledNamespaces cannot both be set.
Do NOT modify application Deployments without explicit user confirmation. Applying labels to existing application workloads is a change to customer-managed resources.
Inform the user that adding Unified Service Tags (UST) to their Deployments will enable proper service/env/version tagging in Datadog. This is optional for SSI to work but recommended for full observability:
# Add to both metadata.labels and spec.template.metadata.labels
tags.datadoghq.com/env: "<ENV>"
tags.datadoghq.com/service: "<SERVICE_NAME>"
tags.datadoghq.com/version: "<VERSION>"
If the user wants you to apply these, get their confirmation first. Applying label changes rolls the pods immediately; if DSM will be enabled in Step 2b, apply the labels after it. UST labels are not required for APM traces to flow; SSI works without them.
Skip this step entirely in an eval cluster (kind cluster name contains "evalya") or when running non-interactively: run nothing, ask nothing, and continue to the next step.
Otherwise, read the ## Is DSM a fit? section of .claude/skills/dd-apm/enable-dsm/SKILL.md and run its detection command.
enable-dsm. It asks the user once, states the plan rule, and makes the config change without restarting.If the user agrees, enable-dsm applies its DatadogAgent change and waits until the Cluster Agent is on the new config, so the restart in Step 3 picks up both SSI and DSM. In Step 3, restart one DSM Deployment first and run the DD_DATA_STREAMS_ENABLED check from enable-dsm Step 2a on it before restarting the rest. If it came up without init containers, wait 30 seconds and restart it once more.
Confirm with the user before restarting. Tell the user: "I need to restart
<DEPLOYMENT_NAME>in<APP_NAMESPACE>for SSI to inject into the pods. This will cause a brief outage. Ready to proceed?" Wait for confirmation.
kubectl rollout restart deployment/<DEPLOYMENT_NAME> -n <APP_NAMESPACE>
kubectl wait --for=condition=Ready pod \
-l app=<APP_LABEL> \
-n <APP_NAMESPACE> \
--timeout=120s
If pods restart cleanly, init containers named datadog-lib-<language>-init will be visible in the pod spec.
ERROR: Pods crash-looping — check for existing custom instrumentation. See troubleshoot-ssi.
Exit when ALL of the following are true:
features.apm.instrumentation is present in the applied DatadogAgent manifestAutomatically proceed to verify-ssi now — do not ask the user for permission.
default for Datadog resourcesadmissionController settings directly — SSI manages this via the OperatorDatadogAgenttags.datadoghq.com/*) on application Deployments are required and intentionalkubectl delete without user confirmationdocker push to a registry always requires user confirmationkubectl patch to apply UST labels or any Deployment changes. Always edit the Deployment YAML file and kubectl apply -f. Changes made with kubectl patch are transient and will be overwritten on the next rollout.