Skip to content

feat(api): Tag view.response metrics with ApiOwner when available #89

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(api): Tag view.response metrics with ApiOwner when available #89

Show file tree
Hide file tree
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
11 changes: 11 additions & 0 deletions src/sentry/middleware/stats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ def _record_time(request: Request, status_code: int) -> None:
getattr(request, "rate_limit_metadata", None), "rate_limit_type", None
)

# Extract owner from the Endpoint class if available
owner = "unknown"
if request.resolver_match is not None:
view_func = request.resolver_match.func
view_class = getattr(view_func, "cls", None)
if view_class is not None:
owner_enum = getattr(view_class, "owner", None)
if owner_enum is not None:
owner = owner_enum.value
Comment on lines +78 to +79
Copy link

@propel-test-bot propel-test-bot bot Oct 24, 2025

Choose a reason for hiding this comment

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

[BestPractice]

Owner extraction logic is missing error handling. If view_class.owner exists but owner_enum.value throws an AttributeError (e.g., if owner isn't an enum), this will cause a runtime exception:

if owner_enum is not None:
    try:
        owner = owner_enum.value
    except AttributeError:
        owner = str(owner_enum)  # Fallback for non-enum values
Context for Agents 
[**BestPractice**]

Owner extraction logic is missing error handling. If `view_class.owner` exists but `owner_enum.value` throws an AttributeError (e.g., if `owner` isn't an enum), this will cause a runtime exception:

```python
if owner_enum is not None:
    try:
        owner = owner_enum.value
    except AttributeError:
        owner = str(owner_enum)  # Fallback for non-enum values
```

File: src/sentry/middleware/stats.py
Line: 79


tags = {
"method": request.method,
"status_code": status_code,
Expand All @@ -76,6 +86,7 @@ def _record_time(request: Request, status_code: int) -> None:
getattr(rate_limit_type, "value", None) if rate_limit_type else None
),
"url_name": url_name,
"owner": owner,
}
metrics.incr("view.response", instance=view_path, tags=tags, skip_internal=False)

Expand Down
42 changes: 41 additions & 1 deletion tests/sentry/middleware/test_stats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from django.urls.base import resolve
from rest_framework.permissions import AllowAny

from sentry.api.api_owners import ApiOwner
from sentry.api.base import Endpoint
from sentry.middleware.ratelimit import RatelimitMiddleware
from sentry.middleware.stats import RequestTimingMiddleware
Expand All @@ -25,6 +26,14 @@ def get(self):
raise NotImplementedError


class OwnedEndpoint(Endpoint):
permission_classes = (AllowAny,)
owner = ApiOwner.ISSUES

def get(self):
raise NotImplementedError


class RequestTimingMiddlewareTest(TestCase):
middleware = cached_property(RequestTimingMiddleware)

Expand All @@ -50,6 +59,7 @@ def test_records_default_api_metrics(self, incr: MagicMock) -> None:
"ui_request": False,
"rate_limit_type": None,
"url_name": "sentry",
"owner": "unknown",
},
skip_internal=False,
)
Expand All @@ -61,7 +71,9 @@ def test_records_default_api_metrics_with_rate_limit_type(self, incr: MagicMock)
test_endpoint = RateLimitedEndpoint.as_view()
request = self.factory.get("/")
request._view_path = "/"
request.resolver_match = resolve("/")
request.resolver_match = Mock()
request.resolver_match.func = test_endpoint
request.resolver_match.url_name = "sentry"
response = Mock(status_code=429)

rate_limit_middleware.process_view(request, test_endpoint, [], {})
Expand All @@ -76,6 +88,7 @@ def test_records_default_api_metrics_with_rate_limit_type(self, incr: MagicMock)
"ui_request": False,
"rate_limit_type": "fixed_window",
"url_name": "sentry",
"owner": "unowned",
},
skip_internal=False,
)
Expand All @@ -101,6 +114,33 @@ def test_records_ui_request(self, incr: MagicMock) -> None:
"ui_request": True,
"rate_limit_type": None,
"url_name": "unreachable-unknown",
"owner": "unknown",
},
skip_internal=False,
)

@patch("sentry.utils.metrics.incr")
def test_records_endpoint_owner(self, incr: MagicMock) -> None:
test_endpoint = OwnedEndpoint.as_view()
request = self.factory.get("/")
request._view_path = "/"
request.resolver_match = Mock()
request.resolver_match.func = test_endpoint
request.resolver_match.url_name = "test-endpoint"
response = Mock(status_code=200)

self.middleware.process_response(request, response)

incr.assert_called_with(
"view.response",
instance=request._view_path,
tags={
"method": "GET",
"status_code": 200,
"ui_request": False,
"rate_limit_type": None,
"url_name": "test-endpoint",
"owner": "issue-workflow",
},
skip_internal=False,
)