|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package io.opentelemetry.instrumentation.api.incubator.semconv.genai; |
| 7 | + |
| 8 | +import static io.opentelemetry.api.common.AttributeKey.stringKey; |
| 9 | +import static io.opentelemetry.instrumentation.api.incubator.semconv.genai.GenAiAttributesExtractor.GEN_AI_USAGE_INPUT_TOKENS; |
| 10 | +import static io.opentelemetry.instrumentation.api.incubator.semconv.genai.GenAiAttributesExtractor.GEN_AI_USAGE_OUTPUT_TOKENS; |
| 11 | +import static java.util.logging.Level.FINE; |
| 12 | + |
| 13 | +import com.google.auto.value.AutoValue; |
| 14 | +import io.opentelemetry.api.common.AttributeKey; |
| 15 | +import io.opentelemetry.api.common.Attributes; |
| 16 | +import io.opentelemetry.api.common.AttributesBuilder; |
| 17 | +import io.opentelemetry.api.metrics.DoubleHistogram; |
| 18 | +import io.opentelemetry.api.metrics.DoubleHistogramBuilder; |
| 19 | +import io.opentelemetry.api.metrics.LongHistogram; |
| 20 | +import io.opentelemetry.api.metrics.LongHistogramBuilder; |
| 21 | +import io.opentelemetry.api.metrics.Meter; |
| 22 | +import io.opentelemetry.context.Context; |
| 23 | +import io.opentelemetry.context.ContextKey; |
| 24 | +import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientMetrics; |
| 25 | +import io.opentelemetry.instrumentation.api.instrumenter.OperationListener; |
| 26 | +import io.opentelemetry.instrumentation.api.instrumenter.OperationMetrics; |
| 27 | +import io.opentelemetry.instrumentation.api.internal.OperationMetricsUtil; |
| 28 | +import java.util.concurrent.TimeUnit; |
| 29 | +import java.util.logging.Logger; |
| 30 | + |
| 31 | +/** |
| 32 | + * {@link OperationListener} which keeps track of <a |
| 33 | + * href="https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-metrics/#generative-ai-client-metrics">Generative |
| 34 | + * AI Client Metrics</a>. |
| 35 | + */ |
| 36 | +public final class GenAiClientMetrics implements OperationListener { |
| 37 | + |
| 38 | + private static final double NANOS_PER_S = TimeUnit.SECONDS.toNanos(1); |
| 39 | + |
| 40 | + private static final ContextKey<State> GEN_AI_CLIENT_METRICS_STATE = |
| 41 | + ContextKey.named("gen-ai-client-metrics-state"); |
| 42 | + |
| 43 | + private static final Logger logger = Logger.getLogger(DbClientMetrics.class.getName()); |
| 44 | + |
| 45 | + static final AttributeKey<String> GEN_AI_TOKEN_TYPE = stringKey("gen_ai.token.type"); |
| 46 | + |
| 47 | + /** |
| 48 | + * Returns an {@link OperationMetrics} instance which can be used to enable recording of {@link |
| 49 | + * GenAiClientMetrics}. |
| 50 | + * |
| 51 | + * @see |
| 52 | + * io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder#addOperationMetrics(OperationMetrics) |
| 53 | + */ |
| 54 | + public static OperationMetrics get() { |
| 55 | + return OperationMetricsUtil.create("gen_ai client", GenAiClientMetrics::new); |
| 56 | + } |
| 57 | + |
| 58 | + private final LongHistogram tokenUsage; |
| 59 | + private final DoubleHistogram operationDuration; |
| 60 | + |
| 61 | + private GenAiClientMetrics(Meter meter) { |
| 62 | + LongHistogramBuilder tokenUsageBuilder = |
| 63 | + meter |
| 64 | + .histogramBuilder("gen_ai.client.token.usage") |
| 65 | + .ofLongs() |
| 66 | + .setUnit("{token}") |
| 67 | + .setDescription("Measures number of input and output tokens used") |
| 68 | + .setExplicitBucketBoundariesAdvice(GenAiMetricsAdvice.CLIENT_TOKEN_USAGE_BUCKETS); |
| 69 | + GenAiMetricsAdvice.applyClientTokenUsageAdvice(tokenUsageBuilder); |
| 70 | + this.tokenUsage = tokenUsageBuilder.build(); |
| 71 | + DoubleHistogramBuilder operationDurationBuilder = |
| 72 | + meter |
| 73 | + .histogramBuilder("gen_ai.client.operation.duration") |
| 74 | + .setUnit("s") |
| 75 | + .setDescription("GenAI operation duration") |
| 76 | + .setExplicitBucketBoundariesAdvice( |
| 77 | + GenAiMetricsAdvice.CLIENT_OPERATION_DURATION_BUCKETS); |
| 78 | + GenAiMetricsAdvice.applyClientOperationDurationAdvice(operationDurationBuilder); |
| 79 | + this.operationDuration = operationDurationBuilder.build(); |
| 80 | + } |
| 81 | + |
| 82 | + @Override |
| 83 | + public Context onStart(Context context, Attributes startAttributes, long startNanos) { |
| 84 | + return context.with( |
| 85 | + GEN_AI_CLIENT_METRICS_STATE, |
| 86 | + new AutoValue_GenAiClientMetrics_State(startAttributes, startNanos)); |
| 87 | + } |
| 88 | + |
| 89 | + @Override |
| 90 | + public void onEnd(Context context, Attributes endAttributes, long endNanos) { |
| 91 | + State state = context.get(GEN_AI_CLIENT_METRICS_STATE); |
| 92 | + if (state == null) { |
| 93 | + logger.log( |
| 94 | + FINE, |
| 95 | + "No state present when ending context {0}. Cannot record gen_ai operation metrics.", |
| 96 | + context); |
| 97 | + return; |
| 98 | + } |
| 99 | + |
| 100 | + AttributesBuilder attributesBuilder = state.startAttributes().toBuilder().putAll(endAttributes); |
| 101 | + |
| 102 | + operationDuration.record( |
| 103 | + (endNanos - state.startTimeNanos()) / NANOS_PER_S, attributesBuilder.build(), context); |
| 104 | + |
| 105 | + Long inputTokens = endAttributes.get(GEN_AI_USAGE_INPUT_TOKENS); |
| 106 | + if (inputTokens != null) { |
| 107 | + tokenUsage.record( |
| 108 | + inputTokens, attributesBuilder.put(GEN_AI_TOKEN_TYPE, "input").build(), context); |
| 109 | + } |
| 110 | + Long outputTokens = endAttributes.get(GEN_AI_USAGE_OUTPUT_TOKENS); |
| 111 | + if (outputTokens != null) { |
| 112 | + tokenUsage.record( |
| 113 | + outputTokens, attributesBuilder.put(GEN_AI_TOKEN_TYPE, "output").build(), context); |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + @AutoValue |
| 118 | + abstract static class State { |
| 119 | + abstract Attributes startAttributes(); |
| 120 | + |
| 121 | + abstract long startTimeNanos(); |
| 122 | + } |
| 123 | +} |
0 commit comments