A set of Sentry SDKs for various Luau environments. To simplify design and implementation, these SDKs are hand-translated from the Sentry JavaScript SDK (with deviations for Luau specific constructs).
The Luau SDK is currently following vesion 9.35
of the
JavaScript SDK.
I'd like to support all major Luau runtimes with a high-level SDK, but only have the bandwidth to support the platforms I use myself. If you'd like to add support for a Luau-based runtime that isn't already supported, please refer to the contribution guide!
Please refer to the README and instructions of each SDK for more detailed information:
sentry-roblox
: SDK for Roblox
To install an SDK, add the high-level package. For example, with Wally:
# wally.toml
[dependencies]
Sentry = "neura-studios/sentry-roblox@1.0.0"
wally install
Setup and usage of these SDKs always follows the same principle.
local Sentry = require(Path.To.Sentry)
Sentry.init({
dsn = "__DSN__",
-- ...
})
Sentry.captureMessage("Hello, world!")
Besides the high-level SDKs, this repository contains shared packages, helpers and configuration used for SDK development. If you're thinking about contributing to or creating a Luau-based SDK, have a look at the resources below:
sentry-core
: The base for all Luau SDKs with type definitions and base classes.sentry-utils
: A set of helpers and utility functions useful for various SDKs.sentry-types
: Types used in all packages.