Remove telemetry API data limits and refactor URL builders#16020
Merged
Remove telemetry API data limits and refactor URL builders#16020
Conversation
- Remove MaxQueryCount from TelemetryApiService, use int.MaxValue so storage queries return all data and limits are controlled by callers. - Add TelemetryCommandHelpers.MaxTelemetryLimit (int.MaxValue) for CLI export and MCP tools to fetch all available telemetry data. - Refactor DashboardUrls telemetry URL builders from params tuples to explicit named parameters matching MapTelemetryApi endpoints. - Replace BuildQueryString with AddQueryString pattern for consistency. - Update tests for new URL builder signatures and large limit scenarios.
Add GetSpans_WithLimit_ReturnsMostRecentSpans, GetTraces_WithLimit_ReturnsMostRecentTraces, and GetLogs_WithLimit_ReturnsMostRecentLogs tests to TelemetryApiServiceTests.
JamesNK
requested review from
adamint,
davidfowl,
eerhardt,
mitchdenny and
radical
as code owners
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 16020Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 16020" |
Contributor
There was a problem hiding this comment.
Pull request overview
Removes artificial data caps in the dashboard telemetry API/CLI flows (so exports and MCP tools don’t silently truncate), and refactors telemetry URL builders in DashboardUrls to use explicit, endpoint-aligned parameters.
Changes:
- Updated dashboard telemetry API queries to request all stored items (
Count = int.MaxValue) and rely on the caller-providedlimitfor truncation. - Added a CLI-side “fetch max available” limit constant and propagated it to export + MCP telemetry fetches.
- Refactored
DashboardUrlstelemetry URL builders to explicit parameters and aligned query-string building with the existingAddQueryStringpattern; updated/added unit and integration tests.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/Shared/Telemetry/TelemetryTestHelpers.cs | Adds maxLogCount option to allow large-log scenarios in tests. |
| tests/Aspire.Dashboard.Tests/TelemetryApiServiceTests.cs | Adds coverage for “limit returns most recent” and large-limit log retrieval. |
| tests/Aspire.Dashboard.Tests/Integration/TelemetryApiTests.cs | Updates integration coverage to use very large limit values in query-param checks. |
| tests/Aspire.Cli.Tests/Commands/TelemetryCommandTests.cs | Updates tests to validate new telemetry logs URL builder behavior. |
| src/Shared/DashboardUrls.cs | Refactors telemetry URL builders to explicit parameters and uses AddQueryString + shared resource param appending. |
| src/Aspire.Dashboard/Api/TelemetryApiService.cs | Removes MaxQueryCount and requests all stored telemetry items from storage before applying API-level limit. |
| src/Aspire.Cli/Mcp/Tools/ListTraceStructuredLogsTool.cs | Ensures MCP trace structured logs fetch requests the maximum available data. |
| src/Aspire.Cli/Mcp/Tools/ListTracesTool.cs | Ensures MCP traces fetch requests the maximum available data. |
| src/Aspire.Cli/Mcp/Tools/ListStructuredLogsTool.cs | Ensures MCP structured logs fetch requests the maximum available data. |
| src/Aspire.Cli/Commands/TelemetryTracesCommand.cs | Simplifies URL construction using new typed URL builder parameters. |
| src/Aspire.Cli/Commands/TelemetrySpansCommand.cs | Simplifies URL construction and preserves follow-mode limit behavior via typed URL builder parameters. |
| src/Aspire.Cli/Commands/TelemetryLogsCommand.cs | Simplifies URL construction and preserves follow-mode limit behavior via typed URL builder parameters. |
| src/Aspire.Cli/Commands/TelemetryCommandHelpers.cs | Adds MaxTelemetryLimit constant (used to request “max available” results). |
| src/Aspire.Cli/Commands/ExportCommand.cs | Ensures export fetches all available structured logs/traces in a single API call. |
Comments suppressed due to low confidence (2)
src/Aspire.Dashboard/Api/TelemetryApiService.cs:56
- When multiple resources are specified, this method queries the repository once per resource key and then aggregates results with AddRange. Traces/spans that involve more than one of the selected resources can be returned multiple times, inflating TotalCount/ReturnedCount and potentially causing duplicates in the response. Consider deduplicating by (TraceId, SpanId) after aggregation or changing the query strategy to avoid per-resource queries for multi-resource filters.
foreach (var resourceKey in resourceKeys)
{
var result = telemetryRepository.GetTraces(new GetTracesRequest
{
ResourceKey = resourceKey,
StartIndex = 0,
Count = int.MaxValue,
Filters = [],
FilterText = string.Empty
});
allSpans.AddRange(result.PagedResult.Items.SelectMany(t => t.Spans));
src/Aspire.Dashboard/Api/TelemetryApiService.cs:127
- For multi-resource filters, aggregating GetTraces results per resource key can duplicate the same trace when it contains spans from more than one selected resource. This can skew TotalCount/ReturnedCount and cause duplicates to be returned/limited incorrectly. Consider deduplicating by TraceId after aggregation (or avoid per-resource querying when multiple resource names are supplied).
foreach (var resourceKey in resourceKeys)
{
var result = telemetryRepository.GetTraces(new GetTracesRequest
{
ResourceKey = resourceKey,
StartIndex = 0,
Count = int.MaxValue,
Filters = [],
FilterText = string.Empty
});
allTraces.AddRange(result.PagedResult.Items);
Contributor
|
🎬 CLI E2E Test Recordings — 55 recordings uploaded (commit View recordings
📹 Recordings uploaded automatically from CI run #24216472327 |
mitchdenny
approved these changes
Apr 9, 2026
Member
Author
|
/backport to release/13.2 |
Contributor
|
Started backporting to |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Remove artificial telemetry data limits in the dashboard API and CLI, and refactor URL builder methods for type safety and consistency.
Changes:
MaxQueryCountfromTelemetryApiService: Storage queries now useint.MaxValueso all data is returned and limits are controlled by the caller'slimitparameter.TelemetryCommandHelpers.MaxTelemetryLimit(int.MaxValue): CLI export and MCP tools pass this to fetch all available telemetry data in a single API call.DashboardUrlstelemetry URL builders: Changed fromparams (string, string?)[]tuples to explicit named parameters matchingMapTelemetryApiendpoints, improving type safety and discoverability.BuildQueryStringwithAddQueryStringpattern: Aligns telemetry URL construction with the existing pattern used byStructuredLogsUrland other URL builders in the same class.Motivation: The export command and MCP tools were silently truncating telemetry data due to default limits (100 traces, 200 logs) when no
limitparameter was passed. This made exports incomplete without any warning.Checklist