kopai-app/otel-instrumentation
skills/otel-instrumentation/SKILL.md
Instrument applications with OpenTelemetry SDK and validate telemetry using Kopai. Use when setting up observability, adding tracing/logging/metrics, testing instrumentation, debugging missing telemetry data, or when traces/logs/metrics aren't appearing after setup. Also use when users say things like "my traces aren't showing up", "I don't see any data", or "how do I add observability to my app".
$ install --global
skillsauthnpx skillsauth add kopai-app/kopai-mono otel-instrumentationInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 16, 2026, 6:49 AM5.5s26 files scanned
SKILL.md
- name:
- otel-instrumentation
- description:
- Instrument applications with OpenTelemetry SDK and validate telemetry using Kopai. Use when setting up observability, adding tracing/logging/metrics, testing instrumentation, debugging missing telemetry data, or when traces/logs/metrics aren't appearing after setup. Also use when users say things like "my traces aren't showing up", "I don't see any data", or "how do I add observability to my app".
- license:
- Apache-2.0
- author:
- kopai
- version:
- 1.1.0
OpenTelemetry Instrumentation with Kopai
Guide for instrumenting applications with OpenTelemetry SDK and validating telemetry locally using Kopai.
Quick Reference
# Start backend
npx @kopai/app start
# Configure app
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
export OTEL_SERVICE_NAME=my-service
# Validate telemetry
npx @kopai/cli traces search --service my-service --json
npx @kopai/cli logs search --service my-service --json
npx @kopai/cli metrics discover --json
Workflow
- Start backend —
npx @kopai/app start - Set env vars —
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318andOTEL_SERVICE_NAME=<name> - Instrument app — install SDK + auto-instrumentation for your language (see rules below)
- Validate —
npx @kopai/cli traces search --service <name> --json. If empty: check endpoint/port, verify app is running and generating traffic, wait 10-30s and retry - Troubleshoot — if still no data, check rules in section 4 below
Quick Example (Node.js)
npm install @opentelemetry/sdk-node @opentelemetry/auto-instrumentations-node @opentelemetry/api
Create instrumentation.mjs:
import { NodeSDK } from "@opentelemetry/sdk-node";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
const sdk = new NodeSDK({ instrumentations: [getNodeAutoInstrumentations()] });
sdk.start();
Run: node --import ./instrumentation.mjs server.mjs
Rules
1. Setup (CRITICAL)
setup-backend- Start Kopai Backendsetup-environment- Configure Environment
2. Language SDKs (HIGH)
lang-nodejs- Node.js Instrumentationlang-nextjs- Next.js Instrumentationlang-python- Python Instrumentationlang-go- Go Instrumentationlang-java- Java Instrumentationlang-dotnet- .NET Instrumentationlang-ruby- Ruby Instrumentationlang-php- PHP Instrumentationlang-rust- Rust Instrumentationlang-erlang- Erlang/Elixir Instrumentationlang-cpp- C++ Instrumentation
3. Validation (HIGH)
validate-traces- Validate Tracesvalidate-logs- Validate Logsvalidate-metrics- Validate Metrics
4. Troubleshooting (MEDIUM)
troubleshoot-no-data- No Data Receivedtroubleshoot-missing-spans- Missing Spanstroubleshoot-missing-attrs- Missing Attributestroubleshoot-wrong-port- Wrong Port
Read rules/<rule-name>.md for details.
References
- cli-reference - Kopai CLI command reference
- otel-docs - OpenTelemetry documentation links
- nextjs-examples - Next.js instrumentation examples
Related Skills
kopai-app/root-cause-analysis
tools
VerifiedTrustedCommunity
Analyze telemetry data for root cause analysis using Kopai CLI. Use when debugging errors, investigating latency issues, tracing request flows across services, or correlating logs with traces. Also use when users report production issues like "why is my API slow", "getting 500 errors", "service is down", "requests are timing out", or any symptom that needs telemetry-based investigation — even if they don't mention traces or observability explicitly.
3SKILL.mdUpdated Apr 16, 2026
kopai-app/create-dashboard
development
VerifiedTrustedCommunity
Create observability dashboards from OTEL metrics, logs, and traces using Kopai. Use when building metric visualizations, monitoring views, KPI panels, or when the user wants to see their telemetry data in a dashboard — even if they don't say "dashboard" explicitly. Also use when other skills or workflows need to present telemetry data visually (e.g. after root cause analysis).
3SKILL.mdUpdated Apr 16, 2026
openclaw/openclaw-secret-scanning-maintainer
development
VerifiedTrustedCommunity
Maintainer-only workflow for handling GitHub Secret Scanning alerts on OpenClaw. Use when Codex needs to triage, redact, clean up, and resolve secret leakage found in issue comments, issue bodies, PR comments, or other GitHub content.
357,764SKILL.mdUpdated Apr 15, 2026
openclaw/openclaw-release-maintainer
development
VerifiedTrustedCommunity
Maintainer workflow for OpenClaw releases, prereleases, changelog release notes, and publish validation. Use when Codex needs to prepare or verify stable or beta release steps, align version naming, assemble release notes, check release auth requirements, or validate publish-time commands and artifacts.
357,764SKILL.mdUpdated Apr 10, 2026