Skip to content

The open alternative to Salesforce, designed for AI.

Reduce non-AI Sentry trace sampling (#24511)

Raphaël Bosied6bfd46454c
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
index 24b3f45ec45..9a5194269ef 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
@@ -1889,6 +1889,7 @@ type Sentry {
environment: String
release: String
dsn: String
+ tracesSampleRate: Float
}
type Captcha {
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.ts b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
index a59f130d57f..610b01ebeee 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
@@ -1541,6 +1541,7 @@ export interface Sentry {
environment?: Scalars['String']
release?: Scalars['String']
dsn?: Scalars['String']
+ tracesSampleRate?: Scalars['Float']
__typename: 'Sentry'
}
@@ -4846,6 +4847,7 @@ export interface SentryGenqlSelection{
environment?: boolean | number
release?: boolean | number
dsn?: boolean | number
+ tracesSampleRate?: boolean | number
__typename?: boolean | number
__scalar?: boolean | number
}
diff --git a/packages/twenty-client-sdk/src/metadata/generated/types.ts b/packages/twenty-client-sdk/src/metadata/generated/types.ts
index e472a407796..f4c6726cf55 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/types.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/types.ts
@@ -3653,6 +3653,9 @@ export default {
"dsn": [
1
],
+ "tracesSampleRate": [
+ 15
+ ],
"__typename": [
1
]
diff --git a/packages/twenty-front/src/generated-metadata/graphql.ts b/packages/twenty-front/src/generated-metadata/graphql.ts
index 83a53d9966b..c3994afc3b1 100644
--- a/packages/twenty-front/src/generated-metadata/graphql.ts
+++ b/packages/twenty-front/src/generated-metadata/graphql.ts
@@ -5437,6 +5437,7 @@ export type Sentry = {
dsn?: Maybe<Scalars['String']['output']>;
environment?: Maybe<Scalars['String']['output']>;
release?: Maybe<Scalars['String']['output']>;
+ tracesSampleRate?: Maybe<Scalars['Float']['output']>;
};
export type SetAppKeyValueInput = {
diff --git a/packages/twenty-front/src/modules/client-config/hooks/useClientConfig.ts b/packages/twenty-front/src/modules/client-config/hooks/useClientConfig.ts
index 9a15580efcc..b231b8650e4 100644
--- a/packages/twenty-front/src/modules/client-config/hooks/useClientConfig.ts
+++ b/packages/twenty-front/src/modules/client-config/hooks/useClientConfig.ts
@@ -190,6 +190,7 @@ export const useClientConfig = (): UseClientConfigResult => {
dsn: clientConfig?.sentry?.dsn,
release: clientConfig?.sentry?.release,
environment: clientConfig?.sentry?.environment,
+ tracesSampleRate: clientConfig?.sentry?.tracesSampleRate,
});
setCaptcha({
diff --git a/packages/twenty-front/src/modules/client-config/utils/__tests__/clientConfigUtils.test.ts b/packages/twenty-front/src/modules/client-config/utils/__tests__/clientConfigUtils.test.ts
index 0851a3238ec..0cb66ede8e1 100644
--- a/packages/twenty-front/src/modules/client-config/utils/__tests__/clientConfigUtils.test.ts
+++ b/packages/twenty-front/src/modules/client-config/utils/__tests__/clientConfigUtils.test.ts
@@ -29,6 +29,7 @@ const mockClientConfig = {
environment: 'development',
release: '1.0.0',
dsn: undefined,
+ tracesSampleRate: 0.1,
},
captcha: {
provider: undefined,
diff --git a/packages/twenty-front/src/modules/error-handler/components/SentryInitEffect.tsx b/packages/twenty-front/src/modules/error-handler/components/SentryInitEffect.tsx
index 89883526763..41026bb7f28 100644
--- a/packages/twenty-front/src/modules/error-handler/components/SentryInitEffect.tsx
+++ b/packages/twenty-front/src/modules/error-handler/components/SentryInitEffect.tsx
@@ -2,6 +2,7 @@ import { currentUserState } from '@/auth/states/currentUserState';
import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { sentryConfigState } from '@/client-config/states/sentryConfigState';
+import { DEFAULT_SENTRY_TRACES_SAMPLE_RATE } from '@/error-handler/constants/DefaultSentryTracesSampleRate';
import { SENTRY_REPLAY_IGNORE_MUTATIONS_ATTRIBUTE } from '@/error-handler/constants/SentryReplayIgnoreMutationsAttribute';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useEffect, useState } from 'react';
@@ -58,7 +59,9 @@ export const SentryInitEffect = () => {
'localhost:3001',
REACT_APP_SERVER_BASE_URL,
],
- tracesSampleRate: 1.0,
+ tracesSampleRate:
+ sentryConfig?.tracesSampleRate ??
+ DEFAULT_SENTRY_TRACES_SAMPLE_RATE,
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
});
diff --git a/packages/twenty-front/src/modules/error-handler/constants/DefaultSentryTracesSampleRate.ts b/packages/twenty-front/src/modules/error-handler/constants/DefaultSentryTracesSampleRate.ts
new file mode 100644
index 00000000000..f9247c9155c
--- /dev/null
+++ b/packages/twenty-front/src/modules/error-handler/constants/DefaultSentryTracesSampleRate.ts
@@ -0,0 +1 @@
+export const DEFAULT_SENTRY_TRACES_SAMPLE_RATE = 0.1;
diff --git a/packages/twenty-server/.env.example b/packages/twenty-server/.env.example
index 66182e06ac6..b697319c1bb 100644
--- a/packages/twenty-server/.env.example
+++ b/packages/twenty-server/.env.example
@@ -47,6 +47,9 @@ FRONTEND_URL=http://localhost:3001
# SENTRY_ENVIRONMENT=main
# SENTRY_DSN=https://[email protected]/xxx
# SENTRY_FRONT_DSN=https://[email protected]/xxx
+# SENTRY_FRONT_TRACES_SAMPLE_RATE=0.1
+# SENTRY_TRACES_SAMPLE_RATE=0.1
+# SENTRY_PROFILES_SAMPLE_RATE=0.01
# APPLICATION_LOG_DRIVER=CONSOLE
# LOG_LEVELS=error,warn
# SERVER_URL=http://localhost:3000
diff --git a/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts b/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts
index bab4cc65a74..89c01032d47 100644
--- a/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/client-config/client-config.controller.spec.ts
@@ -78,6 +78,7 @@ describe('ClientConfigController', () => {
environment: 'development',
release: '1.0.0',
dsn: undefined,
+ tracesSampleRate: 0.1,
},
captcha: {
provider: undefined,
diff --git a/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts b/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts
index 770aaa05145..2b0f090671d 100644
--- a/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts
+++ b/packages/twenty-server/src/engine/core-modules/client-config/client-config.entity.ts
@@ -191,6 +191,9 @@ export class Sentry {
@Field(() => String, { nullable: true })
dsn?: string;
+
+ @Field(() => Number, { nullable: true })
+ tracesSampleRate?: number;
}
@ObjectType()
diff --git a/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts b/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts
index 0d3e13a5ee0..139ea020a82 100644
--- a/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/client-config/services/client-config.service.ts
@@ -220,6 +220,9 @@ export class ClientConfigService {
environment: this.twentyConfigService.get('SENTRY_ENVIRONMENT'),
release: this.twentyConfigService.get('APP_VERSION'),
dsn: this.twentyConfigService.get('SENTRY_FRONT_DSN'),
+ tracesSampleRate: this.twentyConfigService.get(
+ 'SENTRY_FRONT_TRACES_SAMPLE_RATE',
+ ),
},
captcha: {
provider: captchaProvider ? captchaProvider : undefined,
diff --git a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
index 7cf519c4dbc..3da500f3bd3 100644
--- a/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
+++ b/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts
@@ -11,6 +11,7 @@ import {
IsOptional,
IsString,
IsUrl,
+ Max,
ValidateIf,
type ValidationError,
validateSync,
@@ -1199,6 +1200,39 @@ export class ConfigVariables {
@IsOptional()
SENTRY_ENVIRONMENT: string;
+ @ConfigVariablesMetadata({
+ group: ConfigVariablesGroup.LOGGING,
+ description:
+ 'Share of front-end traces sent to Sentry, between 0 and 1. Front-end traces propagate their sampling decision to the server, so this also drives the rate for browser-originated server traces.',
+ type: ConfigVariableType.NUMBER,
+ })
+ @CastToPositiveNumber()
+ @Max(1)
+ @IsOptional()
+ SENTRY_FRONT_TRACES_SAMPLE_RATE = 0.1;
+
+ @ConfigVariablesMetadata({
+ group: ConfigVariablesGroup.LOGGING,
+ description:
+ 'Share of server traces sent to Sentry, between 0 and 1. Browser-originated traces inherit the front-end decision instead, and AI traces are always sampled at 1. Read before the config store is available, so it cannot be overridden from the database.',
+ type: ConfigVariableType.NUMBER,
+ isEnvOnly: true,
+ })
+ @CastToPositiveNumber()
+ @IsOptional()
+ SENTRY_TRACES_SAMPLE_RATE = 0.1;
+
+ @ConfigVariablesMetadata({
+ group: ConfigVariablesGroup.LOGGING,
+ description:
+ 'Share of sampled server traces that are also profiled, between 0 and 1. Read before the config store is available, so it cannot be overridden from the database.',
+ type: ConfigVariableType.NUMBER,
+ isEnvOnly: true,
+ })
+ @CastToPositiveNumber()
+ @IsOptional()
+ SENTRY_PROFILES_SAMPLE_RATE = 0.01;
+
@ConfigVariablesMetadata({
group: ConfigVariablesGroup.LOGGING,
description:
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run.service.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run.service.ts
index 0995fbeb645..6ec9c5469dc 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run.service.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/services/agent-run.service.ts
@@ -17,6 +17,7 @@ import { AgentAsyncExecutorService } from 'src/engine/metadata-modules/ai/ai-age
import { type RunAsWorkspaceMemberContext } from 'src/engine/metadata-modules/ai/ai-agent-execution/types/run-as-workspace-member-context.type';
import { AGENT_RUN_BASE_SYSTEM_PROMPT } from 'src/engine/metadata-modules/ai/ai-agent/constants/agent-run-base-system-prompt.const';
import { AgentEntity } from 'src/engine/metadata-modules/ai/ai-agent/entities/agent.entity';
+import { withDedicatedAiTrace } from 'src/engine/metadata-modules/ai/ai-models/utils/with-dedicated-ai-trace.util';
import {
AiException,
AiExceptionCode,
@@ -118,8 +119,8 @@ export class AgentRunService {
};
try {
- const executionResult = await this.agentAsyncExecutorService.executeAgent(
- {
+ const executionResult = await withDedicatedAiTrace(() =>
+ this.agentAsyncExecutorService.executeAgent({
agent,
messages,
baseSystemPrompt: AGENT_RUN_BASE_SYSTEM_PROMPT,
@@ -131,7 +132,7 @@ export class AgentRunService {
runAsRoleId: runAsContext?.roleId,
operationType: UsageOperationType.AI_WORKFLOW_TOKEN,
toolLoadingStrategy: 'lazy',
- },
+ }),
);
if (executionResult.hasNoMoreAvailableCredits) {
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-generate-text/controllers/ai-generate-text.controller.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-generate-text/controllers/ai-generate-text.controller.ts
index 5874a6f3511..36efb5284fc 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-generate-text/controllers/ai-generate-text.controller.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-generate-text/controllers/ai-generate-text.controller.ts
@@ -22,6 +22,7 @@ import { AiRestApiExceptionFilter } from 'src/engine/metadata-modules/ai/filters
import { GenerateTextInput } from 'src/engine/metadata-modules/ai/ai-generate-text/dtos/generate-text.input';
import { AiModelRegistryService } from 'src/engine/metadata-modules/ai/ai-models/services/ai-model-registry.service';
import { buildAiTelemetry } from 'src/engine/metadata-modules/ai/ai-models/utils/build-ai-telemetry.util';
+import { withDedicatedAiTrace } from 'src/engine/metadata-modules/ai/ai-models/utils/with-dedicated-ai-trace.util';
import { PermissionsRestApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-rest-api-exception.filter';
@Controller(`${ApiPath.Rest}/ai`)
@@ -69,16 +70,18 @@ export class AiGenerateTextController {
let result: Awaited<ReturnType<typeof generateText>> | undefined;
try {
- result = await generateText({
- model: registeredModel.model,
- system: body.systemPrompt,
- prompt: body.userPrompt,
- experimental_telemetry: buildAiTelemetry({
- functionId: 'ai-generate-text',
- workspaceId: workspace.id,
- userWorkspaceId,
+ result = await withDedicatedAiTrace(() =>
+ generateText({
+ model: registeredModel.model,
+ system: body.systemPrompt,
+ prompt: body.userPrompt,
+ experimental_telemetry: buildAiTelemetry({
+ functionId: 'ai-generate-text',
+ workspaceId: workspace.id,
+ userWorkspaceId,
+ }),
}),
- });
+ );
return {
text: result.text,
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-models/utils/with-dedicated-ai-trace.util.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-models/utils/with-dedicated-ai-trace.util.ts
new file mode 100644
index 00000000000..7f7655b621c
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-models/utils/with-dedicated-ai-trace.util.ts
@@ -0,0 +1,8 @@
+import * as Sentry from '@sentry/node';
+
+// Sentry only runs tracesSampler on root spans, so ai.* spans reach the 100%
+// sampling rule only when they start their own trace instead of inheriting an
+// HTTP or GraphQL trace that head sampling already dropped.
+export const withDedicatedAiTrace = <TResult>(
+ callback: () => TResult,
+): TResult => Sentry.startNewTrace(callback);