Get Started Page

In this guide, you will learn how to effectively navigate through the Get Started page on the monoscope dashboard and maximize all the powerful features accessible in it.

On this page, you will find the checklist that shows your onboarding progress. The last and important step is to integrate your project with one of our SDKs so monoscope can begin monitoring your API and likewise, you can begin exploring your API data in our dashboard. To help you achieve that easily, we also provide quick guides on this page on how to install and integrate some of our popular SDKs (others are linked too) with the auto-generated API key included in the code snippets so you can easily copy and paste them into your application. If you want to create a new API key or see all created API keys, you can click the Generate an API key step to go to the page for that.

Screenshot of monoscope’s get started page

Once you finish integrating one of our SDKs with your application, monoscope will begin monitoring your API, and you can now move forward to other pages in the dashboard.

Quick Test - Try It Without Code

Want to test monoscope before integrating it into your application? You can use telemetrygen to send test telemetry data and see how monoscope works immediately!

What is telemetrygen?

Telemetrygen is an OpenTelemetry tool that generates sample telemetry data. It’s perfect for: - Testing your API key before deploying your app - Exploring monoscope features without writing code - Validating your setup is working correctly - Testing alerting rules with simulated traffic

Quick Start (< 2 minutes)

# Run this single command with your API key
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" \
  --traces 10 --rate 2

✅ No installation needed - just Docker!

# Install with Homebrew
brew install telemetrygen

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

# Download and install
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

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

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

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

What happens next? After running the command, check your API Log Explorer - you should see test traces appearing within seconds! This confirms your API key works and monoscope is ready to receive your data.

Simulate Different Scenarios

# Simulate normal traffic
telemetrygen traces --otlp-insecure \
  --otlp-endpoint otel.monoscope.tech:4317 \
  --otlp-header="x-api-key=YOUR_API_KEY" \
  --service-name "my-api" \
  --duration 30s --rate 10

# Generate errors to test alerts
telemetrygen traces --otlp-insecure \
  --otlp-endpoint otel.monoscope.tech:4317 \
  --otlp-header="x-api-key=YOUR_API_KEY" \
  --service-name "my-api" \
  --status-code "ERROR" --traces 5

Why Use This?

🚀 Instant Gratification: See monoscope in action before writing any integration code
✅ Validate Setup: Confirm your API key and project configuration work correctly
🧪 Test Features: Explore dashboards, alerts, and analytics with real-looking data
📊 Demo Ready: Perfect for showing monoscope to your team

Pro Tip: Use different service names and span names in telemetrygen to simulate multiple services and see how monoscope organizes and visualizes complex architectures!

Next: Dashboard Page