Skip to content
EuroDMS Dev Guide

Observability

Observability

Section titled “Observability”

Quellverzeichnis: modules/observability/

Metriken, Tracing, Alerting und Health-Endpoints (SigNoz/OpenTelemetry).

Services

Section titled “Services”

Geschäftslogik des Moduls (src/services/):

  • AuditTrailService
  • ErrorCatalogEntryAlreadyExistsError
  • ErrorCatalogEntryNotFoundError
  • ErrorCatalogService
  • HealthCheckAlreadyExistsError
  • HealthCheckNotFoundError
  • HealthCheckService
  • IncidentNotFoundError
  • IncidentService
  • IncidentTerminalError
  • LogService
  • SLADefinitionNotFoundError
  • SLAService
  • ScheduledReportNotFoundError
  • ScheduledReportService
  • ScheduledReportTerminalError
  • StatusPageNotFoundError
  • StatusPageService
  • SubscriberAlreadyExistsError

Repositories

Section titled “Repositories”

Datenzugriffs-Ports (src/repositories/):

  • AuditTrailRepository
  • ErrorCatalogRepository
  • HealthCheckRepository
  • InMemoryAuditTrailRepository
  • InMemoryErrorCatalogRepository
  • InMemoryHealthCheckRepository
  • InMemoryIncidentRepository
  • InMemoryLogEntryRepository
  • InMemorySLADefinitionRepository
  • InMemoryScheduledReportRepository
  • InMemoryStatusPageRepository
  • IncidentRepository
  • LogEntryRepository
  • SLADefinitionRepository
  • ScheduledReportRepository
  • StatusPageRepository

Domain Events

Section titled “Domain Events”

Vom Modul emittierte Ereignisse (src/events.ts):

  • EventHandler
  • OBSERVABILITY_EVENT_TYPES
  • auditEntryWritten
  • errorBurnRateExceeded
  • healthCheckDegraded
  • healthCheckFailed
  • incidentCreated
  • incidentNis2Relevant
  • incidentResolved
  • logPiiDetected
  • reportGenerated

API-Endpunkte

Section titled “API-Endpunkte”

HTTP-Endpunkte unter api/routes/observability/ — Details in der API-Referenz.

Methode Pfad Datei
GET /v1/audit-trail observability.ts
POST /v1/audit-trail observability.ts
POST /v1/audit-trail/export observability.ts
GET /v1/errors/catalog observability.ts
POST /v1/errors/catalog observability.ts
GET /v1/errors/catalog/:errorCode observability.ts
PATCH /v1/errors/catalog/:errorCode observability.ts
GET /v1/health health.ts
GET /v1/health/components health.ts
POST /v1/health/components health.ts
GET /v1/health/components/:id health.ts
PATCH /v1/health/components/:id health.ts
GET /v1/health/components/:id/uptime health.ts
GET /v1/logs observability.ts
POST /v1/logs observability.ts
GET /v1/logs/:traceId observability.ts
POST /v1/logs/export observability.ts
GET /v1/reports/generated observability.ts
GET /v1/reports/scheduled observability.ts
POST /v1/reports/scheduled observability.ts
GET /v1/reports/scheduled/:id observability.ts
PATCH /v1/reports/scheduled/:id observability.ts
POST /v1/reports/scheduled/:id/activate observability.ts
POST /v1/reports/scheduled/:id/archive observability.ts
POST /v1/reports/scheduled/:id/pause observability.ts
POST /v1/reports/scheduled/:id/trigger observability.ts
GET /v1/sla observability.ts
POST /v1/sla observability.ts
GET /v1/sla/:id/compliance observability.ts
GET /v1/sla/:id/error-budget observability.ts
GET /v1/status-page health.ts
GET /v1/status-page/incidents health.ts
POST /v1/status-page/incidents health.ts
GET /v1/status-page/incidents/:id health.ts
POST /v1/status-page/incidents/:id/nis2-authority health.ts
POST /v1/status-page/incidents/:id/nis2-internal health.ts
POST /v1/status-page/incidents/:id/updates health.ts
POST /v1/status-page/subscriptions health.ts

Public API

Section titled “Public API”

Über den Modul-Index (src/index.ts) exportierte Symbole — die einzige erlaubte Zugriffsart von außen:

  • // Aggregate Roots HealthCheck
  • // Audit auditEntryWritten
  • // DTOs - AuditTrail CreateAuditEntryInput
  • // DTOs - ErrorCatalog CreateErrorCatalogEntryInput
  • // DTOs - HealthCheck CreateHealthCheckInput
  • // DTOs - Incident CreateIncidentInput
  • // DTOs - LogEntry CreateLogInput
  • // DTOs - SLADefinition CreateSLAInput
  • // DTOs - ScheduledReport CreateScheduledReportInput
  • // DTOs - StatusPage SubscribeStatusPageInput
  • // Enums HealthStatus
  • // Errors ValidationError
  • // Health Check healthCheckFailed
  • // Helper now
  • // Incident incidentCreated
  • // Incident transitions canTransitionIncident
  • // PII logPiiDetected
  • // PII Redactor type PiiRedactor
  • // Report reportGenerated
  • // Report Generator type ReportGenerator
  • // SLO errorBurnRateExceeded
  • // ScheduledReport transitions canTransitionScheduledReport
  • // Telemetry Sink type TelemetrySink
  • // Validations - Common isValidTimestamp
  • // Validations - Enums isValidHealthStatus
  • // Validations - Specific isValidCronExpression
  • // Value Objects IncidentUpdate
  • AddIncidentUpdateInput
  • AuditTrailEntry
  • AuditTrailService
  • BurnRateAlert
  • Component
  • DefaultPiiRedactor
  • ErrorCatalogEntry
  • ErrorCatalogEntryAlreadyExistsError
  • ErrorCatalogEntryNotFoundError
  • ErrorCatalogService
  • ErrorCategory
  • GeneratedReport
  • HealthCheckAlreadyExistsError
  • … und 134 weitere

Zurück zur Modul-Übersicht oder zur Startseite.