import ExternalLink from 'sentry/components/links/externalLink';
import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout';
import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import {ProductSolution} from 'sentry/components/onboarding/productSelection';
import {t, tct} from 'sentry/locale';
// Configuration Start
const profilingConfiguration = ` # 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,`;
const performanceConfiguration = ` # Set traces_sample_rate to 1.0 to capture 100%
# of transactions for performance monitoring.
# We recommend adjusting this value in production.
traces_sample_rate=1.0,`;
const introduction = (
{tct(
'The Pyramid integration adds support for the [link:Pyramid Web Framework]. It requires Pyramid 1.6 or later.',
{
link: ,
}
)}
);
export const steps = ({
sentryInitContent,
}: {
sentryInitContent: string;
}): LayoutProps['steps'] => [
{
type: StepType.INSTALL,
description: {tct('Install [code:sentry-sdk] from PyPI:', {code:
})}
,
configurations: [
{
language: 'bash',
code: '$ pip install --upgrade sentry-sdk',
},
],
},
{
type: StepType.CONFIGURE,
description: t(
'To configure the SDK, initialize it with the integration before or after your app has been created:'
),
configurations: [
{
language: 'python',
code: `
from pyramid.config import Configurator
from wsgiref.simple_server import make_server
import sentry_sdk
from sentry_sdk.integrations.pyramid import PyramidIntegration
sentry_sdk.init(
${sentryInitContent}
)
def sentry_debug(request):
division_by_zero = 1 / 0
with Configurator() as config:
config.add_route('sentry-debug', '/')
config.add_view(sentry_debug, route_name='sentry-debug')
app = config.make_wsgi_app()
server = make_server('0.0.0.0', 6543, app)
server.serve_forever()
`,
},
],
},
];
// Configuration End
export function GettingStartedWithPyramid({
dsn,
activeProductSelection = [],
...props
}: ModuleProps) {
const otherConfigs: string[] = [];
let sentryInitContent: string[] = [
` dsn="${dsn}",`,
` integrations=[PyramidIntegration()],`,
];
if (activeProductSelection.includes(ProductSolution.PERFORMANCE_MONITORING)) {
otherConfigs.push(performanceConfiguration);
}
if (activeProductSelection.includes(ProductSolution.PROFILING)) {
otherConfigs.push(profilingConfiguration);
}
sentryInitContent = sentryInitContent.concat(otherConfigs);
return (
);
}
export default GettingStartedWithPyramid;