Package org.springframework.ai.vectorstore.observation

Class DefaultVectorStoreObservationConvention

java.lang.Object

org.springframework.ai.vectorstore.observation.DefaultVectorStoreObservationConvention

All Implemented Interfaces:

io.micrometer.observation.KeyValuesConvention, io.micrometer.observation.ObservationConvention<VectorStoreObservationContext>, VectorStoreObservationConvention

public class DefaultVectorStoreObservationConvention
extends Object
implements VectorStoreObservationConvention

Default conventions to populate observations for vector store operations.

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
DefaultVectorStoreObservationConvention()
DefaultVectorStoreObservationConvention(String name)

Method Summary

Modifier and Type	Method	Description
protected io.micrometer.common.KeyValues	collectionName(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
protected io.micrometer.common.KeyValue	dbOperationName(VectorStoreObservationContext context)
protected io.micrometer.common.KeyValue	dbSystem(VectorStoreObservationContext context)
protected io.micrometer.common.KeyValues	dimensions(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
protected io.micrometer.common.KeyValues	fieldName(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
String	getContextualName(VectorStoreObservationContext context)
io.micrometer.common.KeyValues	getHighCardinalityKeyValues(VectorStoreObservationContext context)
io.micrometer.common.KeyValues	getLowCardinalityKeyValues(VectorStoreObservationContext context)
String	getName()
protected io.micrometer.common.KeyValues	metadataFilter(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
protected io.micrometer.common.KeyValues	namespace(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
protected io.micrometer.common.KeyValues	queryContent(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
protected io.micrometer.common.KeyValues	similarityMetric(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
protected io.micrometer.common.KeyValues	similarityThreshold(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext context)
protected io.micrometer.common.KeyValue	springAiKind()
protected io.micrometer.common.KeyValues	topK(io.micrometer.common.KeyValues keyValues, VectorStoreObservationContext 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.vectorstore.observation.VectorStoreObservationConvention

supportsContext

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

• Constant Field Values

Constructor Details

DefaultVectorStoreObservationConvention

public DefaultVectorStoreObservationConvention()

DefaultVectorStoreObservationConvention

public DefaultVectorStoreObservationConvention(String name)

Method Details

getName

public String getName()

Specified by:

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

getContextualName

@Nullable
public String getContextualName(VectorStoreObservationContext context)

Specified by:

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

getLowCardinalityKeyValues

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

Specified by:

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

springAiKind

protected io.micrometer.common.KeyValue springAiKind()

dbSystem

protected io.micrometer.common.KeyValue dbSystem(VectorStoreObservationContext context)

dbOperationName

protected io.micrometer.common.KeyValue dbOperationName(VectorStoreObservationContext context)

getHighCardinalityKeyValues

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

Specified by:

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

collectionName

protected io.micrometer.common.KeyValues collectionName(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

dimensions

protected io.micrometer.common.KeyValues dimensions(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

fieldName

protected io.micrometer.common.KeyValues fieldName(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

metadataFilter

protected io.micrometer.common.KeyValues metadataFilter(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

namespace

protected io.micrometer.common.KeyValues namespace(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

queryContent

protected io.micrometer.common.KeyValues queryContent(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

similarityMetric

protected io.micrometer.common.KeyValues similarityMetric(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

similarityThreshold

protected io.micrometer.common.KeyValues similarityThreshold(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)

topK

protected io.micrometer.common.KeyValues topK(io.micrometer.common.KeyValues keyValues,
 VectorStoreObservationContext context)