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.
84 lines
3.3 KiB
TypeScript
84 lines
3.3 KiB
TypeScript
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'
|
|
|
|
import { getRubySteps as getRubyStepsPA } from '../product-analytics/ruby'
|
|
import { StepDefinition } from '../steps'
|
|
|
|
export const getRubySteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { CodeBlock, Markdown, Blockquote, dedent } = ctx
|
|
|
|
const installSteps = getRubyStepsPA(ctx)
|
|
|
|
const manualCaptureStep: StepDefinition = {
|
|
title: 'Manually capture exceptions',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Blockquote>
|
|
<Markdown>
|
|
{dedent`
|
|
**Using Ruby on Rails?** The \`insights-rails\` gem provides automatic exception capture for controllers and background jobs. Select "Ruby on Rails" from the SDK list for setup instructions.
|
|
`}
|
|
</Markdown>
|
|
</Blockquote>
|
|
<Markdown>
|
|
{dedent`
|
|
To capture exceptions in your Ruby application, use the \`capture_exception\` method:
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'ruby',
|
|
file: 'Ruby',
|
|
code: dedent`
|
|
begin
|
|
# Code that might raise an exception
|
|
raise StandardError, "Something went wrong"
|
|
rescue => e
|
|
insights.capture_exception(
|
|
e,
|
|
'user_distinct_id',
|
|
{
|
|
custom_property: 'custom_value'
|
|
}
|
|
)
|
|
end
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<Markdown>
|
|
{dedent`
|
|
The \`capture_exception\` method accepts the following parameters:
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| \`exception\` | \`Exception\` | The exception object to capture (required) |
|
|
| \`distinct_id\` | \`String\` | The distinct ID of the user (optional) |
|
|
| \`additional_properties\` | \`Hash\` | Additional properties to attach to the exception event (optional) |
|
|
`}
|
|
</Markdown>
|
|
</>
|
|
),
|
|
}
|
|
|
|
const verifyStep: StepDefinition = {
|
|
title: 'Verify error tracking',
|
|
badge: 'recommended',
|
|
checkpoint: true,
|
|
content: (
|
|
<Markdown>
|
|
{dedent`
|
|
Confirm exception events are being captured and sent to Insights. You should see events appear in the activity feed.
|
|
|
|
[Check for exceptions in Insights](https://app.hanzo.ai/activity/explore)
|
|
`}
|
|
</Markdown>
|
|
),
|
|
}
|
|
|
|
return [...installSteps, manualCaptureStep, verifyStep]
|
|
}
|
|
|
|
export const RubyInstallation = createInstallation(getRubySteps)
|