mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
1b367e2b62
The tree was a debranded snapshot of upstream taken around 2026-02-20, and upstream has moved about five months since. This replaces it with upstream master, mechanically re-derived: bin/debrand does the rename, and the pipeline and squashed migrations are restored from the shipped tree. Not a merge. The previous import replaced the tree wholesale in a single commit, so there is no shared content history to merge against. Reproducing the rename on the new tree is what actually converges. What survives: .hanzo/workflows, the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md, and insights/migrations. The squashed initial migration is load-bearing — the live database records it by name, so upstream's ~918 individual migrations cannot come back. Nine products are dropped as unreferenced. Twenty-one more that we do not run are kept anyway because the core app still imports them; unpicking those is a refactor and does not belong in a rebase. This base does not build yet, and the reasons are not in the rename: upstream now wants Python 3.13.13 against our 3.12.12 and Django 5.2 against our 4.2, and the dependency manifests still name upstream packages that we republish under our own names. Those are decisions, not renames.
130 lines
5.1 KiB
TypeScript
130 lines
5.1 KiB
TypeScript
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'
|
|
|
|
import { StepDefinition } from '../steps'
|
|
|
|
export const getRobloxSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { CodeBlock, Markdown, dedent } = ctx
|
|
|
|
return [
|
|
{
|
|
title: 'Install the Roblox SDK',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
Install Insights through Wally, or download the latest \`insights-roblox.rbxm\` from the [SDK releases](https://github.com/Insights/insights-roblox/releases) and insert it into \`ReplicatedStorage\`.
|
|
|
|
For Wally and Rojo, add this dependency and run \`wally install\`:
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
language="toml"
|
|
code={dedent`
|
|
[dependencies]
|
|
Insights = "insights/[email protected]"
|
|
`}
|
|
/>
|
|
<Markdown>
|
|
{dedent`
|
|
Then map the installed package into \`ReplicatedStorage\` in your Rojo project file:
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
language="json"
|
|
code={dedent`
|
|
"ReplicatedStorage": {
|
|
"$className": "ReplicatedStorage",
|
|
"Insights": { "$path": "Packages/Insights" }
|
|
}
|
|
`}
|
|
/>
|
|
<Markdown>
|
|
{dedent`
|
|
In Studio, enable **Game Settings > Security > Allow HTTP Requests**.
|
|
`}
|
|
</Markdown>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Configure Insights',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
Initialize Insights once from a server \`Script\`. Exception autocapture is enabled by default.
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
language="lua"
|
|
code={dedent`
|
|
local ReplicatedStorage = game:GetService("ReplicatedStorage")
|
|
local Insights = require(ReplicatedStorage:WaitForChild("Insights"))
|
|
|
|
Insights:Init({
|
|
apiKey = "<ph_project_token>",
|
|
host = "<ph_client_api_host>",
|
|
captureErrors = true,
|
|
errorDebounceSeconds = 1,
|
|
})
|
|
`}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Capture handled exceptions',
|
|
badge: 'optional',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
The SDK automatically listens for unhandled server errors. Require it from a \`LocalScript\` to relay unhandled client errors to the server. Call \`CaptureException\` for handled errors.
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
language="lua"
|
|
code={dedent`
|
|
local capturedMessage
|
|
local ok, capturedTraceback = xpcall(
|
|
function()
|
|
saveGame(player)
|
|
end,
|
|
function(errorMessage)
|
|
capturedMessage = tostring(errorMessage)
|
|
return debug.traceback(capturedMessage, 2)
|
|
end
|
|
)
|
|
|
|
if not ok then
|
|
Insights:CaptureException(player, capturedMessage, capturedTraceback, {
|
|
flow = "save_game",
|
|
})
|
|
end
|
|
`}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Verify error tracking',
|
|
badge: 'recommended',
|
|
checkpoint: true,
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
Raise a test error from a server \`Script\` and confirm it appears in [Error tracking](https://app.hanzo.ai/error_tracking).
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock language="lua" code='error("Automatic test exception from Roblox")' />
|
|
</>
|
|
),
|
|
},
|
|
]
|
|
}
|
|
|
|
export const RobloxInstallation = createInstallation(getRobloxSteps)
|