Skip to content
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

docs(docs): Add ADR on structured logging. #1018

Merged
merged 17 commits into from
Oct 20, 2024
Merged

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Oct 17, 2024

Description

Adds an ADR about structured logging.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@stevenj stevenj self-assigned this Oct 17, 2024
@stevenj stevenj added do not merge yet PR is not ready to be merged yet review me PR is ready for review labels Oct 17, 2024
@stevenj stevenj added this to the M4: Voting & Delegation milestone Oct 17, 2024
Copy link
Contributor

github-actions bot commented Oct 17, 2024

Test Report | ${\color{lightgreen}Pass: 297/297}$ | ${\color{red}Fail: 0/297}$ |

@minikin minikin self-requested a review October 17, 2024 08:32
Copy link
Collaborator

@minikin minikin left a comment

Choose a reason for hiding this comment

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

That sounds like a good idea. Are we going to have concrete specs for this later?
For example, we said, Date and Time *MUST* always be referenced to UTC and not Local Time. But what exact format are we going to use? For example, we'd prefer ISO 8601, not RFC 1123 .

@stevenj
Copy link
Collaborator Author

stevenj commented Oct 18, 2024

That sounds like a good idea. Are we going to have concrete specs for this later? For example, we said, Date and Time *MUST* always be referenced to UTC and not Local Time. But what exact format are we going to use? For example, we'd prefer ISO 8601, not RFC 1123 .

Yes we can. The only reason I didn't is because I wasn't sure what would be easy across all the languages. For Rust we are using rfc_3339 (a subset of ISO 8601).
So we could say the time can be formatted in either ISO 8601 or RF 3339.

@stevenj stevenj requested a review from minikin October 18, 2024 05:54
@stevenj stevenj removed the do not merge yet PR is not ready to be merged yet label Oct 18, 2024
Base automatically changed from adr/api_endpoints to main October 20, 2024 09:21
@minikin minikin enabled auto-merge (squash) October 20, 2024 09:22
@minikin minikin merged commit 7b36e98 into main Oct 20, 2024
31 checks passed
@minikin minikin deleted the adr/structured_logging branch October 20, 2024 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review me PR is ready for review
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants