[PR #30170] feat(refactoring): Support Structured Logging (JSON) #32718

Closed
opened 2026-02-21 20:51:56 -05:00 by yindo · 0 comments
Owner

Original Pull Request: https://github.com/langgenius/dify/pull/30170

State: closed
Merged: Yes


Important

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #<issue number>.

Fixes #30169

Summary

What

This PR introduces structured logging support (JSON format) to the backend service. It standardizes log outputs, making them machine-readable and consistent.

Why

To better integrate with modern log aggregation and observability systems (e.g., ELK, Datadog, Loki). Structured logging eliminates the need for complex regex parsing and improves query capabilities on log fields.

Key Changes

  • Refactored logging implementation to support JSON serialization.
  • Unified log field naming (e.g., level, msg, ts, trace_id).
  • Added configuration to toggle between console (text) and json formats (defaulting to text for dev environments).

Fixes #30169

Screenshots

Before After
image image

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
**Original Pull Request:** https://github.com/langgenius/dify/pull/30170 **State:** closed **Merged:** Yes --- > [!IMPORTANT] > > 1. Make sure you have read our [contribution guidelines](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md) > 1. Ensure there is an associated issue and you have been assigned to it > 1. Use the correct syntax to link this PR: `Fixes #<issue number>`. Fixes #30169 ## Summary <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ### What This PR introduces structured logging support (JSON format) to the backend service. It standardizes log outputs, making them machine-readable and consistent. ### Why To better integrate with modern log aggregation and observability systems (e.g., ELK, Datadog, Loki). Structured logging eliminates the need for complex regex parsing and improves query capabilities on log fields. ### Key Changes - Refactored logging implementation to support **JSON** serialization. - Unified log field naming (e.g., `level`, `msg`, `ts`, `trace_id`). - Added configuration to toggle between `console` (text) and `json` formats (defaulting to text for dev environments). Fixes #30169 ## Screenshots | Before | After | |--------|-------| | <img width="1841" height="795" alt="image" src="https://github.com/user-attachments/assets/d9a09f77-5813-40fb-9862-3725f422f0d2" />|<img width="1831" height="739" alt="image" src="https://github.com/user-attachments/assets/14619559-add9-447f-b032-c7ec4deed2f8" />| ## Checklist - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!) - [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. - [x] I've updated the documentation accordingly. - [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods
yindo added the pull-request label 2026-02-21 20:51:56 -05:00
yindo closed this issue 2026-02-21 20:51:56 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#32718