Skip to content

Conversation

@osric-ukho
Copy link
Contributor

No description provided.

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-io-eu
Copy link

snyk-io-eu bot commented Oct 13, 2025

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Licenses 0 0 0 0 0 issues
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

# Conflicts:
#	software-engineering-policies/Logging/LoggingPolicy.md
Copy link
Contributor

@Kirosoft Kirosoft left a 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.

@osric-ukho
Copy link
Contributor Author

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.

I'd call traceid and correlationId the same thing. I put traceId in the docs because that's what Elastic calls it.

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.

Fixed this, I was wrong to talk about a JSON blob here.

"Be Consistent" Guidance: Encourage use of shared logging schemas or dictionaries across projects, and maybe reference a central schema if available.

Tweaked the language, O11y should look at a shared dictionary/"standard" log messages maybe.

Typos / Minor Edits:

"GPDR" should be "GDPR". "manged" should be "managed". "depreciated" should be "deprecated".
Fixed, thanks.

Elastic Naming Convention: The index naming convention is repeated
in multiple places. Consider referencing a single authoritative
section to avoid drift.

The repeats are examples.

@osric-ukho osric-ukho merged commit e9bf2d6 into main Oct 21, 2025
3 checks passed
@osric-ukho osric-ukho deleted the update-logging-policy branch October 21, 2025 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants