Skip to content
Osuite Osuite Docs

Instrumentation Agent

The Osuite Instrumentation Agent integrates with your AI IDE and instruments your code for you. It detects your language, framework, and key libraries, looks up the right OpenTelemetry packages, writes the SDK init module, and wires up traces and logs — so most services are live in Osuite in under an hour, not the weeks instrumentation usually takes.

This is the “before the incident” half of Osuite: get full visibility fast, with no proprietary agents and no hand-written OTel boilerplate.

Prerequisites

Section titled “Prerequisites”
  • The Osuite CLI installed and the agent skills set up — follow the one-time agent setup. Once done, the Instrumentation Agent is available as /osuite-instrument.

Step 1: Instrument your code

Section titled “Step 1: Instrument your code”

Open your project in your AI IDE and trigger the agent:

Terminal window
/osuite-instrument instrument this service to send traces and logs to Osuite, including the database and Kafka clients

The agent detects your stack, presents a written plan (packages to install, files to create or modify, the environment variables you’ll need), and — once you approve — installs the packages, writes the init module, edits your entry point, and generates an instrumentation.md for your deployment. Your existing logger.info(...) calls keep working unchanged; the OTel logs bridge just exports a copy of each record with the active trace ID attached.

If you have a specific requirement, say so in the prompt and the agent will account for it.

Step 2: Set the required environment variables

Section titled “Step 2: Set the required environment variables”

The agent writes these into your project, but you must fill in the endpoint and token for your account:

Terminal window
OTEL_SERVICE_NAME="my-service"
OTEL_EXPORTER_OTLP_ENDPOINT="https://ingest.<region>.osuite.io:443"
OTEL_EXPORTER_OTLP_HEADERS="x-osuite-ingest-token=<your-ingest-token>"
OTEL_RESOURCE_ATTRIBUTES="service.environment=dev"

Note: service.environment is required by Osuite to group telemetry by environment (prod, staging, dev). Use this Osuite-specific key — not the standard deployment.environment.

Step 3: Start your application and verify

Section titled “Step 3: Start your application and verify”

Start your application, generate some traffic, and open the Osuite UI. You should see traces under Traces, logs streaming under Logs, and metrics in Dashboards → Explore metrics.

Troubleshooting

Section titled “Troubleshooting”

If nothing appears after 60 seconds, check:

  • The required environment variables are all set
  • The ingest token is correct
  • The OTLP endpoint is reachable from where your service runs (not blocked by a firewall)
  • Your application is actually handling requests — some frameworks only emit spans when a request is served

Next steps

Section titled “Next steps”