From 64b63d59699cf9eeed9f1499eb7d728a11dccc42 Mon Sep 17 00:00:00 2001
From: Akhil Narang <me@akhilnarang.dev>
Date: Wed, 27 Dec 2023 11:01:52 +0530
Subject: [PATCH] fix(sentry): don't set context if not enabled

Signed-off-by: Akhil Narang <me@akhilnarang.dev>
---
 frappe/hooks.py        | 11 +++++--
 frappe/utils/sentry.py | 75 ++++++++++++++++++++++++------------------
 2 files changed, 52 insertions(+), 34 deletions(-)

diff --git a/frappe/hooks.py b/frappe/hooks.py
index de4254584f..e82714389b 100644
--- a/frappe/hooks.py
+++ b/frappe/hooks.py
@@ -1,3 +1,5 @@
+import os
+
 from . import __version__ as app_version
 
 app_name = "frappe"
@@ -422,14 +424,19 @@ before_request = [
 	"frappe.recorder.record",
 	"frappe.monitor.start",
 	"frappe.rate_limiter.apply",
-	"frappe.utils.sentry.set_sentry_context",
 ]
 
 # Background Job Hooks
 before_job = [
 	"frappe.monitor.start",
-	"frappe.utils.sentry.set_sentry_context",
 ]
+
+if os.getenv("FRAPPE_SENTRY_DSN") and (
+	os.getenv("ENABLE_SENTRY_DB_MONITORING") or os.getenv("SENTRY_TRACING_SAMPLE_RATE")
+):
+	before_request.append("frappe.utils.sentry.set_sentry_context")
+	before_job.append("frappe.utils.sentry.set_sentry_context")
+
 after_job = [
 	"frappe.monitor.stop",
 	"frappe.utils.file_lock.release_document_locks",
diff --git a/frappe/utils/sentry.py b/frappe/utils/sentry.py
index bcc6a3ab4b..5486b47ef1 100644
--- a/frappe/utils/sentry.py
+++ b/frappe/utils/sentry.py
@@ -4,7 +4,6 @@ from datetime import datetime
 
 import rq
 from sentry_sdk import capture_message as sentry_capture_message
-from sentry_sdk import configure_scope
 from sentry_sdk.hub import Hub
 from sentry_sdk.integrations import Integration
 from sentry_sdk.integrations.wsgi import _make_wsgi_event_processor
@@ -48,41 +47,49 @@ class FrappeIntegration(Integration):
 		Database.sql = sql
 
 
-def set_sentry_context():
-	with configure_scope() as scope:
-		if job := rq.get_current_job():
-			kwargs = job._kwargs
-			transaction_name = str(kwargs["method"])
-			context = frappe._dict({"scheduled": False, "wait": 0})
-			if "run_scheduled_job" in transaction_name:
-				transaction_name = kwargs.get("kwargs", {}).get("job_type", "")
-				context.scheduled = True
+def set_scope(scope):
+	if job := rq.get_current_job():
+		kwargs = job._kwargs
+		transaction_name = str(kwargs["method"])
+		context = frappe._dict({"scheduled": False, "wait": 0})
+		if "run_scheduled_job" in transaction_name:
+			transaction_name = kwargs.get("kwargs", {}).get("job_type", "")
+			context.scheduled = True
 
-			waitdiff = datetime.utcnow() - job.enqueued_at
-			context.uuid = job.id
-			context.wait = waitdiff.total_seconds()
+		waitdiff = datetime.utcnow() - job.enqueued_at
+		context.uuid = job.id
+		context.wait = waitdiff.total_seconds()
 
-			scope.set_extra("job", context)
-			scope.set_transaction_name(transaction_name)
+		scope.set_extra("job", context)
+		scope.set_transaction_name(transaction_name)
+	else:
+		if frappe.form_dict.cmd:
+			path = f"/api/method/{frappe.form_dict.cmd}"
 		else:
-			if frappe.form_dict.cmd:
-				path = f"/api/method/{frappe.form_dict.cmd}"
-			else:
-				path = frappe.request.path
+			path = frappe.request.path
 
-			scope.set_transaction_name(
-				path,
-				source=SOURCE_FOR_STYLE["endpoint"],
-			)
+		scope.set_transaction_name(
+			path,
+			source=SOURCE_FOR_STYLE["endpoint"],
+		)
 
-		scope.set_tag("site", frappe.local.site)
-		user = getattr(frappe.session, "user", "Unidentified")
-		if "@" not in user:
-			user = f"{user}@{frappe.local.site}"
-		scope.set_user({"id": user, "email": user})
-		# Extract `X-Frappe-Request-ID` to store as a separate field if its present
-		if trace_id := frappe.monitor.get_trace_id():
-			scope.set_tag("frappe_trace_id", trace_id)
+	scope.set_tag("site", frappe.local.site)
+	user = getattr(frappe.session, "user", "Unidentified")
+	if "@" not in user:
+		user = f"{user}@{frappe.local.site}"
+	scope.set_user({"id": user, "email": user})
+	# Extract `X-Frappe-Request-ID` to store as a separate field if its present
+	if trace_id := frappe.monitor.get_trace_id():
+		scope.set_tag("frappe_trace_id", trace_id)
+
+
+def set_sentry_context():
+	if not frappe.get_system_settings("enable_telemetry"):
+		return
+
+	hub = Hub.current
+	with hub.configure_scope() as scope:
+		set_scope(scope)
 
 
 def before_send(event, hint):
@@ -102,9 +109,13 @@ def capture_exception(message: str | None = None) -> None:
 		return
 	try:
 		hub = Hub.current
-
 		if frappe.request:
 			with hub.configure_scope() as scope:
+				if (
+					os.getenv("ENABLE_SENTRY_DB_MONITORING") is None
+					or os.getenv("SENTRY_TRACING_SAMPLE_RATE") is None
+				):
+					set_scope(scope)
 				evt_processor = _make_wsgi_event_processor(frappe.request.environ, False)
 				scope.add_event_processor(evt_processor)