search

frmscoe / General-Issues

This repo exists to track current work and any issues within the FRMS CoE
2 stars 0 forks source link

Create a user guide for logging in Tazama #370

Open Justus-at-Tazama opened 4 months ago

Justus-at-Tazama commented 4 months ago

Story statement

As a implementer of Tazama, I want to know how to deploy and utilise the logging framework in Tazama, So that I can have transparency over operational system behaviour

Acceptance criteria

Create a user guide for implementers of Tazama to cover the following topics:

  1. An overview of the architecture and component stack, end-to-end, to cover all steps in the logging process, from logging setup to logging traffic and logging display (including event logging and APM) - https://frmscoe.atlassian.net/wiki/spaces/FRMS/pages/128811015/The+Tazama+Logging+Framework
  2. A guide on deploying the logging framework to enable logging of Tazama behaviour
  3. A guide on how to implement logging in new processors
  4. A guide on configuring logging in existing processors
  5. A guide on rendering and interpreting the logs in Elastic (APM, Kibana)
  6. An overview of out-of-the-box dashboards in Kibana