Skip to content

explore: document sortable-dataset contract, drop dead discover entry #1524

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

Merged
BYK merged 1 commit into from
Sep 2, 2026
Merged

explore: document sortable-dataset contract, drop dead discover entry #1524

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
19 changes: 16 additions & 3 deletions packages/cli/src/commands/explore.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,10 +440,23 @@ function validateMetricsFields(fieldList: string[]): void {
/**
* Datasets whose Events endpoint accepts a `sort` param. A deterministic sort
* is what makes offset-based cursor pagination stable — without it, multi-page
* grouped aggregate queries overlap and skip rows (#1519). `metrics` and `logs`
* reject `sort` with a 400, so they stay unsorted.
* grouped aggregate queries overlap and skip rows (#1519). `metrics`
* (`tracemetrics`) and `logs` reject `sort` with a 400, so they stay unsorted.
*
* This is a hand-curated contract, not a machine-readable capability lookup,
* because no canonical source for it exists today (#1523):
* - The OpenAPI spec (`@sentry/api` `listOrganizationEvents`) models `sort`
* as a flat query param whose only documented constraint is "must be in
* the `field` list" — it does not encode which datasets accept it.
* - There is no dataset-capability introspection endpoint in the spec.
* - The spec's `dataset` enum is
* `errors | logs | profile_functions | spans | tracemetrics |
* uptime_results`; `discover` is a legacy virtual dataset that is not a
* valid `--dataset` value here (see {@link DATASET_ALIASES}), so it is
* intentionally omitted.
* Revisit if Sentry ever publishes a per-dataset capability contract.
*/
const SORTABLE_DATASETS = new Set(["spans", "errors", "discover"]);
const SORTABLE_DATASETS = new Set(["spans", "errors"]);

/**
* Dataset-specific configuration resolved before the main query loop.
Expand Down
Loading