Logging

Event Logging

Superset by default logs special action events in its internal database (DBEventLogger). These logs can be accessed on the UI by navigating to Security > Action Log. You can freely customize these logs by implementing your own event log class. When custom log class is enabled DBEventLogger is disabled and logs stop being populated in UI logs view. To achieve both, custom log class should extend built-in DBEventLogger log class.

Here’s an example of a simple JSON-to-stdout class:

  1.     def log(self, user_id, action, *args, **kwargs):
  2.         records = kwargs.get('records', list())
  3.         dashboard_id = kwargs.get('dashboard_id')
  4.         slice_id = kwargs.get('slice_id')
  5.         duration_ms = kwargs.get('duration_ms')
  6.         referrer = kwargs.get('referrer')
  8.         for record in records:
  9.             log = dict(
  10.                 action=action,
  11.                 json=record,
  12.                 dashboard_id=dashboard_id,
  13.                 slice_id=slice_id,
  14.                 duration_ms=duration_ms,
  15.                 referrer=referrer,
  16.                 user_id=user_id
  17.             )
  18.             print(json.dumps(log))

End by updating your config to pass in an instance of the logger you want to use:

  1. EVENT_LOGGER = JSONStdOutEventLogger()

StatsD Logging

Superset can be instrumented to log events to StatsD if desired. Most endpoints hit are logged as well as key events like query start and end in SQL Lab.

To setup StatsD logging, it’s a matter of configuring the logger in your superset_config.py.

  1. from superset.stats_logger import StatsdStatsLogger
  2. STATS_LOGGER = StatsdStatsLogger(host='localhost', port=8125, prefix='superset')

Note that it’s also possible to implement your own logger by deriving superset.stats_logger.BaseStatsLogger.