Observability / Auditability / Traceability
Kind: category
Record: architecture-category:observability-auditability-traceability
Canonical: Ontology
The Observability / Auditability / Traceability category holds 12 architecture principles.
Listed in Principle categories, after Model Architecture and before Behavioral Patterns.
Principle
- Observability
- Logging
- Monitoring
- Alerting
- Auditability
- Audit Logging
- Traceability
- Correlation ID
- Causation ID
- Distributed Tracing
- SLO/SLI
- Dashboards
Layer
Linked from
Observability / Auditability / Traceability
Every principle in this category is listed as a record. Each record carries its kind, its severity, the scopes it applies at and the layer it lives in, then the edge relations that join it to other records, the records that point back at it, the contracts that answer to it and the tensions it takes part in. The descriptors say how it is violated, detected, measured, repaired and enforced. Where the record carries one, an exemplar shows the shape before and after the principle is applied.
Relations diagram
flowchart LR
n_observability["Observability"]
n_logging["Logging"]
n_monitoring["Monitoring"]
n_alerting["Alerting"]
n_auditability["Auditability"]
n_audit_logging["Audit Logging"]
n_traceability["Traceability"]
n_correlation_id["Correlation ID"]
n_causation_id["Causation ID"]
n_distributed_tracing["Distributed Tracing"]
n_slo_sli["SLO/SLI"]
n_dashboards["Dashboards"]
n_logging --> n_traceability
n_alerting --> n_monitoring
n_auditability --> n_audit_logging
n_auditability --> n_traceability
n_audit_logging --> n_auditability
n_audit_logging --> n_traceability
n_traceability --> n_correlation_id
n_traceability --> n_auditability
n_correlation_id --> n_distributed_tracing
n_distributed_tracing --> n_observability
n_slo_sli --> n_monitoring
n_slo_sli --> n_observability
n_slo_sli --> n_alerting
n_dashboards --> n_monitoring
n_dashboards --> n_observability
n_dashboards --> n_traceabilityObservability
- Kind: quality-attribute
- Category: Observability / Auditability / Traceability
- Severity: contextual
- Mandatory for: production systems
- Scope: service, system, runtime
- Layer: Observability
Logging
- Kind: mechanism
- Category: Observability / Auditability / Traceability
- Severity: mandatory
- Scope: application, service
- Layer: Observability
Monitoring
- Kind: mechanism
- Category: Observability / Auditability / Traceability
- Severity: mandatory
- Scope: service, infrastructure
- Layer: Observability
Alerting
- Kind: mechanism
- Category: Observability / Auditability / Traceability
- Severity: mandatory
- Scope: operations, service
- Layer: Observability
Auditability
- Kind: quality-attribute
- Category: Observability / Auditability / Traceability
- Severity: contextual
- Mandatory for: regulated or sensitive systems
- Scope: system, data, security
- Layer: Observability
Audit Logging
- Kind: mechanism
- Category: Observability / Auditability / Traceability
- Severity: contextual
- Mandatory for: sensitive systems
- Scope: security, compliance, data mutation
- Layer: Observability
Traceability
- Kind: quality-attribute
- Category: Observability / Auditability / Traceability
- Severity: mandatory
- Scope: request, workflow, change
- Layer: Observability
Correlation ID
- Kind: mechanism
- Category: Observability / Auditability / Traceability
- Severity: contextual
- Mandatory for: distributed systems
- Scope: request, message, workflow
- Layer: Observability
Causation ID
- Kind: mechanism
- Category: Observability / Auditability / Traceability
- Severity: recommended
- Scope: event, message, workflow
- Layer: Observability
Distributed Tracing
- Kind: mechanism
- Category: Observability / Auditability / Traceability
- Severity: contextual
- Mandatory for: distributed systems
- Scope: distributed system, service mesh
- Layer: Observability
SLO/SLI
- Kind: constraint
- Category: Observability / Auditability / Traceability
- Severity: contextual
- Mandatory for: production systems
- Scope: service, reliability, operations
- Aliases: Service Level Objective, Service Level Indicator, Objective Reliability Targets
- Layer: Observability
Dashboards
- Kind: artifact
- Category: Observability / Auditability / Traceability
- Severity: recommended
- Scope: service, operations, visibility
- Layer: Observability