Structured Logging

[shaun-nx]

Overview

As a user of NGINX Ingress Controller, I would like to have an easier time searching for specific log events so that we can better understand the health of our system and do so in a more performant way

High-level Requirements

• Update logging library from golang/glog to log/slog
• Add flag to toggle between string and json log parser
• Provide a means to use glog as the logging handler for backwards compatibility
• Update 3.7.0 release documentation to announce update to log/slog

Definition of Done

Development

• Unit tests are written to cover functionality delivered in the story.
• Make sure that the unit test passes before creating a pull request.
• Make sure that the test coverage stays optimal.
• Run make lint locally before creating a PR.
• Remove CLI args used for configuring glog levels (eg: deployment.yaml)

Testing

• NIC starts and runs
• NIC starts and runs (with the service insight and healthcheck options enabled)
• Automated tests are written as part of the story.
• Run “make lint-python“ from root
• Acceptance criteria are met.
• Stories are demonstrated to the team.
• Product Manager accepts the story as done.
• If a feature requires changes/extensions of the Helm chart, those shall be done as part of the story.

Release Notes & Documentation

• PR is labeled appropriately so they display in GitHub release notes.
• Create/update documentation related to the user story.
• Create/update the example in our codebase when applicable.

POC Tasks

Preview Give feedback

1. POC - Toggle between string and json parser
2. POC - Toggle between glog parser and slog structure (string or json)

Implementation Tasks

Preview Give feedback

1. Add slog handler to write glog formatted logs #6516
   +0
   
2. Add wrapper functions for log levels #6568
   go skip changelog +2
   
3. Update all log lines to new logger #6566
   backlog +1
   

   
4. Add LogLevel & LogFormat flags #6520
   change documentation enhancement go helm_chart +5
   
5. refactor: replace glog in flags.go #6530
   go skip changelog +2
   
6. refactor: replace glog in main.go #6531
   go skip changelog +2
   
7. refactor: replace glog in controller.go #6551
   go skip changelog +2
   
8. refactor: replace glog in global_configuration.go #6563
   go skip changelog +2
   
9. refactor: cmd slog wrapper #6573
   go skip changelog +2
   
10. refactor: update slog wrapper for controller.go #6574
    go skip changelog +2
    
11. refactor: replace glog in k8s package 1 #6575
    go skip changelog +2
    
12. refactor: replace glog in k8s package 2 #6576
    go skip changelog +2
    
13. refactor: replace glog in configs package #6584
    go skip changelog +2
    
14. refactor: replace glog in the nginx package #6585
    go skip changelog +2
    
15. refactor: replace glog in externaldns & certmanager #6586
    go skip changelog +2
    
16. refactor: replace glog in metrics & telemetry packages #6587
    go skip changelog +2
    
17. refactor: replace glog in validation/appprotect.go #6598
    go skip changelog +2
    
18. Remove deprecated log level parameters #6620
    chore +1
    
19. Replace glog in healthcheck.go & remove glog dependency #6628
    chore +1
    
20. Update Helm_Chart to 2.0.0 to prepare for NIC 4.0.0 breaking change #6639
    skip changelog +1
    

[github-actions]

Hi @shaun-nx thanks for reporting!

Be sure to check out the docs and the Contributing Guidelines while you wait for a human to take a look at this 🙂

Cheers!