{lines.map((line, i) => {
- const contextLine = contextLines[i]!;
+ const contextLine = contextLines![i]!;
const isActive = activeLineNumber === contextLine[0];
return (
diff --git a/static/app/components/events/interfaces/frame/deprecatedLine.tsx b/static/app/components/events/interfaces/frame/deprecatedLine.tsx
index 8f666540d12f9b..ecab4232f3f4e9 100644
--- a/static/app/components/events/interfaces/frame/deprecatedLine.tsx
+++ b/static/app/components/events/interfaces/frame/deprecatedLine.tsx
@@ -14,6 +14,7 @@ import {LeadHint} from 'sentry/components/events/interfaces/frame/leadHint';
import {StacktraceLink} from 'sentry/components/events/interfaces/frame/stacktraceLink';
import type {FrameSourceMapDebuggerData} from 'sentry/components/events/interfaces/sourceMapsDebuggerModal';
import {SourceMapsDebuggerModal} from 'sentry/components/events/interfaces/sourceMapsDebuggerModal';
+import {useStacktraceContext} from 'sentry/components/events/interfaces/stackTraceContext';
import {getThreadById} from 'sentry/components/events/interfaces/utils';
import {StrictClick} from 'sentry/components/strictClick';
import {IconChevron, IconFix, IconRefresh} from 'sentry/icons';
@@ -39,6 +40,7 @@ import {
hasContextRegisters,
hasContextSource,
hasContextVars,
+ hasPotentialSourceContext,
isPotentiallyThirdPartyFrame,
} from './utils';
@@ -109,6 +111,7 @@ function DeprecatedLine({
components,
}: Props) {
const organization = useOrganization();
+ const {hasScmSourceContext} = useStacktraceContext();
const [isHovering, setIsHovering] = useState(false);
const [isExpanded, setIsExpanded] = useState(initialExpanded ?? false);
const platform = getPlatform(data.platform, propPlatform ?? 'other');
@@ -119,9 +122,10 @@ function DeprecatedLine({
(hasContextSource(data) && data.context) ||
hasContextVars(data) ||
hasContextRegisters(registers) ||
- hasAssembly(data, platform)
+ hasAssembly(data, platform) ||
+ (hasScmSourceContext && hasPotentialSourceContext(data))
);
- }, [data, registers, platform]);
+ }, [data, registers, platform, hasScmSourceContext]);
const toggleContext = (evt?: React.MouseEvent) => {
evt?.preventDefault();
@@ -344,6 +348,7 @@ function DeprecatedLine({
hasContextRegisters={hasContextRegisters(registers)}
emptySourceNotation={emptySourceNotation}
hasAssembly={hasAssembly(data, platform)}
+ hasScmSourceContext={hasScmSourceContext}
isExpanded={isExpanded}
registersMeta={registersMeta}
frameMeta={frameMeta}
diff --git a/static/app/components/events/interfaces/frame/useSourceContext.spec.tsx b/static/app/components/events/interfaces/frame/useSourceContext.spec.tsx
new file mode 100644
index 00000000000000..2c081cc3fa913c
--- /dev/null
+++ b/static/app/components/events/interfaces/frame/useSourceContext.spec.tsx
@@ -0,0 +1,60 @@
+import {EventFixture} from 'sentry-fixture/event';
+import {ProjectFixture} from 'sentry-fixture/project';
+
+import {renderHookWithProviders, waitFor} from 'sentry-test/reactTestingLibrary';
+
+import type {SourceContextResponse} from 'sentry/components/events/interfaces/frame/useSourceContext';
+import {useSourceContext} from 'sentry/components/events/interfaces/frame/useSourceContext';
+
+describe('useSourceContext', () => {
+ const project = ProjectFixture();
+ const event = EventFixture({projectID: project.id});
+ const frame = {
+ filename: 'src/app.py',
+ lineNo: 10,
+ absPath: '/path/to/src/app.py',
+ function: 'test_func',
+ module: null,
+ package: null,
+ };
+
+ beforeEach(() => {
+ MockApiClient.clearMockResponses();
+ });
+
+ it('fetches source context when enabled', async () => {
+ const mockResponse: SourceContextResponse = {
+ context: [
+ [8, 'def helper():'],
+ [9, ' pass'],
+ [10, 'def test_func():'],
+ [11, ' return "result"'],
+ [12, ''],
+ ],
+ sourceUrl: 'https://github.com/example/repo/blob/main/src/app.py',
+ error: null,
+ };
+
+ MockApiClient.addMockResponse({
+ url: `/projects/org-slug/${project.slug}/stacktrace-source-context/`,
+ body: mockResponse,
+ });
+
+ const {result} = renderHookWithProviders(useSourceContext, {
+ initialProps: {
+ event,
+ frame,
+ orgSlug: 'org-slug',
+ projectSlug: project.slug,
+ },
+ });
+
+ await waitFor(() => {
+ expect(result.current.data).toBeDefined();
+ });
+
+ expect(result.current.data?.context).toEqual(mockResponse.context);
+ expect(result.current.data?.sourceUrl).toBe(mockResponse.sourceUrl);
+ expect(result.current.data?.error).toBeNull();
+ });
+});
diff --git a/static/app/components/events/interfaces/frame/useSourceContext.tsx b/static/app/components/events/interfaces/frame/useSourceContext.tsx
new file mode 100644
index 00000000000000..e970e9f2164aa5
--- /dev/null
+++ b/static/app/components/events/interfaces/frame/useSourceContext.tsx
@@ -0,0 +1,55 @@
+import {buildStacktraceLinkQuery} from 'sentry/components/events/interfaces/frame/useStacktraceLink';
+import type {Event, Frame} from 'sentry/types/event';
+import {getApiUrl} from 'sentry/utils/api/getApiUrl';
+import type {ApiQueryKey, UseApiQueryOptions} from 'sentry/utils/queryClient';
+import {useApiQuery} from 'sentry/utils/queryClient';
+
+export interface SourceContextResponse {
+ context: Array<[number, string]>;
+ error: string | null;
+ sourceUrl: string | null;
+}
+
+interface UseSourceContextProps {
+ event: Partial>;
+ frame: Partial<
+ Pick
+ >;
+ orgSlug: string;
+ projectSlug: string | undefined;
+}
+
+const sourceContextQueryKey = (
+ orgSlug: string,
+ projectSlug: string | undefined,
+ query: ReturnType
+): ApiQueryKey => [
+ getApiUrl(
+ '/projects/$organizationIdOrSlug/$projectIdOrSlug/stacktrace-source-context/',
+ {
+ path: {
+ organizationIdOrSlug: orgSlug,
+ projectIdOrSlug: projectSlug!,
+ },
+ }
+ ),
+ {query},
+];
+
+export function useSourceContext(
+ {event, frame, orgSlug, projectSlug}: UseSourceContextProps,
+ options: Partial> = {}
+) {
+ const query = {
+ ...buildStacktraceLinkQuery(event, frame),
+ file: (frame.filename || frame.absPath)!,
+ };
+ return useApiQuery(
+ sourceContextQueryKey(orgSlug, projectSlug, query),
+ {
+ staleTime: Infinity,
+ retry: false,
+ ...options,
+ }
+ );
+}
diff --git a/static/app/components/events/interfaces/frame/utils.tsx b/static/app/components/events/interfaces/frame/utils.tsx
index 272ee15376b495..a53f22cbe50e86 100644
--- a/static/app/components/events/interfaces/frame/utils.tsx
+++ b/static/app/components/events/interfaces/frame/utils.tsx
@@ -43,25 +43,36 @@ export function hasAssembly(frame: Frame, platform?: string) {
);
}
+/**
+ * Returns true if the frame has enough information to potentially fetch
+ * source context from an SCM integration (filename + line number + in-app).
+ */
+export function hasPotentialSourceContext(frame: Frame) {
+ return !!frame.inApp && !!frame.lineNo && !!(frame.filename || frame.absPath);
+}
+
export function isExpandable({
frame,
registers,
emptySourceNotation,
platform,
isOnlyFrame,
+ hasScmSourceContext,
}: {
frame: Frame;
registers: StacktraceType['registers'];
emptySourceNotation?: boolean;
+ hasScmSourceContext?: boolean;
isOnlyFrame?: boolean;
platform?: string;
}) {
- return (
+ return !!(
(!isOnlyFrame && emptySourceNotation) ||
hasContextSource(frame) ||
hasContextVars(frame) ||
hasContextRegisters(registers) ||
- hasAssembly(frame, platform)
+ hasAssembly(frame, platform) ||
+ (hasScmSourceContext && hasPotentialSourceContext(frame))
);
}
diff --git a/static/app/components/events/interfaces/nativeFrame.tsx b/static/app/components/events/interfaces/nativeFrame.tsx
index e356ebbfca0552..c5bf5419df6064 100644
--- a/static/app/components/events/interfaces/nativeFrame.tsx
+++ b/static/app/components/events/interfaces/nativeFrame.tsx
@@ -104,7 +104,7 @@ function NativeFrame({
const isDartAsyncSuspensionFrame =
frame.filename === '' ||
frame.absPath === '';
- const {displayOptions, stackView} = useStacktraceContext();
+ const {displayOptions, stackView, hasScmSourceContext} = useStacktraceContext();
const {sectionData} = useIssueDetails();
const debugSectionConfig = sectionData[SectionKey.DEBUGMETA];
@@ -136,6 +136,7 @@ function NativeFrame({
registers,
platform,
emptySourceNotation,
+ hasScmSourceContext,
});
const inlineFrame =
@@ -282,7 +283,7 @@ function NativeFrame({
({
stackType: StackType.ORIGINAL,
displayOptions: [],
setDisplayOptions: () => {},
+ hasScmSourceContext: false,
isFullStackTrace: true,
forceFullStackTrace: false,
setIsFullStackTrace: () => {},
@@ -94,6 +101,13 @@ export function StacktraceContext({
defaultIsNewestFramesFirst = true,
}: StackTraceContextOptions) {
const organization = useOrganization();
+ const hasScmFeature = organization.features.includes('scm-source-context');
+ const {data: detailedProject} = useDetailedProject(
+ {orgSlug: organization.slug, projectSlug: projectSlug ?? ''},
+ {enabled: hasScmFeature && defined(projectSlug)}
+ );
+ const hasScmSourceContext = hasScmFeature && !!detailedProject?.scmSourceContextEnabled;
+
const [isFullStackTrace, setIsFullStackTrace] = useState(false);
const [isNewestFramesFirst, setIsNewestFramesFirst] = useState(
defaultIsNewestFramesFirst
@@ -123,6 +137,7 @@ export function StacktraceContext({
setIsNewestFramesFirst,
displayOptions,
setDisplayOptions,
+ hasScmSourceContext,
stackView,
stackType,
forceFullStackTrace,
@@ -133,6 +148,7 @@ export function StacktraceContext({
isNewestFramesFirst,
displayOptions,
setDisplayOptions,
+ hasScmSourceContext,
stackView,
stackType,
]
diff --git a/static/app/components/externalIssues/externalIssueForm.spec.tsx b/static/app/components/externalIssues/externalIssueForm.spec.tsx
index ff66f46c6e278a..509b1468287eac 100644
--- a/static/app/components/externalIssues/externalIssueForm.spec.tsx
+++ b/static/app/components/externalIssues/externalIssueForm.spec.tsx
@@ -70,8 +70,7 @@ describe('ExternalIssueForm', () => {
/>,
{organization}
);
- expect(await screen.findByTestId('loading-indicator')).not.toBeInTheDocument();
- await userEvent.click(screen.getByText(action));
+ await userEvent.click(await screen.findByText(action));
return wrapper;
};
@@ -196,7 +195,7 @@ describe('ExternalIssueForm', () => {
/>,
{organization}
);
- expect(await screen.findByTestId('loading-indicator')).not.toBeInTheDocument();
+ await screen.findByRole('textbox', {name: 'Project'});
expect(initialQuery).toHaveBeenCalled();
// Initial query may only have a few fields
diff --git a/static/app/components/externalIssues/ticketRuleModal.spec.tsx b/static/app/components/externalIssues/ticketRuleModal.spec.tsx
index c70a79164209ed..961f2a2db5ba26 100644
--- a/static/app/components/externalIssues/ticketRuleModal.spec.tsx
+++ b/static/app/components/externalIssues/ticketRuleModal.spec.tsx
@@ -103,7 +103,7 @@ describe('ProjectAlerts -> TicketRuleModal', () => {
organization,
}
);
- expect(await screen.findByTestId('loading-indicator')).not.toBeInTheDocument();
+ await screen.findByRole('button', {name: 'Apply Changes'});
return wrapper;
};
diff --git a/static/app/components/frontendVersionContext.spec.tsx b/static/app/components/frontendVersionContext.spec.tsx
index c20fc7a3f65ef0..6e054b2810981d 100644
--- a/static/app/components/frontendVersionContext.spec.tsx
+++ b/static/app/components/frontendVersionContext.spec.tsx
@@ -1,4 +1,4 @@
-import {act, render, screen} from 'sentry-test/reactTestingLibrary';
+import {act, render, screen, waitFor} from 'sentry-test/reactTestingLibrary';
import * as constants from 'sentry/constants';
import {ConfigStore} from 'sentry/stores/configStore';
@@ -55,9 +55,11 @@ describe('FrontendVersionProvider', () => {
// Advance past the initial delay before version checking starts
act(() => jest.advanceTimersByTime(ONE_HOUR));
- expect(await screen.findByTestId('state')).toHaveTextContent('current');
- expect(await screen.findByTestId('deployed-version')).toHaveTextContent(commitSha);
- expect(await screen.findByTestId('running-version')).toHaveTextContent(commitSha);
+ await waitFor(() => {
+ expect(screen.getByTestId('state')).toHaveTextContent('current');
+ });
+ expect(screen.getByTestId('deployed-version')).toHaveTextContent(commitSha);
+ expect(screen.getByTestId('running-version')).toHaveTextContent(commitSha);
});
it('provides state="stale" when server version differs from current version', async () => {
@@ -79,13 +81,11 @@ describe('FrontendVersionProvider', () => {
// Advance past the initial delay before version checking starts
act(() => jest.advanceTimersByTime(ONE_HOUR));
- expect(await screen.findByTestId('state')).toHaveTextContent('stale');
- expect(await screen.findByTestId('deployed-version')).toHaveTextContent(
- serverVersion
- );
- expect(await screen.findByTestId('running-version')).toHaveTextContent(
- currentCommitSha
- );
+ await waitFor(() => {
+ expect(screen.getByTestId('state')).toHaveTextContent('stale');
+ });
+ expect(screen.getByTestId('deployed-version')).toHaveTextContent(serverVersion);
+ expect(screen.getByTestId('running-version')).toHaveTextContent(currentCommitSha);
});
it('provides state="unknown" when server returns null version', async () => {
diff --git a/static/app/components/onboarding/productSelection.tsx b/static/app/components/onboarding/productSelection.tsx
index f5431ba6941677..c678cce9a43667 100644
--- a/static/app/components/onboarding/productSelection.tsx
+++ b/static/app/components/onboarding/productSelection.tsx
@@ -432,6 +432,12 @@ export const platformProductAvailability = {
ProductSolution.LOGS,
ProductSolution.METRICS,
],
+ 'python-litestar': [
+ ProductSolution.PERFORMANCE_MONITORING,
+ ProductSolution.PROFILING,
+ ProductSolution.LOGS,
+ ProductSolution.METRICS,
+ ],
'python-gcpfunctions': [
ProductSolution.PERFORMANCE_MONITORING,
ProductSolution.PROFILING,
diff --git a/static/app/components/repositories/useBulkUpdateRepositorySettings.tsx b/static/app/components/repositories/useBulkUpdateRepositorySettings.tsx
index 114813e0f6c2dc..cab89cad70fb51 100644
--- a/static/app/components/repositories/useBulkUpdateRepositorySettings.tsx
+++ b/static/app/components/repositories/useBulkUpdateRepositorySettings.tsx
@@ -43,7 +43,7 @@ export function useBulkUpdateRepositorySettings(
});
},
...options,
- onSettled: (data, error, variables, context) => {
+ onSettled: (data, error, variables, onMutateResult, context) => {
queryClient.invalidateQueries({
queryKey: [`/organizations/${organization.slug}/repos/`],
});
@@ -52,7 +52,7 @@ export function useBulkUpdateRepositorySettings(
queryClient.invalidateQueries({queryKey});
queryClient.setQueryData(queryKey, [repo, undefined, undefined]);
});
- options?.onSettled?.(data, error, variables, context);
+ options?.onSettled?.(data, error, variables, onMutateResult, context);
},
});
}
diff --git a/static/app/components/searchQueryBuilder/askSeerCombobox/askSeerComboBox.tsx b/static/app/components/searchQueryBuilder/askSeerCombobox/askSeerComboBox.tsx
index a3959f5464d116..419a880bbdeb1c 100644
--- a/static/app/components/searchQueryBuilder/askSeerCombobox/askSeerComboBox.tsx
+++ b/static/app/components/searchQueryBuilder/askSeerCombobox/askSeerComboBox.tsx
@@ -154,8 +154,8 @@ export function AskSeerComboBox({
isError,
} = useMutation({
...props.askSeerMutationOptions,
- onError: (error, variables, context) => {
- props.askSeerMutationOptions.onError?.(error, variables, context);
+ onError: (error, variables, onMutateResult, context) => {
+ props.askSeerMutationOptions.onError?.(error, variables, onMutateResult, context);
addErrorMessage(t('Failed to process AI query: %(error)s', {error: error.message}));
},
});
diff --git a/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx b/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx
index ab8cdef9324ba4..ea17fb443d75f5 100644
--- a/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx
+++ b/static/app/components/searchQueryBuilder/tokens/filter/valueCombobox.tsx
@@ -399,6 +399,7 @@ function useFilterSuggestions({
const isDebouncing = baseQueryKey !== queryKey;
// TODO(malwilley): Display error states
+ // eslint-disable-next-line @tanstack/query/exhaustive-deps
const {data, isFetching} = useQuery({
queryKey,
queryFn: ctx => getTagValues(...ctx.queryKey[1]),
diff --git a/static/app/components/searchQueryBuilder/tokens/useSortedFilterKeyItems.tsx b/static/app/components/searchQueryBuilder/tokens/useSortedFilterKeyItems.tsx
index 69e29e805c17f1..b5f13e47207a65 100644
--- a/static/app/components/searchQueryBuilder/tokens/useSortedFilterKeyItems.tsx
+++ b/static/app/components/searchQueryBuilder/tokens/useSortedFilterKeyItems.tsx
@@ -178,8 +178,8 @@ export function useSortedFilterKeyItems({
// Async key fetching with debounce when getTagKeys is provided
const shouldFetchAsync = !!getTagKeys;
const debouncedFilterValue = useDebouncedValue(filterValue);
+ // eslint-disable-next-line @tanstack/query/exhaustive-deps
const {data: asyncKeys, isLoading: isQueryLoading} = useQuery({
- // eslint-disable-next-line @tanstack/query/exhaustive-deps
queryKey: ['search-query-builder-tag-keys', debouncedFilterValue],
queryFn: ctx => getTagKeys!(ctx.queryKey[1] ?? ''),
enabled: shouldFetchAsync,
diff --git a/static/app/data/forms/projectGeneralSettings.tsx b/static/app/data/forms/projectGeneralSettings.tsx
index e53f21434fbe14..a821257dec5093 100644
--- a/static/app/data/forms/projectGeneralSettings.tsx
+++ b/static/app/data/forms/projectGeneralSettings.tsx
@@ -167,6 +167,20 @@ export const fields = {
label: t('Enable JavaScript source fetching'),
help: t('Allow Sentry to scrape missing JavaScript source context when possible'),
},
+ scmSourceContextEnabled: {
+ name: 'scmSourceContextEnabled',
+ type: 'boolean',
+ label: t('Enable SCM Source Context'),
+ help: t(
+ "Fetch source code from your connected SCM integration (e.g. GitHub, GitLab) to display in stack traces. When enabled, any project member can view source code for files matched by this project's code mappings."
+ ),
+ visible: ({features}) => features.has('scm-source-context'),
+ confirm: {
+ true: t(
+ 'Enabling this will allow all members with access to this project to view source code from the connected SCM integration via code mappings. Are you sure you want to enable this?'
+ ),
+ },
+ },
securityToken: {
name: 'securityToken',
type: 'string',
diff --git a/static/app/data/platformCategories.tsx b/static/app/data/platformCategories.tsx
index 5792f74e567355..2eddce4e84d412 100644
--- a/static/app/data/platformCategories.tsx
+++ b/static/app/data/platformCategories.tsx
@@ -118,6 +118,7 @@ export const backend: PlatformKey[] = [
'python-falcon',
'python-fastapi',
'python-flask',
+ 'python-litestar',
'python-pylons',
'python-pymongo',
'python-pyramid',
@@ -384,6 +385,7 @@ export const withLoggingOnboarding = new Set([
'python-fastapi',
'python-flask',
'python-gcpfunctions',
+ 'python-litestar',
'python-pylons',
'python-pyramid',
'python-quart',
@@ -480,6 +482,7 @@ export const withMetricsOnboarding = new Set([
'python-fastapi',
'python-flask',
'python-gcpfunctions',
+ 'python-litestar',
'python-pyramid',
'python-quart',
'python-rq',
@@ -578,6 +581,7 @@ export const profiling: PlatformKey[] = [
'python-fastapi',
'python-flask',
'python-gcpfunctions',
+ 'python-litestar',
'python-pylons',
'python-pyramid',
'python-quart',
@@ -693,6 +697,7 @@ export const replayBackendPlatforms: readonly PlatformKey[] = [
'python-falcon',
'python-fastapi',
'python-flask',
+ 'python-litestar',
'python-pyramid',
'python-quart',
'python-sanic',
diff --git a/static/app/data/platformPickerCategories.tsx b/static/app/data/platformPickerCategories.tsx
index c7cb8aad3bd28b..c88566fdd745bf 100644
--- a/static/app/data/platformPickerCategories.tsx
+++ b/static/app/data/platformPickerCategories.tsx
@@ -103,6 +103,7 @@ const server = new Set([
'python-falcon',
'python-fastapi',
'python-flask',
+ 'python-litestar',
'python-pyramid',
'python-quart',
'python-rq',
diff --git a/static/app/data/platforms.tsx b/static/app/data/platforms.tsx
index ca144b10ff0e67..887a04db2e2882 100644
--- a/static/app/data/platforms.tsx
+++ b/static/app/data/platforms.tsx
@@ -625,6 +625,13 @@ export const platforms: PlatformIntegration[] = [
language: 'python',
link: 'https://docs.sentry.io/platforms/python/guides/flask/',
},
+ {
+ id: 'python-litestar',
+ name: 'Litestar',
+ type: 'framework',
+ language: 'python',
+ link: 'https://docs.sentry.io/platforms/python/integrations/litestar/',
+ },
{
id: 'python-gcpfunctions',
name: 'Google Cloud Functions (Python)',
diff --git a/static/app/gettingStartedDocs/apple-ios/logs.tsx b/static/app/gettingStartedDocs/apple-ios/logs.tsx
index dc0f9b2adc4af0..1452286ac61eb7 100644
--- a/static/app/gettingStartedDocs/apple-ios/logs.tsx
+++ b/static/app/gettingStartedDocs/apple-ios/logs.tsx
@@ -79,7 +79,7 @@ pod update`,
SentrySDK.start { options in
options.dsn = "${params.dsn.public}"
// Enable logs to be sent to Sentry
- options.experimental.enableLogs = true
+ options.enableLogs = true
}`,
},
{
@@ -90,7 +90,7 @@ SentrySDK.start { options in
[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
options.dsn = @"${params.dsn.public}";
// Enable logs to be sent to Sentry
- options.experimental.enableLogs = YES;
+ options.enableLogs = YES;
}];`,
},
],
diff --git a/static/app/gettingStartedDocs/apple-macos/logs.tsx b/static/app/gettingStartedDocs/apple-macos/logs.tsx
index da0816b6f39140..b7126428b08412 100644
--- a/static/app/gettingStartedDocs/apple-macos/logs.tsx
+++ b/static/app/gettingStartedDocs/apple-macos/logs.tsx
@@ -79,7 +79,7 @@ pod update`,
SentrySDK.start { options in
options.dsn = "${params.dsn.public}"
// Enable logs to be sent to Sentry
- options.experimental.enableLogs = true
+ options.enableLogs = true
}`,
},
{
@@ -90,7 +90,7 @@ SentrySDK.start { options in
[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
options.dsn = @"${params.dsn.public}";
// Enable logs to be sent to Sentry
- options.experimental.enableLogs = YES;
+ options.enableLogs = YES;
}];`,
},
],
diff --git a/static/app/gettingStartedDocs/python-litestar/index.tsx b/static/app/gettingStartedDocs/python-litestar/index.tsx
new file mode 100644
index 00000000000000..ac15cdf42754fe
--- /dev/null
+++ b/static/app/gettingStartedDocs/python-litestar/index.tsx
@@ -0,0 +1,27 @@
+import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types';
+import {
+ feedbackOnboardingJsLoader,
+ replayOnboardingJsLoader,
+} from 'sentry/gettingStartedDocs/javascript/jsLoader';
+import {agentMonitoring} from 'sentry/gettingStartedDocs/python/agentMonitoring';
+import {crashReport} from 'sentry/gettingStartedDocs/python/crashReport';
+import {featureFlag} from 'sentry/gettingStartedDocs/python/featureFlag';
+import {logs} from 'sentry/gettingStartedDocs/python/logs';
+import {mcp} from 'sentry/gettingStartedDocs/python/mcp';
+import {metrics} from 'sentry/gettingStartedDocs/python/metrics';
+import {profiling} from 'sentry/gettingStartedDocs/python/profiling';
+
+import {onboarding} from './onboarding';
+
+export const docs: Docs = {
+ onboarding,
+ replayOnboardingJsLoader,
+ profilingOnboarding: profiling(),
+ crashReportOnboarding: crashReport,
+ featureFlagOnboarding: featureFlag,
+ feedbackOnboardingJsLoader,
+ agentMonitoringOnboarding: agentMonitoring,
+ mcpOnboarding: mcp,
+ logsOnboarding: logs(),
+ metricsOnboarding: metrics(),
+};
diff --git a/static/app/gettingStartedDocs/python-litestar/onboarding.spec.tsx b/static/app/gettingStartedDocs/python-litestar/onboarding.spec.tsx
new file mode 100644
index 00000000000000..52297632b3d33b
--- /dev/null
+++ b/static/app/gettingStartedDocs/python-litestar/onboarding.spec.tsx
@@ -0,0 +1,132 @@
+import {OrganizationFixture} from 'sentry-fixture/organization';
+
+import {renderWithOnboardingLayout} from 'sentry-test/onboarding/renderWithOnboardingLayout';
+import {screen} from 'sentry-test/reactTestingLibrary';
+import {textWithMarkupMatcher} from 'sentry-test/utils';
+
+import {ProductSolution} from 'sentry/components/onboarding/gettingStartedDoc/types';
+
+import {docs} from '.';
+
+describe('litestar onboarding docs', () => {
+ it('renders doc correctly', () => {
+ renderWithOnboardingLayout(docs);
+
+ // Renders main headings
+ expect(screen.getByRole('heading', {name: 'Install'})).toBeInTheDocument();
+ expect(screen.getByRole('heading', {name: 'Configure SDK'})).toBeInTheDocument();
+ expect(screen.getByRole('heading', {name: 'Verify'})).toBeInTheDocument();
+ });
+
+ it('renders without tracing', () => {
+ renderWithOnboardingLayout(docs, {
+ selectedProducts: [],
+ });
+
+ // Does not render config option
+ expect(
+ screen.queryByText(textWithMarkupMatcher(/profiles_sample_rate=1\.0,/))
+ ).not.toBeInTheDocument();
+
+ // Does not render config option
+ expect(
+ screen.queryByText(textWithMarkupMatcher(/traces_sample_rate=1\.0,/))
+ ).not.toBeInTheDocument();
+ });
+
+ it('renders transaction profiling', () => {
+ renderWithOnboardingLayout(docs);
+
+ // Does not render continuous profiling config
+ expect(
+ screen.queryByText(textWithMarkupMatcher(/profile_session_sample_rate=1\.0,/))
+ ).not.toBeInTheDocument();
+ expect(
+ screen.queryByText(textWithMarkupMatcher(/profile_lifecycle="trace",/))
+ ).not.toBeInTheDocument();
+
+ // Does render transaction profiling config
+ const matches = screen.getAllByText(
+ textWithMarkupMatcher(/profiles_sample_rate=1\.0,/)
+ );
+ expect(matches.length).toBeGreaterThan(0);
+ matches.forEach(match => expect(match).toBeInTheDocument());
+ });
+
+ it('renders continuous profiling', () => {
+ const organization = OrganizationFixture({
+ features: ['continuous-profiling'],
+ });
+
+ renderWithOnboardingLayout(
+ docs,
+ {},
+ {
+ organization,
+ }
+ );
+
+ // Does not render transaction profiling config
+ expect(
+ screen.queryByText(textWithMarkupMatcher(/profiles_sample_rate=1\.0,/))
+ ).not.toBeInTheDocument();
+
+ // Does render continuous profiling config
+ const sampleRateMatches = screen.getAllByText(
+ textWithMarkupMatcher(/profile_session_sample_rate=1\.0,/)
+ );
+ expect(sampleRateMatches.length).toBeGreaterThan(0);
+ sampleRateMatches.forEach(match => expect(match).toBeInTheDocument());
+ const lifecycleMatches = screen.getAllByText(
+ textWithMarkupMatcher(/profile_lifecycle="trace",/)
+ );
+ expect(lifecycleMatches.length).toBeGreaterThan(0);
+ lifecycleMatches.forEach(match => expect(match).toBeInTheDocument());
+ });
+
+ it('renders with logs', () => {
+ renderWithOnboardingLayout(docs, {
+ selectedProducts: [ProductSolution.LOGS],
+ });
+
+ const logMatches = screen.getAllByText(textWithMarkupMatcher(/enable_logs=True,/));
+ expect(logMatches.length).toBeGreaterThan(0);
+ logMatches.forEach(match => expect(match).toBeInTheDocument());
+ });
+
+ it('renders without logs', () => {
+ renderWithOnboardingLayout(docs, {
+ selectedProducts: [],
+ });
+
+ expect(
+ screen.queryByText(textWithMarkupMatcher(/enable_logs=True,/))
+ ).not.toBeInTheDocument();
+ });
+
+ it('renders metrics configuration when metrics are selected', () => {
+ renderWithOnboardingLayout(docs, {
+ selectedProducts: [ProductSolution.METRICS],
+ });
+
+ // Renders metrics verification steps
+ expect(
+ screen.getByText(
+ 'Send test metrics from your app to verify metrics are arriving in Sentry.'
+ )
+ ).toBeInTheDocument();
+ });
+
+ it('renders without metrics configuration when metrics are not selected', () => {
+ renderWithOnboardingLayout(docs, {
+ selectedProducts: [],
+ });
+
+ // Does not render metrics verification steps
+ expect(
+ screen.queryByText(
+ 'Send test metrics from your app to verify metrics are arriving in Sentry.'
+ )
+ ).not.toBeInTheDocument();
+ });
+});
diff --git a/static/app/gettingStartedDocs/python-litestar/onboarding.tsx b/static/app/gettingStartedDocs/python-litestar/onboarding.tsx
new file mode 100644
index 00000000000000..67bef7e077f9e8
--- /dev/null
+++ b/static/app/gettingStartedDocs/python-litestar/onboarding.tsx
@@ -0,0 +1,163 @@
+import {ExternalLink} from '@sentry/scraps/link';
+
+import {
+ StepType,
+ type DocsParams,
+ type OnboardingConfig,
+} from 'sentry/components/onboarding/gettingStartedDoc/types';
+import {logsVerify} from 'sentry/gettingStartedDocs/python/logs';
+import {metricsVerify} from 'sentry/gettingStartedDocs/python/metrics';
+import {alternativeProfiling} from 'sentry/gettingStartedDocs/python/profiling';
+import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/utils';
+import {t, tct} from 'sentry/locale';
+
+const getSdkSetupSnippet = (params: DocsParams) => `
+import sentry_sdk
+
+sentry_sdk.init(
+ dsn="${params.dsn.public}",
+ # Add data like request headers and IP for users,
+ # see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info
+ send_default_pii=True,${
+ params.isLogsSelected
+ ? `
+ # Enable sending logs to Sentry
+ enable_logs=True,`
+ : ''
+ }${
+ 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'
+ ? `
+ # Set profile_session_sample_rate to 1.0 to profile 100%
+ # of profile sessions.
+ profile_session_sample_rate=1.0,
+ # Set profile_lifecycle to "trace" to automatically
+ # run the profiler on when there is an active transaction
+ profile_lifecycle="trace",`
+ : ''
+ }
+)
+`;
+
+export const onboarding: OnboardingConfig = {
+ introduction: () =>
+ tct('The Litestar integration adds support for the [link:Litestar Web Framework].', {
+ link: ,
+ }),
+ install: () => [
+ {
+ type: StepType.INSTALL,
+ content: [
+ {
+ type: 'text',
+ text: tct('Install [code:sentry-sdk] from PyPI:', {
+ code: