Getting Started

Quick start guide to set up Sublyzer in your application in under 5 minutes.

Welcome to Sublyzer

Sublyzer is a complete observability platform that helps you monitor performance, track errors, analyze user behavior, and automatically fix bugs with AI. This guide will get you up and running in under 5 minutes.

What you'll achieve:

  • Create your first integration
  • Install the SDK in your app
  • Start collecting data in real-time
  • View your first dashboard
Step 1: Create an account

If you haven't already, sign up for a free account at sublyzer.com/auth/register.

You can sign up with email/password, Google, or Microsoft account. The free plan includes 1 integration, 50,000 events/month, and 7-day data retention — perfect for getting started.

Step 2: Create an integration

An integration represents your application or website in Sublyzer. Each integration gets a unique code that you'll use to send data.

  1. Go to the Dashboard
  2. Click "Create Integration" button
  3. Enter a name for your integration (e.g., "My Website" or "Production App")
  4. Copy the generated integration code — you'll need this next

Tip: Your integration code looks like this: abc123def456ghi789jkl012

Step 3: Install the SDK

You need your 24-character integration code from the dashboard (Integrations → your app). No secret API keys in the browser — just that code.

The SDK is not on npm. Install via the Windows wizard, a script tag, or download from the SDK Customizer.

A — Windows installer (.exe)

Easiest on Windows: paste your code, pick project folder + framework. Files are written for you.

  1. Download sublyzer-installer.exe
  2. Enter integration code → select project path → choose stack
  3. Click Install → run your app → see events in the dashboard (~60s)

B — Manual install

You place the files yourself — no npm package.

  • CDN: one <script> tag to https://www.sublyzer.com/sublyzer.js
  • Self-host: download from SDK Customizer, put sublyzer.js in public/sdks/
  • Other languages: same Customizer → generated Python, PHP, Go, etc.

Manual — script tag (CDN)

<script
  src="https://www.sublyzer.com/sublyzer.js"
  data-integration-code="YOUR_24_CHAR_CODE"
  defer
></script>

Local dev: add data-api-url="http://localhost:3001"

Manual — download + self-host (Next.js / React)

1. Open SDK Customizer → paste code → Download (sublyzer.js + sublyzer.config.js)
2. Save to public/sdks/sublyzer.js
3. Add the script tag in your layout or HTML:

<script
  src="/sdks/sublyzer.js"
  data-integration-code="YOUR_24_CHAR_CODE"
  defer
></script>

Installer — what it does

The .exe downloads the same canonical sublyzer.js and writes it into your project (e.g. public/sdks/sublyzer.js) plus config snippets for your framework. Same files as the Customizer download.

Deep Scan (PRO) and Strike API are server-side — they do not ship inside the SDK. Full install guide (PT): repo docs/SDK-INSTALL.md.

Step 4: Verify installation

After installing the SDK, verify everything is working:

  1. Open your application in a browser
  2. Navigate to a few pages to generate some data
  3. Go to your Sublyzer Dashboard
  4. Click on your integration to see data flowing in

Data should appear within seconds. If you don't see any data after a minute, check the Troubleshooting Guide.

Step 5: Explore your dashboard

Your integration dashboard gives you access to powerful features:

Performance

Core Web Vitals, load times, and trends

Errors

Track exceptions with full stack traces

Sessions

User sessions grouped by behavior

Security

Issue List (SDK + agent), AI fixes, tags & severity

Analytics

Funnels, cohorts, and A/B testing

AI Insights

Automatic recommendations and fixes

What's next?

Now that you're set up, explore these features to get the most out of Sublyzer:

Need help? Join our Discord.