{
  "code": null,
  "collection": "architecture",
  "href": "https://banes-lab.com/ontology#architecture-correlation-id",
  "id": "correlation-id",
  "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": "Correlation ID",
  "ref": "architecture:correlation-id",
  "relations": [
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-context-propagation",
          "json": "https://banes-lab.com/json/records/lexicon/context-propagation",
          "label": "Context Propagation",
          "markdown": "https://banes-lab.com/records/lexicon/context-propagation.md",
          "ref": "lexicon:context-propagation"
        }
      ],
      "relation": "requires"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-distributed-tracing",
          "json": "https://banes-lab.com/json/records/architecture/distributed-tracing",
          "label": "Distributed Tracing",
          "markdown": "https://banes-lab.com/records/architecture/distributed-tracing.md",
          "ref": "architecture:distributed-tracing"
        }
      ],
      "relation": "reinforces"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-request-level-traceability",
          "json": "https://banes-lab.com/json/records/lexicon/request-level-traceability",
          "label": "Request-Level Traceability",
          "markdown": "https://banes-lab.com/records/lexicon/request-level-traceability.md",
          "ref": "lexicon:request-level-traceability"
        }
      ],
      "relation": "enables"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-uncorrelated-events",
          "json": "https://banes-lab.com/json/records/lexicon/uncorrelated-events",
          "label": "Uncorrelated Events",
          "markdown": "https://banes-lab.com/records/lexicon/uncorrelated-events.md",
          "ref": "lexicon:uncorrelated-events"
        }
      ],
      "relation": "conflicts-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-header-metadata-management",
          "json": "https://banes-lab.com/json/records/lexicon/header-metadata-management",
          "label": "Header/Metadata Management",
          "markdown": "https://banes-lab.com/records/lexicon/header-metadata-management.md",
          "ref": "lexicon:header-metadata-management"
        }
      ],
      "relation": "tensions-with"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/schema#tension-correlation-id-header-metadata-management",
          "json": "https://banes-lab.com/json/records/tension/correlation-id-header-metadata-management",
          "label": "Correlation ID / Header/Metadata Management",
          "markdown": "https://banes-lab.com/records/tension/correlation-id-header-metadata-management.md",
          "ref": "tension:correlation-id-header-metadata-management"
        }
      ],
      "relation": "tensions"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology/lexicon#lexicon-uncorrelated-events",
          "json": "https://banes-lab.com/json/records/lexicon/uncorrelated-events",
          "label": "Uncorrelated Events",
          "markdown": "https://banes-lab.com/records/lexicon/uncorrelated-events.md",
          "ref": "lexicon:uncorrelated-events"
        }
      ],
      "relation": "violated-by"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/ontology#architecture-chain-of-responsibility-pattern",
          "json": "https://banes-lab.com/json/records/architecture/chain-of-responsibility-pattern",
          "label": "Chain of Responsibility Pattern",
          "markdown": "https://banes-lab.com/records/architecture/chain-of-responsibility-pattern.md",
          "ref": "architecture:chain-of-responsibility-pattern"
        }
      ],
      "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-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": "required-by"
    },
    {
      "links": [
        {
          "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": "refactors"
    },
    {
      "links": [
        {
          "href": "https://banes-lab.com/disciplined-methodology/collaborate#posting-and-waiting-are-one-operation",
          "json": "https://banes-lab.com/json/disciplined-methodology/collaborate/posting-and-waiting-are-one-operation",
          "label": "Posting and waiting are one operation",
          "markdown": "https://banes-lab.com/disciplined-methodology/collaborate/posting-and-waiting-are-one-operation.md",
          "ref": "chapter:/disciplined-methodology/collaborate#posting-and-waiting-are-one-operation"
        },
        {
          "href": "https://banes-lab.com/software-architecture/scale#the-ceiling-moves-by-cost",
          "json": "https://banes-lab.com/json/software-architecture/scale/the-ceiling-moves-by-cost",
          "label": "The ceiling moves by cost",
          "markdown": "https://banes-lab.com/software-architecture/scale/the-ceiling-moves-by-cost.md",
          "ref": "chapter:/software-architecture/scale#the-ceiling-moves-by-cost"
        },
        {
          "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 attaches one identifier to a request and carries it through every call, message and log line the request causes.",
  "siblings": {
    "next": {
      "href": "https://banes-lab.com/ontology#architecture-causation-id",
      "json": "https://banes-lab.com/json/records/architecture/causation-id",
      "label": "Causation ID",
      "markdown": "https://banes-lab.com/records/architecture/causation-id.md",
      "ref": "architecture:causation-id"
    },
    "previous": {
      "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"
    }
  },
  "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": "const correlationId = request.headers.get(\"X-Correlation-ID\") ?? idSource.next();\nawait http.post(\"/bar\", { fooId: foo.id }, { headers: { \"X-Correlation-ID\": correlationId } });",
    "before": "await http.post(\"/bar\", { fooId: foo.id });",
    "lang": "ts",
    "medium": "code"
  },
  "formedBy": null,
  "scope": [
    "request",
    "message",
    "workflow"
  ],
  "severity": "contextual"
}