Superset API function write logs but not for FAB API

[xavier-GitHub76]

When I use a superset API function, log is written

But when I use a FAB API function, log is not written :

[dosubot[bot]]

Superset API endpoints write logs because they use explicit logging decorators like @event_logger.log_this_with_context on their API methods. These decorators capture request and user context and write entries to the action log interface, which is why you see logs for endpoints like /api/v1/dashboard/ reference.

FAB API endpoints (such as /api/v1/security/users/) do not log actions by default because they lack these decorators. Logging is not automatic for FAB APIs; you need to add it manually. The recommended, upgrade-safe way is to either:

• Decorate the relevant CRUD methods (like post, put, delete) in your FAB API class with @event_logger.log_this_with_context, or
• Subclass the relevant FAB ModelView (for example, UserDBModelView) and override hooks like after_model_create, after_model_change, and after_model_delete to call the event logger. These hooks run after the transaction is committed, so they avoid transaction errors and have access to the request context reference.

Here’s a concrete example for a custom FAB API endpoint:

from flask import g, request
from superset.extensions import event_logger
from flask_appbuilder.security.views import UserDBModelView

class CustomUserDBModelView(UserDBModelView):
    def after_model_create(self, model):
        actor = getattr(g, "user", None)
        ip_address = request.headers.get("X-Forwarded-For", request.remote_addr)
        event_logger.log(
            user_id=actor.id if actor else None,
            action="user_create",
            records=[{
                "actor_username": getattr(actor, "username", None),
                "target_username": getattr(model, "username", None),
                "ip_address": ip_address,
                "details": "User created",
            }],
            referrer=ip_address,
        )
    # Repeat for after_model_change and after_model_delete

Or, for an API method:

from superset.extensions import event_logger

class CustomUserRestApi(UserRestApi):
    @event_logger.log_this_with_context(action="user_create", log_to_statsd=False)
    def post(self):
        response = super().post()
        # Optionally add extra audit details here
        return response

This will ensure your FAB API actions are logged in the Superset action log UI. Let me know if you want more details or help with a specific endpoint!

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}