Onboarding Guide

Steps

1. Create an Account
2. Create a Project
3. Get Your API Key
4. Integrate an SDK
5. Test Your Integration
6. Acknowledge Endpoints

① Create an Account

Sign up at app.monoscope.tech using Google, GitHub, or email.

② Create a New Project

After signing up, you’ll be guided through creating your first project. You can update all of these values later.

• About you: A quick survey to help us tailor your experience.

• Setup project: Choose a server location and the features you’ll be exploring.

• Create endpoint: Add an endpoint to monitor and optionally choose the request type.

• Set notifications: Get alerts via Slack, Discord, email, or SMS when something goes wrong (optional).

• Add member: Invite teammates to the project (optional).

• Integration examples: See sample code for your framework (optional).

• Plan: Choose your billing plan (required).

③ Get Your API Key

An API key is generated automatically when you create a project. To find it or create additional keys, click API Keys in the bottom-left of the dashboard.

④ Integrate an SDK

Add a Monoscope SDK to your application to start sending telemetry data. We have native SDKs for 17+ frameworks, plus OpenTelemetry support for any language.

Need help? Email us and we’ll get you set up.

⑤ Test Your Integration

Verify everything works by sending test data with telemetrygen before deploying.

# Using Homebrew
brew install telemetrygen

# Or download directly
curl -LO https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/latest/download/telemetrygen_darwin_amd64
chmod +x telemetrygen_darwin_amd64
sudo mv telemetrygen_darwin_amd64 /usr/local/bin/telemetrygen

# Download the binary
curl -LO https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/latest/download/telemetrygen_linux_amd64
chmod +x telemetrygen_linux_amd64
sudo mv telemetrygen_linux_amd64 /usr/local/bin/telemetrygen

# Download from PowerShell
Invoke-WebRequest -Uri https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/latest/download/telemetrygen_windows_amd64.exe -OutFile telemetrygen.exe

# Run using Docker
docker run --rm -it ghcr.io/open-telemetry/opentelemetry-collector-contrib/telemetrygen:latest \
  traces --otlp-insecure \
  --otlp-endpoint otel.monoscope.tech:4317 \
  --otlp-header="x-api-key=YOUR_API_KEY"

# Send test traces
telemetrygen traces \
  --otlp-insecure \
  --otlp-endpoint otel.monoscope.tech:4317 \
  --otlp-header="x-api-key=YOUR_API_KEY" \
  --traces 10 \
  --rate 2

# Simulate a service with normal traffic
telemetrygen traces \
  --otlp-insecure \
  --otlp-endpoint otel.monoscope.tech:4317 \
  --otlp-header="x-api-key=YOUR_API_KEY" \
  --service-name "payment-service" \
  --span-name "process-payment" \
  --duration 1m \
  --rate 5

# Simulate errors (with status codes)
telemetrygen traces \
  --otlp-insecure \
  --otlp-endpoint otel.monoscope.tech:4317 \
  --otlp-header="x-api-key=YOUR_API_KEY" \
  --service-name "auth-service" \
  --span-name "authenticate" \
  --status-code "ERROR" \
  --traces 5

⑥ Acknowledge Endpoints or Anomalies

As Monoscope receives traffic, it auto-detects your API endpoints (visible in Explorer) and anomalies (visible in Changes & Errors). Acknowledge each endpoint to tell Monoscope what’s expected — this enables accurate anomaly detection and scheduled reports.

Dashboard Overview

Next Steps