Skip to content

feat: Update token usage reporting to include thoughts and cache tokens #1284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
+59 −2
Open

feat: Update token usage reporting to include thoughts and cache tokens #1284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions core/src/main/java/com/google/adk/telemetry/Tracing.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ public class Tracing {
AttributeKey.longKey("gen_ai.usage.input_tokens");
private static final AttributeKey<Long> GEN_AI_USAGE_OUTPUT_TOKENS =
AttributeKey.longKey("gen_ai.usage.output_tokens");
private static final AttributeKey<Long> GEN_AI_USAGE_CACHE_READ_INPUT_TOKENS =
AttributeKey.longKey("gen_ai.usage.cache_read.input_tokens");
private static final AttributeKey<Long> GEN_AI_USAGE_REASONING_OUTPUT_TOKENS =
AttributeKey.longKey("gen_ai.usage.reasoning.output_tokens");

private static final AttributeKey<String> ADK_TOOL_CALL_ARGS =
AttributeKey.stringKey("gcp.vertex.agent.tool_call_args");
Expand Down Expand Up @@ -335,10 +339,23 @@ public static void traceCallLlm(
usage
.promptTokenCount()
.ifPresent(tokens -> span.setAttribute(GEN_AI_USAGE_INPUT_TOKENS, (long) tokens));
// According to OpenTelemetry Semantic Conventions:
// https://github.com/open-telemetry/semantic-conventions/blob/v1.41.0/docs/registry/attributes/gen-ai.md
// gen_ai.usage.reasoning.output_tokens (thoughts_token_count) SHOULD be included in
// gen_ai.usage.output_tokens.
Optional<Integer> candidates = usage.candidatesTokenCount();
Optional<Integer> thoughts = usage.thoughtsTokenCount();
if (candidates.isPresent() || thoughts.isPresent()) {
span.setAttribute(
GEN_AI_USAGE_OUTPUT_TOKENS, (long) candidates.orElse(0) + thoughts.orElse(0));
}
thoughts.ifPresent(
tokens -> span.setAttribute(GEN_AI_USAGE_REASONING_OUTPUT_TOKENS, (long) tokens));
usage
.candidatesTokenCount()
.cachedContentTokenCount()
.ifPresent(
tokens -> span.setAttribute(GEN_AI_USAGE_OUTPUT_TOKENS, (long) tokens));
tokens ->
span.setAttribute(GEN_AI_USAGE_CACHE_READ_INPUT_TOKENS, (long) tokens));
});
llmResponse
.finishReason()
Expand Down
40 changes: 40 additions & 0 deletions core/src/test/java/com/google/adk/telemetry/ContextPropagationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,46 @@ public void testTraceCallLlm() {
assertTrue(attrs.get(AttributeKey.stringKey("gcp.vertex.agent.llm_response")).contains("STOP"));
}

@Test
public void testTraceCallLlm_withReasoningAndCacheTokens() {
Span span = tracer.spanBuilder("test-reasoning").startSpan();
try (Scope scope = span.makeCurrent()) {
LlmRequest llmRequest =
LlmRequest.builder()
.model("gemini-pro")
.contents(ImmutableList.of(Content.fromParts(Part.fromText("hello"))))
.config(GenerateContentConfig.builder().topP(0.9f).maxOutputTokens(100).build())
.build();
LlmResponse llmResponse =
LlmResponse.builder()
.content(Content.builder().parts(Part.fromText("world")).build())
.finishReason(new FinishReason(FinishReason.Known.STOP))
.usageMetadata(
GenerateContentResponseUsageMetadata.builder()
.promptTokenCount(10)
.cachedContentTokenCount(5)
.candidatesTokenCount(20)
.thoughtsTokenCount(15)
.totalTokenCount(50)
.build())
.build();
Tracing.traceCallLlm(
span, buildInvocationContext(), "event-1", llmRequest, llmResponse, null);
} finally {
span.end();
}
List<SpanData> spans = openTelemetryRule.getSpans();
assertThat(spans).hasSize(1);
SpanData spanData = spans.get(0);
Attributes attrs = spanData.getAttributes();
assertEquals(10L, (long) attrs.get(AttributeKey.longKey("gen_ai.usage.input_tokens")));
assertEquals(35L, (long) attrs.get(AttributeKey.longKey("gen_ai.usage.output_tokens")));
assertEquals(
5L, (long) attrs.get(AttributeKey.longKey("gen_ai.usage.cache_read.input_tokens")));
assertEquals(
15L, (long) attrs.get(AttributeKey.longKey("gen_ai.usage.reasoning.output_tokens")));
}

@Test
public void testTraceSendData() {
Span span = tracer.spanBuilder("test").startSpan();
Expand Down