{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-audit-logging",
  "id": "audit-logging",
  "kind": "mechanism",
  "layer": {
    "href": "https://banes-lab.com/ontology/schema#layer-observability",
    "json": "https://banes-lab.com/json/records/layer/observability",
    "label": "Observability",
    "markdown": "https://banes-lab.com/records/layer/observability.md",
    "ref": "layer:observability"
  },
  "name": "Audit Logging",
  "ref": "architecture:audit-logging",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-actor",
          "json": "https://banes-lab.com/json/records/lexicon/actor",
          "label": "Actor",
          "markdown": "https://banes-lab.com/records/lexicon/actor.md",
          "ref": "lexicon:actor"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-action",
          "json": "https://banes-lab.com/json/records/lexicon/action",
          "label": "Action",
          "markdown": "https://banes-lab.com/records/lexicon/action.md",
          "ref": "lexicon:action"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-timestamp",
          "json": "https://banes-lab.com/json/records/lexicon/timestamp",
          "label": "Timestamp",
          "markdown": "https://banes-lab.com/records/lexicon/timestamp.md",
          "ref": "lexicon:timestamp"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-target",
          "json": "https://banes-lab.com/json/records/lexicon/target",
          "label": "Target",
          "markdown": "https://banes-lab.com/records/lexicon/target.md",
          "ref": "lexicon:target"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-auditability",
          "json": "https://banes-lab.com/json/records/architecture/auditability",
          "label": "Auditability",
          "markdown": "https://banes-lab.com/records/architecture/auditability.md",
          "ref": "architecture:auditability"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-traceability",
          "json": "https://banes-lab.com/json/records/architecture/traceability",
          "label": "Traceability",
          "markdown": "https://banes-lab.com/records/architecture/traceability.md",
          "ref": "architecture:traceability"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-forensics",
          "json": "https://banes-lab.com/json/records/lexicon/forensics",
          "label": "Forensics",
          "markdown": "https://banes-lab.com/records/lexicon/forensics.md",
          "ref": "lexicon:forensics"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-untracked-mutation",
          "json": "https://banes-lab.com/json/records/lexicon/untracked-mutation",
          "label": "Untracked Mutation",
          "markdown": "https://banes-lab.com/records/lexicon/untracked-mutation.md",
          "ref": "lexicon:untracked-mutation"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-privacy",
          "json": "https://banes-lab.com/json/records/lexicon/privacy",
          "label": "Privacy",
          "markdown": "https://banes-lab.com/records/lexicon/privacy.md",
          "ref": "lexicon:privacy"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-audit-logging-privacy",
          "json": "https://banes-lab.com/json/records/tension/audit-logging-privacy",
          "label": "Audit Logging / Privacy",
          "markdown": "https://banes-lab.com/records/tension/audit-logging-privacy.md",
          "ref": "tension:audit-logging-privacy"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-opaque-mutation",
          "json": "https://banes-lab.com/json/records/lexicon/opaque-mutation",
          "label": "Opaque Mutation",
          "markdown": "https://banes-lab.com/records/lexicon/opaque-mutation.md",
          "ref": "lexicon:opaque-mutation"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-append-only-log",
          "json": "https://banes-lab.com/json/records/architecture/append-only-log",
          "label": "Append-Only Log",
          "markdown": "https://banes-lab.com/records/architecture/append-only-log.md",
          "ref": "architecture:append-only-log"
        }
      ],
      "relation": "refactored-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#vocabulary-severity-contextual",
          "json": "https://banes-lab.com/json/records/vocabulary/severity-contextual",
          "label": "contextual",
          "markdown": "https://banes-lab.com/records/vocabulary/severity-contextual.md",
          "ref": "vocabulary:severity-contextual"
        }
      ],
      "relation": "severity"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-category-observability-auditability-traceability",
          "json": "https://banes-lab.com/json/records/architecture-category/observability-auditability-traceability",
          "label": "Observability / Auditability / Traceability",
          "markdown": "https://banes-lab.com/records/architecture-category/observability-auditability-traceability.md",
          "ref": "architecture-category:observability-auditability-traceability"
        }
      ],
      "relation": "category"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-unobservable-failure",
          "json": "https://banes-lab.com/json/records/architecture/unobservable-failure",
          "label": "Unobservable Failure",
          "markdown": "https://banes-lab.com/records/architecture/unobservable-failure.md",
          "ref": "architecture:unobservable-failure"
        }
      ],
      "relation": "refactors"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/disciplined-methodology/build#detect-log-fix",
          "json": "https://banes-lab.com/json/disciplined-methodology/build/detect-log-fix",
          "label": "Detect, log, fix",
          "markdown": "https://banes-lab.com/disciplined-methodology/build/detect-log-fix.md",
          "ref": "chapter:/disciplined-methodology/build#detect-log-fix"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-anti-patterns",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-anti-patterns",
          "label": "Anti-patterns",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-anti-patterns.md",
          "ref": "chapter:/ontology#architecture-category-anti-patterns"
        },
        {
          "href": "https://banes-lab.com/ontology#architecture-category-observability-auditability-traceability",
          "json": "https://banes-lab.com/json/ontology/principles/architecture-category-observability-auditability-traceability",
          "label": "Observability / Auditability / Traceability",
          "markdown": "https://banes-lab.com/ontology/principles/architecture-category-observability-auditability-traceability.md",
          "ref": "chapter:/ontology#architecture-category-observability-auditability-traceability"
        },
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-category-observability-auditability-traceability",
          "json": "https://banes-lab.com/json/ontology/lexicon/lexicon-category-observability-auditability-traceability",
          "label": "Observability / Auditability / Traceability",
          "markdown": "https://banes-lab.com/ontology/lexicon/lexicon-category-observability-auditability-traceability.md",
          "ref": "chapter:/ontology/lexicon#lexicon-category-observability-auditability-traceability"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-vocabulary-severity",
          "json": "https://banes-lab.com/json/ontology/schema/the-vocabulary-severity",
          "label": "Severity levels",
          "markdown": "https://banes-lab.com/ontology/schema/the-vocabulary-severity.md",
          "ref": "chapter:/ontology/schema#the-vocabulary-severity"
        },
        {
          "href": "https://banes-lab.com/ontology/schema#the-resolutions",
          "json": "https://banes-lab.com/json/ontology/schema/the-resolutions",
          "label": "The resolutions",
          "markdown": "https://banes-lab.com/ontology/schema/the-resolutions.md",
          "ref": "chapter:/ontology/schema#the-resolutions"
        }
      ],
      "relation": "linked-from"
    }
  ],
  "summary": "A mechanism that appends an immutable record of each sensitive operation, naming the actor, the action, the target and the time.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-traceability",
      "json": "https://banes-lab.com/json/records/architecture/traceability",
      "label": "Traceability",
      "markdown": "https://banes-lab.com/records/architecture/traceability.md",
      "ref": "architecture:traceability"
    },
    "previous": {
      "href": "https://banes-lab.com/ontology#architecture-auditability",
      "json": "https://banes-lab.com/json/records/architecture/auditability",
      "label": "Auditability",
      "markdown": "https://banes-lab.com/records/architecture/auditability.md",
      "ref": "architecture:auditability"
    }
  },
  "up": {
    "href": null,
    "json": "https://banes-lab.com/json/api/records/architecture",
    "label": "Architecture principles",
    "markdown": "https://banes-lab.com/api/records/architecture.md",
    "ref": "api:records/architecture"
  },
  "aliases": [],
  "exemplar": {
    "after": "auditLog.append({\n  eventId: eventId(),\n  action: \"FOO_UPDATE\",\n  actorId: user.id,\n  resourceId: foo.id,\n  occurredAt: clock.now().toISOString(),\n});",
    "before": "logger.info(`user ${user.id} changed foo ${foo.id}`);",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "security",
    "compliance",
    "data mutation"
  ],
  "severity": "contextual"
}