-
Notifications
You must be signed in to change notification settings - Fork 14
Splits logging policy doc into seperate policy and elastic parts #312
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
Conversation
Makes it easier to read/edit the markdown.
1) Elastic Cloud is live and should be how everybody logs 2) UKHO.Logging.Serilog works.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
# Conflicts: # software-engineering-policies/Logging/LoggingPolicy.md
Kirosoft
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AI Suggestions:
Suggestions / Areas to Clarify
Traceability & Correlation IDs:
The instructions for traceId are good, but consider requiring correlation IDs for distributed tracing across services, if that is a wider organizational goal.
Log Message Format:
The statement "message (The data being logged. This should be a JSON formatted blob)" could clarify if this applies to all logs or only certain levels/types.
"Be Consistent" Guidance:
Encourage use of shared logging schemas or dictionaries across projects, and maybe reference a central schema if available.
Typos / Minor Edits:
"GPDR" should be "GDPR".
"manged" should be "managed".
"depreciated" should be "deprecated".
Elastic Naming Convention:
The index naming convention is repeated in multiple places. Consider referencing a single authoritative section to avoid drift.
Unit Test Guidance:
The section on unit tests could include examples or reference tools for asserting logs in tests.
Explicit Examples:
Where you mention field names and log examples, a short sample log entry (in JSON) could be useful.
I'd call traceid and correlationId the same thing. I put traceId in the docs because that's what Elastic calls it.
Fixed this, I was wrong to talk about a JSON blob here.
Tweaked the language, O11y should look at a shared dictionary/"standard" log messages maybe.
The repeats are examples. |
No description provided.