eox-audit-model

Maintainance Status GitHub Actions Workflow Test Status PyPI - Version

Eox-audit-model is a Django application designed to provide an audit model for tracking and logging changes within the Open edX platform. This plugin saves information in the database about executed methods, creating a detailed audit trail of various operations. Developed as part of the Edunext Open edX Extensions (EOX), eox-audit-model assists administrators and developers in maintaining comprehensive monitoring and ensuring better oversight of the platform’s activities.

Features

Detailed Audit Logging: Capture comprehensive logs of method executions, including parameters, results, and any generated logs.
Automatic Traceback Capture: Automatically log traceback information if an exception occurs during method execution.
User Tracking: Record the user who initiated the method, providing accountability and traceability.
Flexible Logging Mechanisms: Log actions either by directly calling a method or using a decorator for convenience.
Customizable Notes: Add custom notes to logs for additional context and information.
Comprehensive Monitoring: Maintain an extensive audit trail for better monitoring and oversight of platform activities.

Installation

Install eox-audit-model in Tutor with OPENEDX_EXTRA_PIP_REQUIREMENTS` setting in the config.yml:
```
OPENEDX_EXTRA_PIP_REQUIREMENTS:
   - eox-audit-model=={{version}}
```

Add eox_audit_model to INSTALLED_APPS`, you can create a Tutor plugin, e.g.:

from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
   (
      "openedx-lms-common-settings",
      "settings.INSTALLED_APPS.append('eox_audit_model.apps.EoxAuditModelConfig')"
   )
)

Save the configuration with tutor config save.
Build the image and launch your platform with tutor local launch.

Compatibility notes

Open edX Release	Version
Juniper	>=0.2, <0.4
Koa	>=0.4, <=0.7
Lilac	>=0.4, <=0.7
Maple	>=0.7, <1.0
Nutmeg	>=1.0, <5.0
Olive	>=2.0, <5.0
Palm	>=3.0, <5.0
Quince	>=4.0, <6.0
Redwood	>=4.2.0
Sumac	>=5.1.0
Teak	>=6.0.0

Ulmo	>=6.1.0

Verawood	>=6.2.0

Usage

Eox-audit-model can be used to audit any execution of a method or function. This will create a database record with the following information:

Status: If the process was successful or not.
Action: The given string to identify the process.
Timestamp: The execute date.
Method name: Method or function name.
Captured log: Logs generated in the execution.
Traceback log: If there is an exception, this will contain the traceback.
Site: Current site.
Performer: The user who started the method; depends on the request.user.
Input: The values used to execute the method.
Output: The value returned by the method.
Ip: Current IP.

There are two primary ways to use the plugin:

Direct Method Call

You can log an action directly by importing the model and calling the execute_action method. This method requires several parameters to log the information:

action: A string describing the action, e.g., ‘Add view info’.
method: The method being executed.
parameters: A dictionary containing positional arguments (args) and keyword arguments (kwargs).
notes: An optional list of dictionaries for storing custom information.

Example:

from eox_audit_model.models import AuditModel

def any_method(parameter1, parameter2, parameter3):
  """Do something"""
  return 'Success'

def audit_process():
  """Execute audit process"""
  action = "This is a simple action"
  parameters = {
    "args": (2, 6),
    "kwargs": {"parameter3": 9},
  }

  expected_value = AuditModel.execute_action(action, any_method, parameters)
  ...

Using the Decorator

The plugin also provides a decorator that can be used to log method executions automatically. The decorator handles calling the execute_action method behind the scenes and saves the information for you.

Example:

from eox_audit_model.decorators import audit_method

@audit_method(action="This is a simple action")
def any_method(parameter1, parameter2, parameter3):
  """Do something"""
  return 'Success'

def audit_process():
  """Execute audit process"""
  expected_value = any_method(3, 6, 9)
  ...

License

This software is licensed under the terms of the AGPLv3. See the LICENSE file for details.

Metadata

Release files for eox-audit-model 6.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eox-audit-model 6.2.0
File	Size	Uploaded
eox_audit_model-6.2.0.tar.gz	30.5 kB	Jun 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for eox-audit-model 6.2.0
File	Interpreter	ABI	Platform	Reset
eox_audit_model-6.2.0-py3-none-any.whl 32.2 kB Jun 30, 2026	Python 3	none	any	Details

Total release size: 62.8 kB

Release files / eox_audit_model-6.2.0.tar.gz

Download URL	eox_audit_model-6.2.0.tar.gz
Size	30.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`c6eaff31267c40e8ca3359fe871038e71c77c846a465172e384cce31d99c3b2b`
BLAKE2b-256 checksum How to use checksums	`72e9dbccee55a93a9bf9f47d5948853c474ab8520797f905594f4475a4e2fe78`
Upload date	Jun 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.7`

Release files / eox_audit_model-6.2.0-py3-none-any.whl

Download URL	eox_audit_model-6.2.0-py3-none-any.whl
Size	32.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`633e79aa939ed81a5c2fb67f732f6233a2d39b490970048ba1f64324ac96d059`
BLAKE2b-256 checksum How to use checksums	`4eb28b3df9439bab6b8a889b90a4736cf654bfa72757d1732396c435629ac442`
Upload date	Jun 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.7`