Getting Started

Before you begin

Osuite Cloud receives all telemetry via the OpenTelemetry Protocol (OTLP). The full setup takes under ten minutes and involves three things:

1. Create your Osuite Cloud account
2. Grab your API key and OTLP endpoint
3. Point your services (or the OTel Collectors) at that endpoint

No proprietary agents. No vendor-specific SDKs. If you already use OpenTelemetry, step 3 is likely all you need.

Step 1 : Create your account

Go to osuite.io and sign up. On sign you will get your API key and ingestion endpoint.

Note that ingest endpoint is region specific. It will look something like this:

ingest.<region>.osuite.io:443

Step 2 : Choose your setup path

Option A : Instrument your application with the Instrumentation Agent (Recommended)

The fastest way to send traces and logs from a service is the Instrumentation Agent. It runs in your AI IDE, detects your language, framework, and libraries — any stack — installs the right OpenTelemetry packages, writes the SDK init module, and sets the environment variables for you. Most services are live in under an hour.

/osuite-instrument instrument this service to send traces and logs to Osuite

See the Instrumentation Agent guide for the one-time osuite init-ai setup and a full walkthrough.

Option B : Deploy the OpenTelemetry Collector

You can deploy open telemetry collectos to collect logs and metrics. (If you need traces go with option A).

Save the following as otel-collector.yaml:

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318

processors:
  batch:
    timeout: 5s
    send_batch_size: 1000

exporters:
  otlp/osuite:
    endpoint: ingest.us.osuite.io:443
    tls:
      insecure: false
    headers:
      x-osuite-ingest-token: <YOUR_API_KEY>

service:
  pipelines:
    logs:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp/osuite]

Replace <YOUR_API_KEY> with the key from Step 1. Run the Collector:

docker run --rm \
  -v $(pwd)/otel-collector.yaml:/etc/otel-collector.yaml \
  otel/opentelemetry-collector-contrib:latest \
  --config /etc/otel-collector.yaml

Step 3 : Verify data is arriving

Open the Osuite UI. Within a few seconds of starting your instrumented application you should see:

• Traces appearing under Traces
• Logs streaming in Logs

(Infrastructure metrics arrive once you set up Infrastructure Monitoring.)

If nothing appears after 60 seconds, check:

• The API key is correct
• Your collector or app is able to reach ingest.<region>.osuite.io (not blocked by a firewall)
• Your application is actually generating requests (some frameworks only emit spans when a request is handled)

Next steps

With data flowing, explore the core features:

• APM & Distributed Tracing — View golden signals and trace individual requests across services
• Log Management — Collect and search logs from applications and servers
• Infrastructure Monitoring — Monitor hosts and Kubernetes via the OpenTelemetry Collector
• Investigation Agent — Diagnose incidents from your IDE once telemetry is flowing
• Alerts — Set up threshold-based alerts with Slack or Opsgenie notifications