feat: add Amplitude error logging for CLI commands #892
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.
Summary
This PR adds comprehensive error logging to Amplitude for all CLI commands in the
@snappackage. It implements a genericwrapActionhelper that automatically logs errors to Amplitude with command context (command name, error message, error type, and stack trace) before rethrowing the error for Commander.js to handle.Related Issues
Type of Change
Checklist
Changes Made
Core Implementation
logCliErrorutility (packages/snap/src/utils/analytics.ts): Logs CLI errors to Amplitude with command name, error message, error type, and truncated stack tracewrapActionhelper: Generic wrapper function that wraps async command actions to automatically catch and log errors before rethrowinghandlerfunction (packages/snap/src/cloud/config-utils.ts): Enhanced existing error handler to log errors to Amplitude for commands using the handler patternCommand Updates
Applied
wrapActionto all CLI commands:generate-typesinstalldevstartemitgenerate stepgenerate openapidocker setupdocker rundocker buildCommands using the
handlerwrapper (create,rules pull,cloud build,cloud deploy) automatically get error logging through the enhanced handler.Key Features
Additional Context
This implementation follows Commander.js best practices by wrapping individual command actions rather than catching errors at the program parse level. This allows Commander.js to handle error display while we log errors to Amplitude for monitoring and debugging purposes.