Repository navigation
aitools: classify install errors by standard library error type - #7380
Merged
Merged
Conversation
Add error categories for aitools install failures and classify wrapped standard library errors (network, timeout, interrupt, missing manifest, permission and filesystem errors) by type, without reading error text. JSON decode errors stay UNCATEGORIZED. Co-authored-by: Isaac <no-reply@databricks.com>
Co-authored-by: Isaac <no-reply@databricks.com>
Collaborator
✅ Integration test reportCommit: a6fd339
Top 3 slowest tests (at least 2 minutes):
|
rclarey
approved these changes
Nov 9, 2026
Comment on lines
+50
to
+52
| AitoolsErrorCategoryInvalidFlags AitoolsErrorCategory = "INVALID_FLAGS" | ||
| AitoolsErrorCategoryUnknownAgent AitoolsErrorCategory = "UNKNOWN_AGENT" | ||
| AitoolsErrorCategoryPromptFailed AitoolsErrorCategory = "PROMPT_FAILED" |
Contributor
There was a problem hiding this comment.
Do you already have the PRs that emit these created? Why add them here if they aren't emitted?
rugpanov
approved these changes
Nov 9, 2026
deco-sdk-tagging Bot
added a commit
that referenced
this pull request
Nov 9, 2026
## Release v1.25.0 ### CLI * `databricks aitools install --output json` now reports a more specific `error_category` (`MANIFEST_NOT_FOUND`, `PERMISSION_DENIED`, `FILESYSTEM`) for some failures it reported as `UNCATEGORIZED`. ([#7380](#7380)) * Suggest `databricks auth logout --profile <profile-name> --delete` when multiple profiles match the same workspace in `databricks auth docker` commands. ([#7363](#7363)) * Fix `%pip` in Jupyter notebooks opened over `databricks ssh connect` on serverless environment versions 5 and 6 and on dedicated clusters running recent Databricks Runtime versions, which fell back to the stock IPython magic instead of the Databricks one. ([#7263](#7263)) ### AI Runtime * `databricks air run` now validates the config server-side while it uploads the run artifacts, instead of before, which shortens submission. ([#7368](#7368)) * Remove `CRITICAL` as a valid `compute.priority_class` value; the AI Runtime API no longer accepts it. ([#7371](#7371)) ### Bundles * Built-in templates add the workspace ID to `workspace.host` (`?w=<id>`) when the profile or an environment variable sets it, so generated bundles select the right workspace on hosts shared by several workspaces. Welcome messages show the same URL, and `dbt-sql` also adds `?o=<id>` to the HTTP path it suggests for `dbt init`. ([#7350](#7350)) * Fix grants of a renamed or recreated catalog, schema, volume or other UC resource staying recorded under the old name, which made the next `bundle plan` propose to apply them again. ([#7345](#7345)) * Fix permissions of a recreated pipeline, app, dashboard, model serving endpoint or other resource staying recorded under the old ID, which made every later `bundle plan` propose to apply them again. ([#7361](#7361)) * Add the `postgres_data_apis` resource (Private Preview) for enabling and configuring the Data API of a Lakebase Postgres database. ([#7160](#7160)) * Fixes [#4012](#4012): registered model `aliases` are now set in Unity Catalog on deploy instead of being silently ignored. A model without an `aliases` section keeps the aliases set outside the bundle (for example by MLflow), and `aliases: []` removes them. ([#7163](#7163)) * Include variable declarations and the source of each resolved value in the `--include-locations` output of `bundle validate` and `bundle summary`. ([#7351](#7351)) * Add `.workspace.URLID` to bundle templates: the workspace ID that `.workspace.URL` adds, or empty, so templates can use it without failing when the ID is unknown. ([#7388](#7388)) * Expose the workspace of the selected profile to bundle templates as `.workspace`, with `Hostname`, `ID`, and `URL`, so templates can address a workspace on a host shared by several workspaces. A template input named `workspace` takes precedence. ([#7349](#7349)) ### Dependency Updates * Bump dependencies with known vulnerabilities. ([#7394](#7394)) * Upgrade `github.com/mattn/go-runewidth` to v0.0.31, which removes ~30ms of startup time from every command. ([#7391](#7391)) * Update the Go SDK to [v0.194.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.194.0). ([#7371](#7371)) * Update the Go SDK to [v0.195.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.195.0). ([#7384](#7384))
Collaborator
❌ Integration test reportCommit: 39f6b8d
39 interesting tests: 39 FAIL
Top 50 slowest tests (at least 2 minutes):
|
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.
Adds 16
AitoolsErrorCategoryvalues and classifies wrapped standard library errors by type, never by error text.Summary
The order matters in two places:
syscall.Errnoimplementsnet.Error. Without the bare-Errnocheck, every OS file error would be reported asNETWORK. The check is a direct type assertion becauseerrors.Aswould also match theErrnoinside a*net.OpError.connect: EACCES) is stillNETWORK.JSON decode errors stay
UNCATEGORIZED. The manifest, the release payload and.state.jsonall decode JSON, so the error type alone can't tellMANIFEST_INVALIDfromSTATE_INVALID. A follow-up PR adds typed fetch and state errors that set those.New values (
libs/telemetry/protos/aitools_install.go). Only some are emitted by this PR:NETWORK,TIMEOUT,MANIFEST_NOT_FOUND,PERMISSION_DENIED,FILESYSTEMINVALID_FLAGS,UNKNOWN_AGENT,PROMPT_FAILED,USER_ABORTED(follow-up: install flow telemetry)RELEASE_LOOKUP_FAILED,RATE_LIMITED,SKILLS_FETCH_FAILED,MANIFEST_INVALID,STATE_INVALID,PLUGIN_CLI_TIMEOUT(follow-up: typed installer errors)COMMAND_INTERRUPTED(nothing on the install path cancels the context yet)Changelog fragment:
.nextchanges/cli/aitools-install-error-categories.md.Evidence
TestClassifyInstallErrorGenericCauses: one case per branch, including a refused connection, a sandbox-blocked socket, EBUSY on rename, and a real missing-file error fromos.ReadFile.categorize.gowith this PR's tests):UNCATEGORIZED.TestClassifyInstallErrorCorruptStateIsUncategorizedruns the realinstaller.LoadStateon a corrupt file and getsUNCATEGORIZED, notMANIFEST_INVALID.Full run on the same change before rebasing onto current main: unit tests 8633 passed / 0 failed; acceptance tests (every dir except
bundle/) 350 passed / 0 failed; lint, fmt, whitespace, deadcode and.nextchangeschecks clean.GOOS=windows go vet ./cmd/aitools/passes. The tests were not run on Windows.Merge Danger
Door: Two-way for the code, one-way for the enum names once a CLI release ships them.
Reverting the classifier is trivial. But once released binaries send these strings, the server must keep accepting them. The telemetry backend schema must add these values before or together with the CLI release. If the CLI ships first, the backend records unknown names as a NULL
error_category; the event is still recorded.Blast Radius: Telemetry.
Only the
error_categoryin aitools install telemetry and inaitools install --output jsonchanges. Install behaviour and exit codes don't change. Known gap: a malformedDATABRICKS_SKILLS_BASE_URLis reported asNETWORK.Open item: add this PR's link to the changelog fragment (
task check-changelogrequires it).This pull request and its description were written by Isaac.