import ExternalLink from 'sentry/components/links/externalLink';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import type {
Docs,
DocsParams,
OnboardingConfig,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {
AlternativeConfiguration,
crashReportOnboardingPython,
} from 'sentry/gettingStartedDocs/python/python';
import {t, tct} from 'sentry/locale';
type Params = DocsParams;
const getSdkSetupSnippet = (params: Params) => `
import sentry_sdk
from sentry_sdk.integrations.trytond import TrytondWSGIIntegration
sentry_sdk.init(
dsn="${params.dsn.public}",
integrations:[
sentry_sdk.integrations.trytond.TrytondWSGIIntegration(),
],${
params.isPerformanceSelected
? `
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for tracing.
traces_sample_rate=1.0,`
: ''
}${
params.isProfilingSelected &&
params.profilingOptions?.defaultProfilingMode !== 'continuous'
? `
# Set profiles_sample_rate to 1.0 to profile 100%
# of sampled transactions.
# We recommend adjusting this value in production.
profiles_sample_rate=1.0,`
: params.isProfilingSelected &&
params.profilingOptions?.defaultProfilingMode === 'continuous'
? `
_experiments={
# Set continuous_profiling_auto_start to True
# to automatically start the profiler on when
# possible.
"continuous_profiling_auto_start": True,
},`
: ''
}
)
from trytond.application import app as application
# ...`;
const getErrorHandlerSnippet = () => `
# ...
from trytond.exceptions import TrytonException
from trytond.exceptions import UserError
@application.error_handler
def _(app, request, e):
if isinstance(e, TrytonException):
return
else:
event_id = sentry_sdk.last_event_id()
data = UserError('Custom message', f'{event_id}{e}')
return app.make_response(request, data)`;
const onboarding: OnboardingConfig = {
introduction: () =>
tct('The Tryton integration adds support for the [link:Tryton Framework Server].', {
link: ,
}),
install: () => [],
configure: (params: Params) => [
{
type: StepType.CONFIGURE,
description: tct(
'To configure the SDK, initialize it with the integration in a custom [code:wsgi.py] script:',
{
code:
,
}
),
configurations: [
{
code: [
{
label: 'wsgi.py',
value: 'wsgi.py',
language: 'python',
code: getSdkSetupSnippet(params),
},
],
},
{
description: t(
'In Tryton>=5.4 an error handler can be registered to respond the client with a custom error message including the Sentry event id instead of a traceback.'
),
language: 'python',
code: [
{
label: 'wsgi.py',
value: 'wsgi.py',
language: 'python',
code: getErrorHandlerSnippet(),
},
],
},
],
additionalInfo: ,
},
],
verify: () => [],
};
const docs: Docs = {
onboarding,
crashReportOnboarding: crashReportOnboardingPython,
};
export default docs;