akurai-log / fixtures/monitor-contract.json

Latest change 2577f04e8d3b30f5b729c10273a73b0d54351113 - feat: enforce tenant-safe log contract by Ólafur Búi Ólafsson

{
  "version": 1,
  "max_fields": 64,
  "correlation_fields": [
    "organization_id",
    "workspace_id",
    "installation_id",
    "deployment_id",
    "request_id"
  ],
  "privacy_classes": {
    "correlation": "correlation",
    "metadata": "metadata",
    "sensitive": "sensitive",
    "prohibited": "prohibited"
  },
  "safe_correlation": {
    "organization_id": "org_acme-01",
    "workspace_id": "ws_acme-01",
    "installation_id": "inst_123",
    "deployment_id": "dep_20260718",
    "request_id": "req-9f8e"
  },
  "invalid_correlation": [
    "user@example.com",
    "Bearer abc.def.ghi",
    "secret=do-not-log",
    "workspace/id",
    ""
  ],
  "classification_cases": [
    { "name": "organization_id", "class": "correlation" },
    { "name": "organizationId", "class": "correlation" },
    { "name": "sessionId", "class": "sensitive" },
    { "name": "ipAddress", "class": "sensitive" },
    { "name": "userId", "class": "sensitive" },
    { "name": "apikey", "class": "prohibited" },
    { "name": "apiKey", "class": "prohibited" },
    { "name": "APIKEY", "class": "prohibited" },
    { "name": "NOTE", "class": "prohibited" },
    { "name": "EMAIL", "class": "prohibited" },
    { "name": "fileContent", "class": "prohibited" },
    { "name": "URLValue", "class": "metadata" },
    { "name": "organizatiοn_id", "class": "prohibited" },
    { "name": "authorization", "class": "prohibited" },
    { "name": "not-a-field", "class": "prohibited" }
  ],
  "normalization_cases": [
    { "input": "NOTE", "output": "note" },
    { "input": "APIKEY", "output": "apikey" },
    { "input": "organizationId", "output": "organization_id" },
    { "input": "URLValue", "output": "url_value" }
  ],
  "ordering_keys": [
    "field_64", "field_63", "field_62", "field_61", "field_60",
    "field_59", "field_58", "field_57", "field_56", "field_55",
    "field_54", "field_53", "field_52", "field_51", "field_50",
    "field_49", "field_48", "field_47", "field_46", "field_45",
    "field_44", "field_43", "field_42", "field_41", "field_40",
    "field_39", "field_38", "field_37", "field_36", "field_35",
    "field_34", "field_33", "field_32", "field_31", "field_30",
    "field_29", "field_28", "field_27", "field_26", "field_25",
    "field_24", "field_23", "field_22", "field_21", "field_20",
    "field_19", "field_18", "field_17", "field_16", "field_15",
    "field_14", "field_13", "field_12", "field_11", "field_10",
    "field_09", "field_08", "field_07", "field_06", "field_05",
    "field_04", "field_03", "field_02", "field_01", "field_00"
  ],
  "ordering_survives": [
    "field_00", "field_01", "field_02", "field_03", "field_04",
    "field_05", "field_06", "field_07", "field_08", "field_09",
    "field_10", "field_11", "field_12", "field_13", "field_14",
    "field_15", "field_16", "field_17", "field_18", "field_19",
    "field_20", "field_21", "field_22", "field_23", "field_24",
    "field_25", "field_26", "field_27", "field_28", "field_29",
    "field_30", "field_31", "field_32", "field_33", "field_34",
    "field_35", "field_36", "field_37", "field_38", "field_39",
    "field_40", "field_41", "field_42", "field_43", "field_44",
    "field_45", "field_46", "field_47", "field_48", "field_49",
    "field_50", "field_51", "field_52", "field_53", "field_54",
    "field_55", "field_56", "field_57", "field_58", "field_59",
    "field_60", "field_61", "field_62", "field_63"
  ],
  "safe_fields": {
    "status": 200,
    "attempt": 2,
    "cache_hit": true,
    "component": "http"
  },
  "unsafe_fields": {
    "authorization": "Bearer top-secret",
    "email": "person@example.com",
    "note": "private note content",
    "file_content": "private file content",
    "APIKEY": "private api key",
    "NOTE": "private all-caps note",
    "EMAIL": "private@example.com",
    "nested": { "secret": "hidden" },
    "organizatiοn_id": "org-secret"
  },
  "redaction_cases": [
    {
      "input": "request failed for person@example.com",
      "output": "[REDACTED_EMAIL]"
    },
    {
      "input": "Authorization: Bearer top-secret",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "apiKey : abc123",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "api-key: abc123",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "token%2525253Dabc123",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "person%25252540example.com",
      "output": "[REDACTED_EMAIL]"
    },
    {
      "input": "safe%252525text",
      "output": "safe%text"
    },
    {
      "input": "{\"token\":\"abc123\"}",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "token%3Dabc%26secret%3Dhidden",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "bearer=abc.def",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "Bearer\tabc.def",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "-----BEGIN CERTIFICATE-----",
      "output": "[REDACTED_SECRET]"
    },
    {
      "input": "encoded%40person.example",
      "output": "[REDACTED_EMAIL]"
    },
    {
      "input": "line one\r\nline two",
      "output": "line one  line two"
    },
    {
      "input": "request failed",
      "output": "request failed"
    }
  ]
}