Getting Started

Install the SDK, initialize server and client capture, and send your first event.

This guide gets RoSentry live in a Roblox experience from scratch.

1. Create a project in RoSentry

Sign in and open /dashboard/projects.
Click New Project.
Copy the generated API key (rs_...).

You will use this key on the server only.

2. Install the SDK

Option A: Wally (recommended)

[dependencies]
RoSentry = "boshyxd/rosentry@0.1.0"

wally install

Option B: Manual

Place the RoSentry module folder in ReplicatedStorage.

3. Initialize on the server

Create a bootstrap script in ServerScriptService:

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local RoSentry = require(ReplicatedStorage.RoSentry)
-- If using Wally:
-- local RoSentry = require(ReplicatedStorage.Packages.RoSentry)

RoSentry.init({
    apiKey = "rs_your_api_key_here",
    environment = "production",
})

4. Initialize on the client

Create a script in StarterPlayerScripts:

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local RoSentry = require(ReplicatedStorage.RoSentry)
-- If using Wally:
-- local RoSentry = require(ReplicatedStorage.Packages.RoSentry)

RoSentry.init({
    environment = "production",
})

Client events are relayed to the server through RoSentryRelay, so no API key is exposed on clients.

5. Send a test event

RoSentry.captureMessage("RoSentry quickstart test", {
    level = "info",
    tags = {"setup", "smoke-test"},
})

Or force an error for automatic capture testing:

error("RoSentry test exception")

6. Verify in dashboard

Open /dashboard/errors.
Confirm a new group appears.
Open the group and confirm stack/context data is present.