Skip to content
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

Add Sentry Events/Metrics for ParallelVerification #655

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Add Sentry Events/Metrics for ParallelVerification #655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 18 additions & 26 deletions tasks/parallel_verification.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import copy
import json
import logging

import sentry_sdk
from shared.celery_config import parallel_verification_task_name

from app import celery_app
Expand Down Expand Up @@ -96,9 +96,7 @@
# top level totals comparison (ignoring session total, index 9)
parallel_tlt = list(parallel_report.totals.astuple())
serial_tlt = list(serial_report.totals.astuple())
parallel_tlt[9] = (
0 # 9th index is session total for shared.reports.types.ReportTotals
)
parallel_tlt[9] = 0
serial_tlt[9] = 0
if parallel_tlt != serial_tlt:
top_level_totals_match = False
Expand Down Expand Up @@ -147,6 +145,22 @@
extra=logging_context,
)

is_success = top_level_totals_match and file_level_totals_match
sentry_sdk.metrics.incr(
"parallel_verification.comparisons",
tags={"result": "success" if is_success else "failure"},
)
if not is_success:
with sentry_sdk.new_scope() as scope:
if file_level_mismatched_files:
scope.set_extra("mismatched_files", file_level_mismatched_files)
if not top_level_totals_match:
scope.set_extra("parallel_totals", parallel_report.totals.astuple())
scope.set_extra("serial_totals", serial_report.totals.astuple())
sentry_sdk.capture_message(

Check warning on line 160 in tasks/parallel_verification.py

View check run for this annotation

Codecov Notifications / codecov/patch

tasks/parallel_verification.py#L154-L160 

Added lines #L154 - L160 were not covered by tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does this sort of thing show up on the Sentry UI? Would this be considered an error?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shows up in the issues list, but it is not considered an error.

"Parallel upload processing verification failed"
)


def parallel_path_to_serial_path(parallel_path, last_upload_pk):
parallel_paths = parallel_path.split("/")
Expand All @@ -160,28 +174,6 @@
return serial_path


# To filter out values not relevant for verifying report content correctness. We
# don't want these values to be the reason why there exists a diff, since it's
# not actually related to coverage report contents
def sort_and_stringify_report_json(data):
data = copy.deepcopy(data)
for session_id in data["sessions"].keys():
data["sessions"][session_id].pop("d", None) # remove timestamp
data["sessions"][session_id].pop("e", None) # remove env
data["sessions"][session_id].pop("p", None) # remove state
data["sessions"][session_id].pop("se", None) # remove session extras
if data["sessions"][session_id]["f"] is None: # flags formatting
data["sessions"][session_id]["f"] = []

# round the coverage precentage to 2 decimals (because we're inconsistent somewhere)
if "t" in data["sessions"][session_id]:
data["sessions"][session_id]["t"][5] = str(
round(float(data["sessions"][session_id]["t"][5]), 2)
)

return json.dumps(data, sort_keys=True)


RegisteredParallelVerificationTask = celery_app.register_task(
ParallelVerificationTask()
)
Expand Down
Loading