Logging and monitoring
This section describes the logging and monitoring setup for ArchivingBridge, including log collection, analysis, and observability practices using ELK Stack and OpenTelemetry.
Logging
In Nexeed IAS all logs are logged by our application to stdout and then saved in dockers log directory on the host machine (=VM, […]).
Filebeat collects these, parses them (JSON, when Logging guidelines are implemented in all IAS Modules) and forwards them to elasticsearch.
Database migration logging
Database migration logs are now managed through lifecycle logging, ensuring structured and consistent tracking of migration events. These logs provide visibility into the migration process, helping to confirm successful updates or diagnose failures. The following lifecycle log events are recorded:
-
DATA_MIGRATION_STARTED: Logged at the start of the migration process.
-
DATA_MIGRATION_SUCCESSFUL: Logged upon successful completion of the migration.
-
DATA_MIGRATION_FAILED: Logged when a migration fails, including error details.
Application Performance Monitoring (APM)
Application Performance Monitoring (APM) must be activated during deployment to enable distributed tracing and metrics collection via OpenTelemetry.
ArchivingBridge HELM chart references Nexeed global configuration values for configuration of APM. These are described in the IAS operations manual
For OpenTelemetry setup, refer to section 6.1.3 above.
Metrics: A metric is a single measurement at a specific point in time. It can be enriched with more information but quickly turns then more into an event than in a metric.
-
Key metrics: request rate, error rate, latency, resource usage.
Tracing: A trace represents the path of a request through a software system. This path contains many single steps that are executed within an application.
-
Traces are exported to ELK or compatible backend for analysis.
Health Checks: ArchivingBridge provides health verification endpoints that adhere to the global BCI Nexeed IAS Module health verification specification.
These endpoints support readiness and liveness probes for automated monitoring.
References
-
ELK Stack documentation: https://www.elastic.co/elk-stack
-
OpenTelemetry documentation: https://opentelemetry.io/