Package org.springframework.ai.chat.client.observation

Class DefaultChatClientObservationConvention

java.lang.Object

org.springframework.ai.chat.client.observation.DefaultChatClientObservationConvention

All Implemented Interfaces:

io.micrometer.observation.KeyValuesConvention, io.micrometer.observation.ObservationConvention<ChatClientObservationContext>, ChatClientObservationConvention

public class DefaultChatClientObservationConvention
extends Object
implements ChatClientObservationConvention

Default conventions to populate observations for chat client workflows.

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME

Fields inherited from interface io.micrometer.observation.ObservationConvention

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultChatClientObservationConvention()
DefaultChatClientObservationConvention(String name)

Method Summary

Modifier and Type	Method	Description
protected io.micrometer.common.KeyValue	aiOperationType(ChatClientObservationContext context)
protected io.micrometer.common.KeyValue	aiProvider(ChatClientObservationContext context)
protected io.micrometer.common.KeyValues	chatClientAdvisorNames(io.micrometer.common.KeyValues keyValues, ChatClientObservationContext context)
protected io.micrometer.common.KeyValues	chatClientAdvisorParams(io.micrometer.common.KeyValues keyValues, ChatClientObservationContext context)
String	getContextualName(ChatClientObservationContext context)
io.micrometer.common.KeyValues	getHighCardinalityKeyValues(ChatClientObservationContext context)
io.micrometer.common.KeyValues	getLowCardinalityKeyValues(ChatClientObservationContext context)
String	getName()
protected io.micrometer.common.KeyValue	springAiKind()
protected io.micrometer.common.KeyValue	stream(ChatClientObservationContext context)
protected io.micrometer.common.KeyValues	toolFunctionCallbacks(io.micrometer.common.KeyValues keyValues, ChatClientObservationContext context)
protected io.micrometer.common.KeyValues	toolFunctionNames(io.micrometer.common.KeyValues keyValues, ChatClientObservationContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.chat.client.observation.ChatClientObservationConvention

supportsContext

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

• Constant Field Values

Constructor Details

DefaultChatClientObservationConvention

public DefaultChatClientObservationConvention()

DefaultChatClientObservationConvention

public DefaultChatClientObservationConvention(String name)

Method Details

getName

public String getName()

Specified by:

getName in interface io.micrometer.observation.ObservationConvention<ChatClientObservationContext>

getContextualName

@Nullable
public String getContextualName(ChatClientObservationContext context)

Specified by:

getContextualName in interface io.micrometer.observation.ObservationConvention<ChatClientObservationContext>

getLowCardinalityKeyValues

public io.micrometer.common.KeyValues getLowCardinalityKeyValues(ChatClientObservationContext context)

Specified by:

getLowCardinalityKeyValues in interface io.micrometer.observation.ObservationConvention<ChatClientObservationContext>

aiOperationType

protected io.micrometer.common.KeyValue aiOperationType(ChatClientObservationContext context)

aiProvider

protected io.micrometer.common.KeyValue aiProvider(ChatClientObservationContext context)

springAiKind

protected io.micrometer.common.KeyValue springAiKind()

stream

protected io.micrometer.common.KeyValue stream(ChatClientObservationContext context)

getHighCardinalityKeyValues

public io.micrometer.common.KeyValues getHighCardinalityKeyValues(ChatClientObservationContext context)

Specified by:

getHighCardinalityKeyValues in interface io.micrometer.observation.ObservationConvention<ChatClientObservationContext>

chatClientAdvisorNames

protected io.micrometer.common.KeyValues chatClientAdvisorNames(io.micrometer.common.KeyValues keyValues,
 ChatClientObservationContext context)

chatClientAdvisorParams

protected io.micrometer.common.KeyValues chatClientAdvisorParams(io.micrometer.common.KeyValues keyValues,
 ChatClientObservationContext context)

toolFunctionNames

protected io.micrometer.common.KeyValues toolFunctionNames(io.micrometer.common.KeyValues keyValues,
 ChatClientObservationContext context)

toolFunctionCallbacks

protected io.micrometer.common.KeyValues toolFunctionCallbacks(io.micrometer.common.KeyValues keyValues,
 ChatClientObservationContext context)