Skip to content

Add logging guidelines for developers #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 2, 2023

Conversation

pleshakov
Copy link
Contributor

@pleshakov pleshakov commented Jul 24, 2023

Proposed changes

Problem:
The project doesn't include logging guidelines. As a result, there is risk the logging:
(1) Evolves chaotically.
(2) Not adequately addresses both users and developer needs.

Solution:
Add logging guidelines for developers.

Solves #547

Note:
I included a temp doc with a list of issues I see that are spawned by the guidelines. They show the diff between the guidelines and the code. I didn't want to add them before the PR is reviewed and merged, as they might change because of that.

UPDATE: Issues were created:
Added issues:

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@pleshakov pleshakov requested a review from a team as a code owner July 24, 2023 20:00
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 24, 2023
@pleshakov pleshakov force-pushed the docs/logging-guidelines branch 2 times, most recently from 07183f7 to 870c00b Compare July 24, 2023 21:26
@pleshakov pleshakov requested a review from kate-osborn August 1, 2023 21:08
Copy link
Contributor

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏼

Problem:
The project doesn't include logging guidelines. As a result, there is
risk the logging:
(1) Evolves chaotically.
(2) Not adequately addresses both users and developer needs.

Solution:
Add logging guidelines for developers.

Solves nginx#547


Co-authored-by: Kate Osborn <50597707+kate-osborn@users.noreply.github.com>
Co-authored-by: Ciara Stacke <18287516+ciarams87@users.noreply.github.com>
Co-authored-by: Saylor Berman <s.berman@f5.com>
@pleshakov pleshakov force-pushed the docs/logging-guidelines branch from 0cff40e to a5198df Compare August 2, 2023 15:46
@pleshakov pleshakov merged commit 763e239 into nginx:main Aug 2, 2023
@pleshakov pleshakov deleted the docs/logging-guidelines branch August 2, 2023 16:01
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
Problem:
The project doesn't include logging guidelines. As a result, there is
risk the logging:
(1) Evolves chaotically.
(2) Not adequately addresses both users and developer needs.

Solution:
Add logging guidelines for developers.

Solves nginx#547

Co-authored-by: Kate Osborn <50597707+kate-osborn@users.noreply.github.com>
Co-authored-by: Ciara Stacke <18287516+ciarams87@users.noreply.github.com>
Co-authored-by: Saylor Berman <s.berman@f5.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants