How do I log filtered GET requests on a Django REST Framework ModelViewSet using @action?

Question

I have a ModelViewSet for EventReportLink and need to log every time someone queries with ?event_report__id=<id>. I’ve tried adding a custom @action(detail=False, methods=['get']), but I’m not sure if I’m implementing it correctly or if there’s a better way.

I added:

@action(detail=False, methods=['get'], url_path='log-test')
def log_test(self, request):
    event_report_id = request.query_params.get('event_report__id')
    logger.info(f"ID: {event_report_id}")
    queryset = self.filter_queryset(self.get_queryset())
    serializer = self.get_serializer(queryset, many=True)
    return Response(serializer.data)

Expecting logs and correct filtering results. I’m receiving filtered results but not sure if this is best practice. What would be a more idiomatic approach?

P.S. I also consulted this related question, which discusses how to add behavior before/after the default create logic using super().create(request). However, I wasn’t entirely sure if it applies to my case with query param filtering and logging via @action, so I’m still exploring best practices.

I accessed the endpoint via api_path.../eventreportlinks/log-test/?event_report__id=22776064. This correctly triggered the action and returned the expected results with logging. However, my main goal is to use @action to override or extend the default behavior of the list (GET), create, and other standard methods to insert custom logging or processing logic while still preserving the default behavior of these actions. — Raul Chiarella
– Raul Chiarella, Commented Jun 30 at 19:24

Nick ODell · Accepted Answer · 2025-06-30 21:37:24Z

0

It seems like the simplest approach would be to look at the function you want to add logging for, then write a function with the same name and call the superclass to trigger the existing behavior.

For example, you want to hook the list method of your ModelViewSet, which is defined inside the ListModelMixin.

You could write that method within your view set like this:

    def list(self, request, *args, **kwargs):
        event_report_id = request.query_params.get('event_report__id')
        logger.info(f"ID: {event_report_id}")
        return super().list(request, *args, **kwargs)

answered Jun 30 at 21:37

Nick ODell

28k7 gold badges52 silver badges93 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Raul Chiarella Jul 4 at 21:06

Super worked but I did'nt like that I had to call for list everytime I wanted this log, so I ended up using @actions.

Collectives™ on Stack Overflow

How do I log filtered GET requests on a Django REST Framework ModelViewSet using @action?

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related