Skip to content

Document Spring Boot structured logging#15997

Open
jamesfredley wants to merge 3 commits into
8.0.xfrom
docs/structured-logging
Open

Document Spring Boot structured logging#15997
jamesfredley wants to merge 3 commits into
8.0.xfrom
docs/structured-logging

Conversation

@jamesfredley

Copy link
Copy Markdown
Contributor

Summary

  • document opt-in Spring Boot 4.1 structured logging in the logging guide
  • cover console/file formats (ecs, gelf, logstash), JSON include/exclude/rename/add and stacktrace controls, MDC and SLF4J fluent key-values
  • clarify the tracing/baggage correlation boundary and that Grails does not enable structured logging by default

Verification

  • :grails-doc:publishGuide -x aggregateGroovydoc
  • git diff --check

This is an AI-generated starting point for documenting structured logging.

Assisted-by: opencode:gpt-5.6-sol

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation to the Grails logging guide describing how to opt-in to Spring Boot 4.1 structured logging, including format selection, JSON customization knobs, MDC/SLF4J key-values, and tracing/baggage correlation boundaries.

Changes:

  • Document Spring Boot structured logging formats for console/file (ecs, gelf, logstash) and related configuration keys.
  • Provide example configuration for JSON include/exclude/rename/add and stacktrace controls.
  • Add a short code example showing MDC + SLF4J fluent key-values, plus tracing/baggage correlation notes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread grails-doc/src/en/guide/conf/config/logging.adoc Outdated
Comment thread grails-doc/src/en/guide/conf/config/logging.adoc Outdated
@codecov

codecov Bot commented Jul 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51.1106%. Comparing base (b980413) to head (e2ee974).
⚠️ Report is 3 commits behind head on 8.0.x.

Additional details and impacted files

Impacted file tree graph

@@               Coverage Diff                @@
##             8.0.x     #15997         +/-   ##
================================================
+ Coverage         0   51.1106%   +51.1106%     
- Complexity       0      17596      +17596     
================================================
  Files            0       2041       +2041     
  Lines            0      95493      +95493     
  Branches         0      16587      +16587     
================================================
+ Hits             0      48807      +48807     
- Misses           0      39399      +39399     
- Partials         0       7287       +7287     

see 2041 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread grails-doc/src/en/guide/conf/config/logging.adoc Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

@davydotcom davydotcom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looks good,

@testlens-app

testlens-app Bot commented Jul 17, 2026

Copy link
Copy Markdown

✅ All tests passed ✅

🏷️ Commit: e2ee974
▶️ Tests: 4221 executed
⚪️ Checks: 59/59 completed


Learn more about TestLens at testlens.app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants