Create Grafana server to store and search BCMS application logs
Context
The BCMS has the following staging deployments managed by the Coko team:
- ncbidev.cloud68.co: used by the Coko team for testing development in progress
- ncbi.cloud68.co: used by the NCBI team for testing releases
NCBI has requested another deployment with a dump of the PMC database so that testing can be done on real content. See new instance “bcms-pmc.cloud68.co” in diagram below.
NCBI’s has requested a technical proposal and estimate to integrate the Elastic Stack (or similar) to store and search application logs for all Coko-managed deployments so that developers can search logs by crashes by time, frequency, BCMS URL, any other relevant variables (to be defined).
Proposal: Log management
For log management, we will create and deploy a Grafana Loki server, which in turn will aggregate logs from all of our BCMS deployments and display them in a dashboard. To see what a Grafana interface would look like, check their website.
Design
Not applicable
Acceptance criteria
-
A dashboard user interface is provided through Grafana to allow Coko and NCBI development team (developers, project management, product owner) to search applications logs (with details according to the acceptance criteria for those logs in #1542 (closed)) from all supported deployed BCMS instances, currently the ncbidev.cloud68.co and ncbi.cloud68.co deployments
Definition of ready
-
BCMS User Story / Context has been well defined -
The priority of the user story is specified and agreed Digital assets added (design, database scheme, mockups etc if relevant)-
Coko Technical Proposal approved by NCBI -
Testable Acceptance Criteria approved by NCBI -
Estimate of effort to complete (time or points) -
The issue has been broken down into development tasks (if necessary) -
Requirements Clarified -
The product owner and development team agree that the user story is ready for development -
NCBI adds “Dev_Ready”
Definition of done
-
All coding tasks are finished and implemented -
Acceptance Criteria Met
Scheduling
- Development estimate for the Grafana server: 1 week
- Development estimate for connecting BCMS server to Grafana: 3 days