-
Notifications
You must be signed in to change notification settings - Fork 38
feat: add telemetry for PET process failures and exits #1306
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.
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
eleanorjboyd
wants to merge
2
commits into
microsoft:main
Choose a base branch
from
eleanorjboyd:regular-ladybug
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+115
−12
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,8 @@ import { spawnProcess } from '../../common/childProcess.apis'; | |
| import { ENVS_EXTENSION_ID, PYTHON_EXTENSION_ID } from '../../common/constants'; | ||
| import { getExtension } from '../../common/extension.apis'; | ||
| import { traceError, traceVerbose, traceWarn } from '../../common/logging'; | ||
| import { EventNames } from '../../common/telemetry/constants'; | ||
| import { sendTelemetryEvent } from '../../common/telemetry/sender'; | ||
| import { untildify, untildifyArray } from '../../common/utils/pathUtils'; | ||
| import { isWindows } from '../../common/utils/platformUtils'; | ||
| import { createRunningWorkerPool, WorkerPool } from '../../common/utils/workerPool'; | ||
|
|
@@ -74,21 +76,38 @@ export class ConfigureRetryState { | |
| } | ||
| } | ||
|
|
||
| export class PetBinaryNotFoundError extends Error { | ||
| constructor(message: string) { | ||
| super(message); | ||
| this.name = 'PetBinaryNotFoundError'; | ||
| } | ||
| } | ||
|
|
||
| export async function getNativePythonToolsPath(): Promise<string> { | ||
| const envsExt = getExtension(ENVS_EXTENSION_ID); | ||
| if (envsExt) { | ||
| const petPath = path.join(envsExt.extensionPath, 'python-env-tools', 'bin', isWindows() ? 'pet.exe' : 'pet'); | ||
| if (await fs.pathExists(petPath)) { | ||
| const exists = await fs.pathExists(petPath); | ||
| traceVerbose(`[pet] Primary path (envs-ext): ${petPath} — exists: ${exists}`); | ||
| if (exists) { | ||
| return petPath; | ||
| } | ||
| } else { | ||
| traceVerbose(`[pet] Envs extension (${ENVS_EXTENSION_ID}) not found; trying Python extension fallback`); | ||
| } | ||
|
|
||
| const python = getExtension(PYTHON_EXTENSION_ID); | ||
| if (!python) { | ||
| throw new Error('Python extension not found'); | ||
| throw new PetBinaryNotFoundError('Python extension not found and envs extension pet binary is missing'); | ||
| } | ||
|
|
||
| return path.join(python.extensionPath, 'python-env-tools', 'bin', isWindows() ? 'pet.exe' : 'pet'); | ||
| const fallbackPath = path.join(python.extensionPath, 'python-env-tools', 'bin', isWindows() ? 'pet.exe' : 'pet'); | ||
| const fallbackExists = await fs.pathExists(fallbackPath); | ||
| traceVerbose(`[pet] Fallback path (python-ext): ${fallbackPath} — exists: ${fallbackExists}`); | ||
| if (!fallbackExists) { | ||
| throw new PetBinaryNotFoundError(`Python finder binary not found at: ${fallbackPath}`); | ||
| } | ||
| return fallbackPath; | ||
| } | ||
|
|
||
| export interface NativeEnvInfo { | ||
|
|
@@ -224,6 +243,7 @@ class NativePythonFinderImpl implements NativePythonFinder { | |
| private startFailed: boolean = false; | ||
| private restartAttempts: number = 0; | ||
| private isRestarting: boolean = false; | ||
| private isDisposed: boolean = false; | ||
| private readonly configureRetry = new ConfigureRetryState(); | ||
|
|
||
| constructor( | ||
|
|
@@ -426,6 +446,7 @@ class NativePythonFinderImpl implements NativePythonFinder { | |
| } | ||
|
|
||
| public dispose() { | ||
| this.isDisposed = true; | ||
| this.pool.stop(); | ||
| this.startDisposables.forEach((d) => d.dispose()); | ||
| this.connection.dispose(); | ||
|
|
@@ -475,11 +496,18 @@ class NativePythonFinderImpl implements NativePythonFinder { | |
| // Handle process exit - mark as exited so pending requests fail fast | ||
| this.proc.on('exit', (code, signal) => { | ||
| this.processExited = true; | ||
| if (code !== 0) { | ||
| const wasExpected = this.isRestarting || this.isDisposed; | ||
| if (!wasExpected && code !== 0) { | ||
| this.outputChannel.error( | ||
| `[pet] Python Environment Tools exited unexpectedly with code ${code}, signal ${signal}`, | ||
| ); | ||
| } | ||
|
Comment on lines
+499
to
504
|
||
| sendTelemetryEvent(EventNames.PET_PROCESS_EXIT, undefined, { | ||
| exitCode: code, | ||
| signal: signal ?? null, | ||
| restartAttempt: this.restartAttempts, | ||
| wasExpected, | ||
| }); | ||
| }); | ||
|
|
||
| // Handle process errors (e.g., ENOENT if executable not found) | ||
|
|
@@ -898,5 +926,7 @@ export async function createNativePythonFinder( | |
| api: PythonProjectApi, | ||
| context: ExtensionContext, | ||
| ): Promise<NativePythonFinder> { | ||
| return new NativePythonFinderImpl(outputChannel, await getNativePythonToolsPath(), api, getCacheDirectory(context)); | ||
| const petPath = await getNativePythonToolsPath(); | ||
| traceVerbose(`[pet] Resolved pet binary path: ${petPath}`); | ||
| return new NativePythonFinderImpl(outputChannel, petPath, api, getCacheDirectory(context)); | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PET_START_FAILED
reasonclassification assumes that any error without anerrnoError.codemust be "binary_not_found", butcreateNativePythonFinder()can also throw plainErrors after the binary is found/spawned (e.g., missing stdio streams, JSON-RPC setup failures). This will misattribute failures in telemetry. Consider settingreasonto'unknown'by default and only using'binary_not_found'for the specific errors thrown bygetNativePythonToolsPath()(e.g., by throwing a dedicated error type or attaching a discriminator).