Skip to content

chore(prevent): Add temp logs for overwatch webhook forwarder #102994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 7, 2025
Merged

chore(prevent): Add temp logs for overwatch webhook forwarder #102994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8936c99
chore(prevent): Add temp logs for overwatch webhook forwarder
suejung-sentry Nov 7, 2025
01230ef
use info level and fix when region_name not defined
suejung-sentry Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/sentry/middleware/integrations/parsers/github.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,13 @@ def get_response(self) -> HttpResponseBase:
if codecov_regions:
self.try_forward_to_codecov(event=event)

logger.info(
"overwatch.debug.forward_if_applicable.begin",
extra={
"headers_keys": list(self.request.headers.keys()),
"integration_id": integration.id,
},
)
# The overwatch forwarder implements its own region-based checks
OverwatchGithubWebhookForwarder(integration=integration).forward_if_applicable(
event=event, headers=self.request.headers
Expand Down
73 changes: 73 additions & 0 deletions src/sentry/overwatch_webhooks/webhook_forwarder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,23 @@ def _get_org_summaries_by_region_for_integration(
org_integrations = OrganizationIntegration.objects.filter(
integration=integration, status=ObjectStatus.ACTIVE
)
logger.info(
"overwatch.debug.org_integrations.fetched",
extra={
"integration_id": integration.id,
"org_integration_ids": [oi.organization_id for oi in org_integrations],
"count": len(org_integrations),
},
)
organization_ids = [org_integration.organization_id for org_integration in org_integrations]
org_mappings = OrganizationMapping.objects.filter(organization_id__in=organization_ids)
logger.info(
"overwatch.debug.org_mappings.fetched",
extra={
"org_mapping_ids": [om.organization_id for om in org_mappings],
"count": len(org_mappings),
},
)
org_mappings_by_id = {
org_mapping.organization_id: org_mapping for org_mapping in org_mappings
}
Expand All @@ -71,37 +86,87 @@ def _get_org_summaries_by_region_for_integration(
organization_mapping=org_mapping,
)
)
logger.info(
"overwatch.debug.organizations.grouped_by_region",
extra={
"region_name": region_name,
"org_id": org_integration.organization_id,
},
)

logger.info(
"overwatch.debug.org_contexts_by_region.final",
extra={
"regions": list(org_contexts_by_region.keys()),
"counts_per_region": {k: len(v) for k, v in org_contexts_by_region.items()},
},
)

return org_contexts_by_region

def forward_if_applicable(self, event: Mapping[str, Any], headers: Mapping[str, str]):
region_name = None
try:
enabled_regions = options.get("overwatch.enabled-regions")
logger.info(
"overwatch.debug.enabled_regions", extra={"enabled_regions": enabled_regions}
)
if not enabled_regions:
# feature isn't enabled, no work to do
logger.info("overwatch.debug.excluded.feature_not_enabled", extra={})
return

orgs_by_region = self._get_org_summaries_by_region_for_integration(
integration=self.integration
)
logger.info(
"overwatch.debug.orgs_by_region",
extra={
"regions": list(orgs_by_region.keys()),
"counts_per_region": {k: len(v) for k, v in orgs_by_region.items()},
},
)

if not orgs_by_region or not self.should_forward_to_overwatch(headers):
logger.info(
"overwatch.debug.skipped_forwarding",
extra={
"orgs_by_region_empty": not orgs_by_region,
"event_in_forward_list": self.should_forward_to_overwatch(headers),
},
)
return

# We can conditionally opt into forwarding on a per-region basis,
# similar to codecov's current implementation.
for region_name, org_summaries in orgs_by_region.items():
logger.info(
"overwatch.debug.check_region",
extra={
"region_name": region_name,
"enabled": region_name in enabled_regions,
"org_summaries_count": len(org_summaries),
},
)
if region_name not in enabled_regions:
continue

raw_app_id = headers.get(
GITHUB_INSTALLATION_TARGET_ID_HEADER,
) or headers.get(DJANGO_HTTP_GITHUB_INSTALLATION_TARGET_ID_HEADER)
logger.info(
"overwatch.debug.raw_app_id",
extra={"region_name": region_name, "raw_app_id": raw_app_id},
)
app_id: int | None = None
if raw_app_id is not None:
try:
app_id = int(raw_app_id)
except (TypeError, ValueError):
logger.info(
"overwatch.debug.app_id_parse_error",
extra={"region_name": region_name, "raw_app_id": raw_app_id},
)
app_id = None

webhook_detail = WebhookDetails(
Expand All @@ -112,17 +177,25 @@ def forward_if_applicable(self, event: Mapping[str, Any], headers: Mapping[str,
region=region_name,
app_id=app_id,
)
logger.info(
"overwatch.debug.webhook_detail.created",
extra={"region_name": region_name, "app_id": app_id},
)

publisher = OverwatchWebhookPublisher(
integration_provider=self.integration.provider,
region=get_region_by_name(region_name),
)
logger.info("overwatch.debug.enqueue_webhook", extra={"region_name": region_name})
publisher.enqueue_webhook(webhook_detail)
metrics.incr(
"overwatch.forward-webhooks.success",
sample_rate=1.0,
tags={"forward_region": region_name},
)
logger.info(
"overwatch.debug.metrics_incr.success", extra={"region_name": region_name}
)
except Exception:
metrics.incr(
"overwatch.forward-webhooks.forward-error",
Expand Down
Loading