Skip to content

[Observability] feat: add metrics of http response #18499

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

TedaLIEz
Copy link
Contributor

Summary

This pull request enhances the OpenTelemetry instrumentation in the ext_otel.py file by introducing a new HTTP response counter to track the total number of HTTP responses by status code. It also updates the imports to include the required get_meter function for metrics.

Enhancements to OpenTelemetry instrumentation:

  • Added HTTP response counter for metrics tracking: Introduced a new counter _http_response_counter using the get_meter function to track the total number of HTTP responses, categorized by status code and status class. This counter is updated in the response_hook function. ([api/extensions/ext_otel.pyR115-R131](https://github.com/langgenius/dify/pull/18499/files#diff-d9b99e6e386de2f18f686daf1e6fcb87ca02c20900826cbdc5892a5e81f362b6R115-R131))

  • Updated imports for metrics: Added the get_meter import from opentelemetry.metrics to support the new HTTP response counter functionality. ([api/extensions/ext_otel.pyL17-R17](https://github.com/langgenius/dify/pull/18499/files#diff-d9b99e6e386de2f18f686daf1e6fcb87ca02c20900826cbdc5892a5e81f362b6L17-R17))

We can use sum(increase(http_server_response_count{status_class=~"4xx|5xx"}[30m])) / sum(increase(http_server_response_count[30m])) * 100 to measure the error rate after setting up this metric.

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

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. 💪 enhancement New feature or request 📚 documentation Improvements or additions to documentation labels Apr 21, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 22, 2025
@crazywoola crazywoola merged commit de750a6 into langgenius:main Apr 22, 2025
6 checks passed
@TedaLIEz TedaLIEz deleted the user/guojian/feat_update_otel_response_count branch April 23, 2025 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation 💪 enhancement New feature or request lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants