llm4s-docs/org.llm4s/org.llm4s.llmconnect/org.llm4s.llmconnect.provider/MetricsRecording

MetricsRecording

org.llm4s.llmconnect.provider.MetricsRecording

@Stable

Helper trait for recording metrics consistently across all provider clients.

Extracts the common pattern of timing requests, observing outcomes, recording tokens, and reading costs from completion results.

Attributes

Graph
Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait BaseLifecycleLLMClient

class AnthropicClient

class BedrockClient

class GeminiClient

class OllamaClient

class OpenAIClient

class OpenAICompatibleClient

class CohereClient

class DeepSeekClient

class MistralClient

class OpenRouterClient

class XaiClient

class ZaiClient

class PerplexityClient

class VertexAIClient

class WatsonXClient
Show all

Members list

Value members

Abstract methods

The org.llm4s.metrics.MetricsCollector that receives timing, token, and cost events.

Injected by each concrete provider client. Defaults to MetricsCollector.noop in all public constructors, so callers that do not need metrics do not pay an allocation cost.

Attributes

Concrete methods

Executes operation and records metrics for the call.

Latency and outcome (success or classified error) are recorded for every call regardless of result. Token counts and cost are recorded only on success — a Left result emits an Outcome.Error (org.llm4s.metrics.Outcome) event whose kind is derived from the org.llm4s.error.LLMError subtype via ErrorKind.fromLLMError.

Value parameters

extractCost: Extracts the pre-computed cost (USD) from a successful result; return None to skip cost recording.
extractUsage: Extracts prompt/completion token counts from a successful result; return None to skip token recording.
model: Model identifier forwarded to the collector.
operation: The LLM call to time and observe.
provider: Provider label forwarded to the collector (e.g. "openai").

Attributes

Returns: The result of operation, unchanged.

In this article

Generated with