langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-07-21 12:05:30 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

[PR #18821] [Observability] Convert exception logging into span in OpenTelemetry #29009

New Issue
Closed
opened 2026-02-21 20:44:41 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 20:44:41 -05:00
Owner
Copy Link
Copy Source

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

State: closed
Merged: Yes

Summary

Add OpenTelemetry Integration for Exception Logging

Problem

Currently, our API service uses a common try-except pattern with logging.exception() to handle errors, with over 60 files following this pattern and over 130 instances of logging.exception() calls.

try:
    ...
except Exception as e:
    logging.exception("xxxx")
... # function keeps running

While this approach logs errors to files, it lacks proper context and structure, making it difficult to:

  • Track error patterns across the application
  • Correlate errors with specific requests or operations
  • Analyze error impact on system performance
  • Maintain consistent error reporting across different services

Solution

This PR introduces OpenTelemetry integration for exception logging by:

  1. Adding a custom ExceptionLoggingHandler that automatically creates OpenTelemetry spans for logging.exception() calls, capturing:

    • Log level and message
    • Logger name and source location (file path and line number)
    • Exception type and message
    • Stack trace information
    • Error status and context

  2. Integrating the handler into the application initialization process through:

    • Automatic registration during app startup
    • Seamless integration with existing logging infrastructure
    • Preservation of existing logging behavior while adding tracing capabilities

Screenshots

Before After
... image

Checklist

Important

Please review the checklist below before submitting your pull request.

  • 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/18821 **State:** closed **Merged:** Yes --- # Summary # Add OpenTelemetry Integration for Exception Logging ## Problem Currently, our API service uses a common try-except pattern with `logging.exception()` to handle errors, with over 60 files following this pattern and over 130 instances of `logging.exception()` calls. ```python try: ... except Exception as e: logging.exception("xxxx") ... # function keeps running ``` While this approach logs errors to files, it lacks proper context and structure, making it difficult to: - Track error patterns across the application - Correlate errors with specific requests or operations - Analyze error impact on system performance - Maintain consistent error reporting across different services ## Solution This PR introduces OpenTelemetry integration for exception logging by: 1. Adding a custom `ExceptionLoggingHandler` that automatically creates OpenTelemetry spans for `logging.exception()` calls, capturing: - Log level and message - Logger name and source location (file path and line number) - Exception type and message - Stack trace information - Error status and context 2. Integrating the handler into the application initialization process through: - Automatic registration during app startup - Seamless integration with existing logging infrastructure - Preservation of existing logging behavior while adding tracing capabilities # Screenshots | Before | After | |--------|-------| | ... | ![image](https://github.com/user-attachments/assets/75fcce3e-3288-4fe3-9e20-bee84b5a1cf6) | # Checklist > [!IMPORTANT] > Please review the checklist below before submitting your pull request. - [ ] 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:44:41 -05:00
yindo closed this issue 2026-02-21 20:44:41 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#29009
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?