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.
106 lines
3.9 KiB
TypeScript
106 lines
3.9 KiB
TypeScript
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'
|
|
|
|
import { StepDefinition } from '../steps'
|
|
|
|
export const getUnitySteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { CodeBlock, Markdown, dedent } = ctx
|
|
|
|
return [
|
|
{
|
|
title: 'Install the Unity SDK',
|
|
badge: 'required',
|
|
content: (
|
|
<Markdown>
|
|
{dedent`
|
|
Install Insights through the Unity Package Manager:
|
|
|
|
1. Open **Window > Package Manager**.
|
|
2. Select **Add package from git URL** from the **+** menu.
|
|
3. Enter \`https://github.com/Insights/insights-unity.git?path=com.insights.unity\`.
|
|
|
|
The SDK requires Unity 2021.3 LTS or later and the .NET Standard 2.1 API Compatibility Level.
|
|
`}
|
|
</Markdown>
|
|
),
|
|
},
|
|
{
|
|
title: 'Configure Insights',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
Open **Edit > Project Settings > Insights**, enter your project token and host, and keep **Capture Exceptions** enabled. The Unity SDK captures exceptions automatically by default.
|
|
|
|
You can also configure the SDK in code:
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
language="csharp"
|
|
code={dedent`
|
|
using InsightsUnity;
|
|
|
|
Insights.Setup(new InsightsConfig
|
|
{
|
|
ApiKey = "<ph_project_token>",
|
|
Host = "<ph_client_api_host>",
|
|
CaptureExceptions = true,
|
|
ExceptionDebounceIntervalMs = 1000,
|
|
});
|
|
`}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Capture handled exceptions',
|
|
badge: 'optional',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
Automatic capture covers exceptions reported through Unity's exception logging pipeline. Call \`CaptureException\` for handled exceptions that should still appear in Error tracking.
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
language="csharp"
|
|
code={dedent`
|
|
try
|
|
{
|
|
SaveGame();
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
Insights.CaptureException(exception);
|
|
}
|
|
`}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Verify error tracking',
|
|
badge: 'recommended',
|
|
checkpoint: true,
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
Report a test exception through Unity's logger and confirm it appears in [Error tracking](https://app.hanzo.ai/error_tracking).
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
language="csharp"
|
|
code={dedent`
|
|
Debug.LogException(new InvalidOperationException("Automatic test exception from Unity"));
|
|
Insights.Flush();
|
|
`}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
]
|
|
}
|
|
|
|
export const UnityInstallation = createInstallation(getUnitySteps)
|