Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

feat(api): enrich Sentry with profiling and user attribution

justin4797756a7211
diff --git a/.env.sample b/.env.sample
index d83e6364b..bc4afb315 100644
--- a/.env.sample
+++ b/.env.sample
@@ -79,6 +79,9 @@ SMTP_REQUIRE_TLS=
# Sentry error tracking (Optional): errors are only reported when a DSN is set
# SENTRY_DSN=
# SENTRY_ENVIRONMENT=production
+# SENTRY_TRACES_SAMPLE_RATE=0.1 # 0.0 disables; default 0 (opt-in)
+# SENTRY_PROFILES_SAMPLE_RATE=0.1 # 0.0 disables; default 0 (opt-in)
+# SENTRY_RELEASE= # git SHA; ties events to source maps. Falls back to package.json version.
# Kaneo Cloud billing via Creem (Optional): only active when KANEO_CLOUD=true
# and both keys are set. Self-hosted installs leave these empty; billing stays off.
diff --git a/apps/api/package.json b/apps/api/package.json
index 3c96f6195..31bfdc1e9 100644
--- a/apps/api/package.json
+++ b/apps/api/package.json
@@ -44,7 +44,8 @@
"@oslojs/crypto": "^1.0.1",
"@oslojs/encoding": "^1.1.0",
"@paralleldrive/cuid2": "^3.3.0",
- "@sentry/node": "^10.69.0",
+ "@sentry/node": "^10.70.0",
+ "@sentry/profiling-node": "^10.70.0",
"@valibot/to-json-schema": "^1.7.1",
"bcryptjs": "^3.0.2",
"better-auth": "^1.6.26",
diff --git a/apps/api/src/instrument.ts b/apps/api/src/instrument.ts
index 13cbce55e..c9a715efb 100644
--- a/apps/api/src/instrument.ts
+++ b/apps/api/src/instrument.ts
@@ -1,10 +1,15 @@
import { readFileSync } from "node:fs";
import * as Sentry from "@sentry/node";
+import { nodeProfilingIntegration } from "@sentry/profiling-node";
const tracesSampleRate = Number.parseFloat(
process.env.SENTRY_TRACES_SAMPLE_RATE ?? "",
);
+const profilesSampleRate = Number.parseFloat(
+ process.env.SENTRY_PROFILES_SAMPLE_RATE ?? "",
+);
+
function readAppVersion() {
try {
const pkg = JSON.parse(
@@ -24,5 +29,9 @@ if (process.env.SENTRY_DSN) {
release: process.env.SENTRY_RELEASE ?? readAppVersion(),
sendDefaultPii: false,
tracesSampleRate: Number.isFinite(tracesSampleRate) ? tracesSampleRate : 0,
+ profilesSampleRate: Number.isFinite(profilesSampleRate)
+ ? profilesSampleRate
+ : 0,
+ integrations: [nodeProfilingIntegration()],
});
}
diff --git a/apps/api/src/utils/authenticate-api-request.ts b/apps/api/src/utils/authenticate-api-request.ts
index 97ee4bf2f..b8c6718e3 100644
--- a/apps/api/src/utils/authenticate-api-request.ts
+++ b/apps/api/src/utils/authenticate-api-request.ts
@@ -1,9 +1,19 @@
+import * as Sentry from "@sentry/node";
import { APIError } from "better-auth/api";
import type { Context } from "hono";
import { HTTPException } from "hono/http-exception";
import { auth } from "../auth";
import { verifyApiKey } from "./verify-api-key";
+// ponytail: Sentry's user scope is per-process in @sentry/node. Concurrent
+// requests from different users can race the per-context user id. The proper
+// fix is to wrap each request in Sentry.runWithAsyncContext, which requires
+// wiring AsyncLocalStorage through Hono's middleware chain. Tagging here is
+// best-effort attribution; do not rely on it for cross-user filtering.
+function attachUserToScope(userId: string) {
+ Sentry.setUser({ id: userId });
+}
+
function isAuthRejection(error: unknown) {
if (!(error instanceof APIError)) {
return false;
@@ -76,6 +86,7 @@ export async function authenticateApiRequest(c: Context): Promise<void> {
enabled: key.enabled,
permissions: key.permissions,
});
+ attachUserToScope(key.userId);
return;
}
@@ -93,6 +104,7 @@ export async function authenticateApiRequest(c: Context): Promise<void> {
enabled: key.enabled,
permissions: key.permissions,
});
+ attachUserToScope(key.userId);
return;
}
const sessionResult = await getSessionFromBearerOnlyHeaders(c);
@@ -101,6 +113,7 @@ export async function authenticateApiRequest(c: Context): Promise<void> {
c.set("session", sessionResult.session);
c.set("userId", sessionResult.user.id);
c.set("userEmail", sessionResult.user.email ?? "");
+ attachUserToScope(sessionResult.user.id);
return;
}
throw new HTTPException(401, { message: "Unauthorized" });
@@ -115,6 +128,8 @@ export async function authenticateApiRequest(c: Context): Promise<void> {
if (!sessionResult?.user) {
throw new HTTPException(401, { message: "Unauthorized" });
}
+
+ attachUserToScope(sessionResult.user.id);
}
export async function resolveAssetBearerOrCookie(c: Context): Promise<{
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 3923eb9a5..ee5eb681f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -120,8 +120,11 @@ importers:
specifier: ^3.3.0
version: 3.3.0
'@sentry/node':
- specifier: ^10.69.0
- version: 10.69.0(@opentelemetry/[email protected](@opentelemetry/[email protected]))
+ specifier: ^10.70.0
+ version: 10.70.0(@opentelemetry/[email protected](@opentelemetry/[email protected]))
+ '@sentry/profiling-node':
+ specifier: ^10.70.0
+ version: 10.70.0(@opentelemetry/[email protected](@opentelemetry/[email protected]))
'@valibot/to-json-schema':
specifier: ^1.7.1
@@ -3516,12 +3519,16 @@ packages:
resolution: {integrity: sha512-+uuqVEeiDzYuAKjZLqsROKXvRTbl/QeH0gfGRtpYib1cud4rAFWRIkFmcR7Jb7JGFYwmReyQotiTj/hcDszTZg==}
engines: {node: '>=18'}
+ '@sentry/[email protected]':
+ resolution: {integrity: sha512-ozhCTDqg89oB4XmWfAwuHshABpvT7AkRpaPnogopPfMAaI61G1t8EKCJ4W7aum8JSBonlfyjPCyW5oYZFm0KvA==}
+ engines: {node: '>=18'}
+
'@sentry/[email protected]':
resolution: {integrity: sha512-qrGz5Qaw93/IhMjlFN6uIaXeHwgHDaKGa6FkTAP6PonpkvSbGGqan6xfsENxzj9HUVoli1lZ6tMRDnt2qtSPhg==}
engines: {node: '>=18'}
- '@sentry/[email protected]':
- resolution: {integrity: sha512-IgArHczrZJxkgxoffHscj0NxQrG6kCazgmGQnlf3j58J1ec21YaUu8Tu+7G4Lo5tCiW3teQnwlKW1ttMXSqWRw==}
+ '@sentry/[email protected]':
+ resolution: {integrity: sha512-oPOEVVNxv5WHtckx2i06Wi9FLWyvOg/1DUeX732jZ4iqT2nupINaMH4nF4f4kSvUThFnxkFSRQxwqOxgzMKhKA==}
engines: {node: '>=18'}
peerDependencies:
'@opentelemetry/api': ^1.9.0
@@ -3541,18 +3548,27 @@ packages:
'@opentelemetry/sdk-trace-base':
optional: true
- '@sentry/[email protected]':
- resolution: {integrity: sha512-xEXA1YGIiTZbrW6MWV34uS6JGQuQg2ijTI0zed+FsJb9JZKPYel/GZK8Km26vfTVb+yCXFmWZNBesKegNcVdzg==}
+ '@sentry/[email protected]':
+ resolution: {integrity: sha512-18g/yJKRUk4PNcnZYEPyT2nS+9UoFcTRrIrct1DbpfI7k//RtQ+8araZrR0WH5MT8xoiLCm67GEX/RcxDsI0iQ==}
+ engines: {node: '>=18'}
+
+ '@sentry/[email protected]':
+ resolution: {integrity: sha512-SPOOVxmKTVIEtqvOKkQT163e/pOwucjS7OPsCHyRs8sFR4nfBNu0EThplyqnvqd5BWBMTPH6WTBQfo+QWHV+HA==}
engines: {node: '>=18'}
- '@sentry/[email protected]':
- resolution: {integrity: sha512-3FyWV6YcEJuvLrlaKGE1dHXCI+1YO0a62w7PkwlRg8yp6K6YXkmdwu9GjqaYD+Ju4tm7uC7mHIsGFQMm0M7pqQ==}
+ '@sentry/[email protected]':
+ resolution: {integrity: sha512-UNV/2tqypcUK6FDzerAsFJn1Km/c4VZCYkUZDNbnV5S0cwAq2BYKMo4M5vovaLDBQlxA+Wk9ovbxi5wYjjl9fw==}
engines: {node: '>=18'}
peerDependencies:
'@opentelemetry/api': ^1.9.0
'@opentelemetry/core': ^1.30.1 || ^2.1.0
'@opentelemetry/sdk-trace-base': ^1.30.1 || ^2.1.0
+ '@sentry/[email protected]':
+ resolution: {integrity: sha512-bOL1nd+t6H4dHM2BB768Thm26UXBxIqBORIMr7nM+QLID+6DjHRcknRZbyklGNUVzAggsprzQ3f61i2xdRmTEA==}
+ engines: {node: '>=18'}
+ hasBin: true
+
'@sentry/[email protected]':
resolution: {integrity: sha512-f0Il/JMteHjdWPNZQB3rtp1Pcj2Leb3p0KSZuv3rh0EUril9CbWtQVy5zJhoAppi+MWWmgRWa+6BpHbQf+ABQA==}
engines: {node: '>=18'}
@@ -3567,8 +3583,8 @@ packages:
resolution: {integrity: sha512-uRhmNhtFGPOlM0iniVmWKAX3KVXI0le41yYK/iKdPjinT9jA3ZrmykO/Fv1v/KI5znOtwa9D6eHRnDTTMRxFrg==}
engines: {node: '>=18'}
- '@sentry/[email protected]':
- resolution: {integrity: sha512-0MwHrA8+nNvMIsqf8m3cXwCBlUjr6AS7N6CZvHJtY1DkqEvQqEbD5VIrhzEyHN/KMZIgQ8XeDCQRhjnXFQGRhg==}
+ '@sentry/[email protected]':
+ resolution: {integrity: sha512-rzegZjMFFgCp3o+N8+XU13rfSvz4B+f8rU0ijBGrQcHdMNyfsFDTu1UTm262JofmrV2u+s+D0u0vFTnqtOGkbA==}
engines: {node: '>=18'}
'@shikijs/[email protected]':
@@ -6737,6 +6753,10 @@ packages:
sass:
optional: true
+ resolution: {integrity: sha512-W5ZNO5KRPB5TkYmGVD9F6YqhsglXJzE6etpbmT+f6EQElhiX/UTG551cnsRGvLG3fyZEg9HwaDmNmj5nwJ4z9g==}
+ engines: {node: '>=10'}
+
resolution: {integrity: sha512-g9yhqoedzIUm0nTnTqAQvueMPVOuIY16bqgAJJC8XOOubYFNwz6IER9qs0Gq2Xd0+CecCKFjtdDTMA4u4xG06Q==}
@@ -10820,15 +10840,19 @@ snapshots:
dependencies:
'@sentry/conventions': 0.16.0
+ '@sentry/[email protected]':
+ dependencies:
+ '@sentry/conventions': 0.16.0
+
'@sentry/[email protected]':
dependencies:
'@sentry/core': 10.69.0
- '@sentry/[email protected](@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))':
+ '@sentry/[email protected](@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))':
dependencies:
'@sentry/conventions': 0.16.0
- '@sentry/core': 10.69.0
- '@sentry/opentelemetry': 10.69.0(@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))
+ '@sentry/core': 10.70.0
+ '@sentry/opentelemetry': 10.70.0(@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))
import-in-the-middle: 3.3.3
optionalDependencies:
'@opentelemetry/api': 1.9.1
@@ -10836,29 +10860,44 @@ snapshots:
'@opentelemetry/instrumentation': 0.220.0(@opentelemetry/[email protected])
'@opentelemetry/sdk-trace-base': 2.10.0(@opentelemetry/[email protected])
- '@sentry/[email protected](@opentelemetry/[email protected](@opentelemetry/[email protected]))':
+ '@sentry/[email protected]':
+ dependencies:
+ detect-libc: 2.1.2
+ node-abi: 3.94.0
+
+ '@sentry/[email protected](@opentelemetry/[email protected](@opentelemetry/[email protected]))':
dependencies:
'@opentelemetry/api': 1.9.1
'@opentelemetry/instrumentation': 0.220.0(@opentelemetry/[email protected])
'@opentelemetry/sdk-trace-base': 2.10.0(@opentelemetry/[email protected])
'@sentry/conventions': 0.16.0
- '@sentry/core': 10.69.0
- '@sentry/node-core': 10.69.0(@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))
- '@sentry/opentelemetry': 10.69.0(@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))
- '@sentry/server-utils': 10.69.0
+ '@sentry/core': 10.70.0
+ '@sentry/node-core': 10.70.0(@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))
+ '@sentry/opentelemetry': 10.70.0(@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))
+ '@sentry/server-utils': 10.70.0
import-in-the-middle: 3.3.3
transitivePeerDependencies:
- '@opentelemetry/core'
- '@opentelemetry/exporter-trace-otlp-http'
- supports-color
- '@sentry/[email protected](@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))':
+ '@sentry/[email protected](@opentelemetry/[email protected])(@opentelemetry/[email protected](@opentelemetry/[email protected]))(@opentelemetry/[email protected](@opentelemetry/[email protected]))':
dependencies:
'@opentelemetry/api': 1.9.1
'@opentelemetry/core': 2.10.0(@opentelemetry/[email protected])
'@opentelemetry/sdk-trace-base': 2.10.0(@opentelemetry/[email protected])
'@sentry/conventions': 0.16.0
- '@sentry/core': 10.69.0
+ '@sentry/core': 10.70.0
+
+ '@sentry/[email protected](@opentelemetry/[email protected](@opentelemetry/[email protected]))':
+ dependencies:
+ '@sentry/core': 10.70.0
+ '@sentry/node': 10.70.0(@opentelemetry/[email protected](@opentelemetry/[email protected]))
+ '@sentry/node-cpu-profiler': 2.4.3
+ transitivePeerDependencies:
+ - '@opentelemetry/core'
+ - '@opentelemetry/exporter-trace-otlp-http'
+ - supports-color
dependencies:
@@ -10877,12 +10916,12 @@ snapshots:
'@sentry/browser-utils': 10.69.0
'@sentry/core': 10.69.0
- '@sentry/[email protected]':
+ '@sentry/[email protected]':
dependencies:
'@apm-js-collab/code-transformer-bundler-plugins': 0.7.3
'@apm-js-collab/tracing-hooks': 0.13.0
'@sentry/conventions': 0.16.0
- '@sentry/core': 10.69.0
+ '@sentry/core': 10.70.0
meriyah: 6.1.4
transitivePeerDependencies:
- supports-color
@@ -13977,6 +14016,10 @@ snapshots:
- '@types/node'
- babel-plugin-macros
+ dependencies:
+ semver: 7.8.5
+
optional: true