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.

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

feat(performance) Add related issues endpoint #18344

Merged
merged 6 commits into from
Apr 24, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
63 changes: 63 additions & 0 deletions src/sentry/api/endpoints/organization_events_meta.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
from __future__ import absolute_import

import six
from django.conf import settings

from rest_framework.response import Response
from rest_framework.exceptions import ParseError

from sentry.api.base import EnvironmentMixin
from sentry.api.bases import OrganizationEventsEndpointBase, OrganizationEventsError, NoProjects
from sentry.api.helpers.group_index import build_query_params_from_request
from sentry.api.event_search import parse_search_query
from sentry.api.serializers import serialize
from sentry.api.serializers.models.group import GroupSerializer
from sentry.search.snuba.backend import EventsDatasetSnubaSearchBackend
from sentry.snuba import discover


IssueSeach = EventsDatasetSnubaSearchBackend(**settings.SENTRY_SEARCH_OPTIONS)
Copy link
Member

Choose a reason for hiding this comment

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

Generally we don't build specific backends, and use the search proxy instead.

from sentry import search
results = search.query(...)

I saw that this is also being done the way you have it in OrganizationGroupIndex. Perhaps @iProgramStuff knows why we're using a specific backend there?



class OrganizationEventsMetaEndpoint(OrganizationEventsEndpointBase):
def get(self, request, organization):
try:
Expand All @@ -29,3 +39,56 @@ def get(self, request, organization):
raise ParseError(detail=six.text_type(err))

return Response({"count": result["data"][0]["count"]})


class OrganizationEventsRelatedIssuesEndpoint(OrganizationEventsEndpointBase, EnvironmentMixin):
def get(self, request, organization):
try:
params = self.get_filter_params(request, organization)
except OrganizationEventsError as e:
return Response({"detail": six.text_type(e)}, status=400)
except NoProjects:
return Response([])

possible_keys = ["transaction"]
lookup_keys = {key: request.query_params.get(key) for key in possible_keys}

if not any(lookup_keys.values()):
return Response(
{
"detail": "Must provide one of {} in order to find related events".format(
possible_keys
)
},
status=400,
)

try:
projects = self.get_projects(request, organization)
query_kwargs = build_query_params_from_request(
request, organization, projects, params["environment"]
)
query_kwargs["limit"] = 5
try:
parsed_terms = parse_search_query(
'transaction:"{}"'.format(lookup_keys["transaction"])
evanh marked this conversation as resolved.
Show resolved Hide resolved
)
except ParseError:
return Response({"detail": "Invalid transaction search"}, status=400)

if query_kwargs.get("search_filters"):
query_kwargs["search_filters"].extend(parsed_terms)
else:
query_kwargs["search_filters"] = parsed_terms

results = IssueSeach.query(**query_kwargs)
except discover.InvalidSearchQuery as err:
raise ParseError(detail=six.text_type(err))

context = serialize(
list(results),
request.user,
GroupSerializer(environment_func=self._get_environment_func(request, organization.id)),
)

return Response(context)
10 changes: 9 additions & 1 deletion src/sentry/api/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,10 @@
from .endpoints.organization_eventid import EventIdLookupEndpoint
from .endpoints.organization_events import OrganizationEventsEndpoint, OrganizationEventsV2Endpoint
from .endpoints.organization_events_facets import OrganizationEventsFacetsEndpoint
from .endpoints.organization_events_meta import OrganizationEventsMetaEndpoint
from .endpoints.organization_events_meta import (
OrganizationEventsMetaEndpoint,
OrganizationEventsRelatedIssuesEndpoint,
)
from .endpoints.organization_events_stats import OrganizationEventsStatsEndpoint
from .endpoints.organization_group_index import OrganizationGroupIndexEndpoint
from .endpoints.organization_incident_activity_index import (
Expand Down Expand Up @@ -675,6 +678,11 @@
KeyTransactionStatsEndpoint.as_view(),
name="sentry-api-0-organization-key-transactions-stats",
),
url(
r"^(?P<organization_slug>[^\/]+)/related-issues/$",
OrganizationEventsRelatedIssuesEndpoint.as_view(),
name="sentry-api-0-organization-related-issues",
),
# Dashboards
url(
r"^(?P<organization_slug>[^\/]+)/dashboards/$",
Expand Down
133 changes: 133 additions & 0 deletions tests/snuba/api/endpoints/test_organization_events_meta.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,136 @@ def test_transaction_event_with_last_seen(self):

assert response.status_code == 200, response.content
assert response.data["count"] == 1


class OrganizationEventsRelatedIssuesEndpoint(APITestCase, SnubaTestCase):
def setUp(self):
super(OrganizationEventsRelatedIssuesEndpoint, self).setUp()

def test_find_related_issue(self):
self.login_as(user=self.user)

project = self.create_project()
event1 = self.store_event(
data={"timestamp": iso_format(before_now(minutes=1)), "transaction": "/beth/sanchez"},
project_id=project.id,
)

url = reverse(
"sentry-api-0-organization-related-issues",
kwargs={"organization_slug": project.organization.slug},
)
response = self.client.get(url, {"transaction": "/beth/sanchez"}, format="json")

assert response.status_code == 200, response.content
assert len(response.data) == 1
assert response.data[0]["shortId"] == event1.group.qualified_short_id
assert int(response.data[0]["id"]) == event1.group_id

def test_related_issues_no_transaction(self):
self.login_as(user=self.user)

project = self.create_project()
self.store_event(
data={"timestamp": iso_format(before_now(minutes=1)), "transaction": "/beth/sanchez"},
project_id=project.id,
)

url = reverse(
"sentry-api-0-organization-related-issues",
kwargs={"organization_slug": project.organization.slug},
)
response = self.client.get(url, format="json")

assert response.status_code == 400, response.content
assert (
response.data["detail"]
== "Must provide one of ['transaction'] in order to find related events"
)

def test_related_issues_no_matching_groups(self):
self.login_as(user=self.user)

project = self.create_project()
self.store_event(
data={"timestamp": iso_format(before_now(minutes=1)), "transaction": "/beth/sanchez"},
project_id=project.id,
)

url = reverse(
"sentry-api-0-organization-related-issues",
kwargs={"organization_slug": project.organization.slug},
)
response = self.client.get(url, {"transaction": "/morty/sanchez"}, format="json")

assert response.status_code == 200, response.content
assert len(response.data) == 0

def test_related_issues_only_issues_in_date(self):
self.login_as(user=self.user)

project = self.create_project()
self.store_event(
data={
"event_id": "a" * 32,
"timestamp": iso_format(before_now(days=2)),
"transaction": "/beth/sanchez",
},
project_id=project.id,
)
event2 = self.store_event(
data={
"event_id": "b" * 32,
"timestamp": iso_format(before_now(minutes=1)),
"transaction": "/beth/sanchez",
},
project_id=project.id,
)

url = reverse(
"sentry-api-0-organization-related-issues",
kwargs={"organization_slug": project.organization.slug},
)
response = self.client.get(
url, {"transaction": "/beth/sanchez", "statsPeriod": "24h"}, format="json"
)

assert response.status_code == 200, response.content
assert len(response.data) == 1
assert response.data[0]["shortId"] == event2.group.qualified_short_id
assert int(response.data[0]["id"]) == event2.group_id

def test_related_issues_transactions_from_different_projects(self):
self.login_as(user=self.user)

project1 = self.create_project()
project2 = self.create_project()
event1 = self.store_event(
data={
"event_id": "a" * 32,
"timestamp": iso_format(before_now(minutes=1)),
"transaction": "/beth/sanchez",
},
project_id=project1.id,
)
self.store_event(
data={
"event_id": "b" * 32,
"timestamp": iso_format(before_now(minutes=1)),
"transaction": "/beth/sanchez",
},
project_id=project2.id,
)

url = reverse(
"sentry-api-0-organization-related-issues",
kwargs={"organization_slug": project1.organization.slug},
)
response = self.client.get(
url, {"transaction": "/beth/sanchez", "project": project1.id}, format="json",
)

assert response.status_code == 200, response.content
assert len(response.data) == 1
assert response.data[0]["shortId"] == event1.group.qualified_short_id
assert int(response.data[0]["id"]) == event1.group_id