import {Fragment} from 'react';
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 {getPythonMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
import {
AlternativeConfiguration,
crashReportOnboardingPython,
} from 'sentry/gettingStartedDocs/python/python';
import {t, tct} from 'sentry/locale';
type Params = DocsParams;
const getInstallSnippet = () => `pip install --upgrade 'sentry-sdk[rq]'`;
const getInitCallSnippet = (params: Params) => `
sentry_sdk.init(
dsn="${params.dsn.public}",${
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 === 'transaction'
? `
# 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'
? `
# Manually call start_profiler and stop_profiler
# to profile the code in between
sentry_sdk.profiler.start_profiler()
# do some work here
sentry_sdk.profiler.stop_profiler()`
: ''
}`;
const getSdkSetupSnippet = (params: Params) => `
import sentry_sdk
${getInitCallSnippet(params)}`;
const getStartWorkerSnippet = () => `
rq worker \
-c mysettings \ # module name of mysettings.py
--sentry-dsn="..." # only necessary for RQ < 1.0`;
const getJobDefinitionSnippet = () => `
def hello(name):
1/0 # raises an error
return "Hello %s!" % name`;
const getWorkerSetupSnippet = (params: Params) => `
import sentry_sdk
# Sentry configuration for RQ worker processes
${getInitCallSnippet(params)}`;
const getMainPythonScriptSetupSnippet = (params: Params) => `
from redis import Redis
from rq import Queue
from jobs import hello
import sentry_sdk
#import { get } from 'lodash';
Sentry configuration for main.py process (same as above)
${getInitCallSnippet(params)}
q = Queue(connection=Redis())
with sentry_sdk.start_transaction(name="testing_sentry"):
result = q.enqueue(hello, "World")`;
const onboarding: OnboardingConfig = {
introduction: () =>
tct('The RQ integration adds support for the [link:RQ Job Queue System].', {
link:
{tct(
'If you have the [codeRq:rq] package in your dependencies, the RQ integration will be enabled automatically when you initialize the Sentry SDK.',
{
codeRq:
{tct(
'Create a file called [code:mysettings.py] with the following content:',
{
code: ,
}),
configurations: [
{
language: 'bash',
code: getInstallSnippet(),
},
],
},
],
configure: (params: Params) => [
{
type: StepType.CONFIGURE,
description: (
,
}
)}
,
}
)}
}
)}
{params.isProfilingSelected &&
params.profilingOptions?.defaultProfilingMode === 'continuous' && (
,
}
),
configurations: [
{
description:
{tct(
'When you run [code:python main.py] a transaction named [code:testing_sentry] in the Performance section of Sentry will be created.',
{
code: ,
}
)}
{tct(
'If you run the RQ worker with [code:rq worker -c mysettings] a transaction for the execution of [code:hello()] will be created. Additionally, an error event will be sent to Sentry and will be connected to the transaction.',
{
code: ,
}
)}
{t('It takes a couple of moments for the data to appear in Sentry.')}