mirror of
https://github.com/chatwoot/chatwoot.git
synced 2026-06-04 21:02:35 +08:00
# Pull Request Template ## Description We need to pass on trace level attributes down to the spans inside them like tool calls, observations, etc. This way, we can filter observations based on trace level attributes. ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. Attributes added to observation metadata for easy filtering <img width="1327" height="708" alt="image" src="https://github.com/user-attachments/assets/8f1d1bf8-cde4-481d-a2c2-7920ad2fc52e" /> added a `generation_stage` to differentiate llm_calls that call tools vs those that generate a `final_response` <img width="1806" height="968" alt="CleanShot 2026-06-03 at 15 11 09@2x" src="https://github.com/user-attachments/assets/db1fa8e0-7f2d-404b-a719-27a16d400442" /> propagated attributes to tool calls for future use <img width="903" height="517" alt="image" src="https://github.com/user-attachments/assets/edc61ce8-93db-465c-a66e-043138e2dc15" /> ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published in downstream modules
112 lines
3.7 KiB
Ruby
112 lines
3.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'opentelemetry_config'
|
|
|
|
module Integrations::LlmInstrumentationSpans
|
|
include Integrations::LlmInstrumentationConstants
|
|
|
|
def tracer
|
|
@tracer ||= OpentelemetryConfig.tracer
|
|
end
|
|
|
|
def start_llm_turn_span(params)
|
|
return unless ChatwootApp.otel_enabled?
|
|
|
|
span = tracer.start_span(params[:span_name])
|
|
set_llm_turn_request_attributes(span, params)
|
|
set_llm_turn_prompt_attributes(span, params[:messages]) if params[:messages]
|
|
|
|
@pending_llm_turn_spans ||= []
|
|
@pending_llm_turn_spans.push(span)
|
|
rescue StandardError => e
|
|
Rails.logger.warn "Failed to start LLM turn span: #{e.message}"
|
|
end
|
|
|
|
def end_llm_turn_span(message)
|
|
return unless ChatwootApp.otel_enabled?
|
|
|
|
span = @pending_llm_turn_spans&.pop
|
|
return unless span
|
|
|
|
set_llm_turn_response_attributes(span, message) if message
|
|
span.finish
|
|
rescue StandardError => e
|
|
Rails.logger.warn "Failed to end LLM turn span: #{e.message}"
|
|
end
|
|
|
|
def start_tool_span(tool_call)
|
|
return unless ChatwootApp.otel_enabled?
|
|
|
|
tool_name = tool_call.name.to_s
|
|
span = tracer.start_span(format(TOOL_SPAN_NAME, tool_name))
|
|
apply_current_langfuse_attributes(span)
|
|
span.set_attribute(ATTR_LANGFUSE_OBSERVATION_TYPE, 'tool')
|
|
span.set_attribute(ATTR_LANGFUSE_OBSERVATION_INPUT, tool_call.arguments.to_json)
|
|
|
|
@pending_tool_spans ||= []
|
|
@pending_tool_spans.push(span)
|
|
rescue StandardError => e
|
|
Rails.logger.warn "Failed to start tool span: #{e.message}"
|
|
end
|
|
|
|
def end_tool_span(result)
|
|
return unless ChatwootApp.otel_enabled?
|
|
|
|
span = @pending_tool_spans&.pop
|
|
return unless span
|
|
|
|
output = result.is_a?(String) ? result : result.to_json
|
|
span.set_attribute(ATTR_LANGFUSE_OBSERVATION_OUTPUT, output)
|
|
span.finish
|
|
rescue StandardError => e
|
|
Rails.logger.warn "Failed to end tool span: #{e.message}"
|
|
end
|
|
|
|
def instrument_with_span(span_name, params, &)
|
|
result = nil
|
|
executed = false
|
|
tracer.in_span(span_name) do |span|
|
|
set_metadata_attributes(span, params)
|
|
track_result = lambda do |r|
|
|
executed = true
|
|
result = r
|
|
end
|
|
yield(span, track_result)
|
|
end
|
|
rescue StandardError => e
|
|
ChatwootExceptionTracker.new(e, account: resolve_account(params)).capture_exception
|
|
raise unless executed
|
|
|
|
result
|
|
end
|
|
|
|
private
|
|
|
|
def set_llm_turn_request_attributes(span, params)
|
|
provider = determine_provider(params[:model])
|
|
span.set_attribute(ATTR_GEN_AI_PROVIDER, provider)
|
|
span.set_attribute(ATTR_GEN_AI_REQUEST_MODEL, params[:model]) if params[:model]
|
|
span.set_attribute(ATTR_GEN_AI_REQUEST_TEMPERATURE, params[:temperature]) if params[:temperature]
|
|
end
|
|
|
|
def set_llm_turn_prompt_attributes(span, messages)
|
|
messages.each_with_index do |msg, idx|
|
|
span.set_attribute(format(ATTR_GEN_AI_PROMPT_ROLE, idx), msg[:role])
|
|
span.set_attribute(format(ATTR_GEN_AI_PROMPT_CONTENT, idx), msg[:content])
|
|
end
|
|
span.set_attribute(ATTR_LANGFUSE_OBSERVATION_INPUT, messages.to_json)
|
|
end
|
|
|
|
def set_llm_turn_response_attributes(span, message)
|
|
span.set_attribute(ATTR_GEN_AI_COMPLETION_ROLE, message.role.to_s) if message.respond_to?(:role)
|
|
span.set_attribute(ATTR_GEN_AI_COMPLETION_CONTENT, message.content.to_s) if message.respond_to?(:content)
|
|
set_llm_turn_usage_attributes(span, message)
|
|
span.set_attribute(ATTR_LANGFUSE_OBSERVATION_OUTPUT, message.content.to_s) if message.respond_to?(:content)
|
|
end
|
|
|
|
def set_llm_turn_usage_attributes(span, message)
|
|
span.set_attribute(ATTR_GEN_AI_USAGE_INPUT_TOKENS, message.input_tokens) if message.respond_to?(:input_tokens) && message.input_tokens
|
|
span.set_attribute(ATTR_GEN_AI_USAGE_OUTPUT_TOKENS, message.output_tokens) if message.respond_to?(:output_tokens) && message.output_tokens
|
|
end
|
|
end
|