...
- Proposed name for projects: Logging and Analytics
- Proposed name for the repository: logging-analytics
Why a Logging Project
Keywords:
Centralized, Role based access, tracking, streaming, reporting
Feature / Requirement | Description |
|---|---|
| F1 | Centralized Logs - all the logs available streamed in one place - search, visualize and report ready |
| F2 | Role based access - logs are accessible from outside the container - no ssh into the pod or tailing of the logs per microservice |
| F3 | Tracking - If a unique ID is passed across microservices we can trace a transaction pass/failure through the system requestID, InvocationID, Timestamp indexed |
| F4 | Reporting - track multiple transaction patterns and generate emergent or correlated behavior |
| F5 | Control over log content - collect, index, filter |
| F6 | Machine readable json oriented elasticsearch storage of logs |
| R1 | Logs are in the same (currently 29 field) format |
| R2 | Logging library requires minimal changes for use - using Spring AOP to get MARKER entry/exit logs for free without code changes |
| R3 | Logs are streamed to a central ELK stack |
| R4 | ELK stack provides for tracing, dashboards, query API |
Project Description
ONAP consists of many components and containers, and consequently writes to many logfiles. The volume of logger output may be enormous, especially when debugging. Large, disparate logfiles are difficult to monitor and analyze, and tracing requests across many files, file systems and containers is untenable without tooling.
...
Logger configurations in ONAP are diverse and idiosyncratic. Addressing these issues will prevent costs from being externalized to consumers such as analytics. It also affords the opportunity to remedy any issues with the handling and propagation of contextual information such as transaction identifiers (presently passed as X-ECOMP-RequestID - to be X-ONAP-RequestID). This propagation is critical to tracing requests as they traverse ONAP and related systems, and is the basis for many analytics functions.
...