Class MicrometerMetricsChatModelListener

java.lang.Object

dev.langchain4j.micrometer.metrics.listeners.MicrometerMetricsChatModelListener

All Implemented Interfaces:

ChatModelListener

@Experimental
public class MicrometerMetricsChatModelListener
extends Object
implements ChatModelListener

A ChatModelListener that uses a Micrometer MeterRegistry to collect metrics about chat model interactions following OpenTelemetry Semantic Conventions for Generative AI.

This listener records token usage metrics (input and output tokens) when a chat model response is received, using a DistributionSummary consistent with the OpenTelemetry Semantic Conventions for gen_ai.client.token.usage.

Histogram publishing and bucket boundaries are not configured by this listener. Users can enable histograms and set bucket boundaries through their MeterRegistry configuration (e.g., via Spring Boot properties or MeterFilter).

Note: The MicrometerMetricsChatModelListener must be instantiated separately (e.g., via Spring Boot auto-configuration or manual instantiation).

Constructor Summary

Constructors

Constructor	Description
MicrometerMetricsChatModelListener(io.micrometer.core.instrument.MeterRegistry meterRegistry)	Creates a new MicrometerMetricsChatModelListener.

Method Summary

Modifier and Type	Method	Description
void	onError(ChatModelErrorContext errorContext)
void	onRequest(ChatModelRequestContext requestContext)
void	onResponse(ChatModelResponseContext responseContext)

Methods inherited from class Object

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

Constructor Details

MicrometerMetricsChatModelListener

public MicrometerMetricsChatModelListener(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Creates a new MicrometerMetricsChatModelListener.

Parameters:

meterRegistry - the MeterRegistry to register metrics with

Method Details

onRequest

public void onRequest(ChatModelRequestContext requestContext)

Specified by:

onRequest in interface ChatModelListener

onResponse

public void onResponse(ChatModelResponseContext responseContext)

Specified by:

onResponse in interface ChatModelListener

onError

public void onError(ChatModelErrorContext errorContext)

Specified by:

onError in interface ChatModelListener