Audit Log Plugin

Description

This plugin aims to store all user interactions as logs that can be accessed easily and securely through the use of permissions.

Configuration:

The default configuration is as follows (you must add it to ./config/plugin.js):

module.exports = {
    // ...
    "audit-log-marje3": {
        enabled: true,
        config: {
            deletion: {
              enabled: true,
              frequency: "logAge", // "logAge" or "logCount"
              options: {
                  value: 2,
                  interval: "week", // "day" or "week" or "month" or "year" // Don't add this config property if the frequency is "logCount"
              } 
            },
            filters: {
              endpoint: {
                exclude: ["/content-manager/uid", "/admin/renew-token", "/_health"],
              },
              status: {},
              method: {
                exclude: ["GET"],
              },
            },
            redactedValues: [
              "password",
              "token",
              "firstname",
              "lastname",
              "username",
            ],
          }
    }
    // ...
}

Each of the filter properties can either have an exclude or an include property, but not both. The redactedValues proterty will specify the set of properties to redact in the request body and response body in the logs.

Links:

• Todo
• Breakdown