- Notifications
You must be signed in to change notification settings - Fork905
Open
Description
Feature Request: Include License Status in Support Bundle
Summary
Add license status information to the support bundle to improve troubleshooting capabilities for license-related issues. Potentially, an alert to end-users may also be desirable at the ultimate day of expiration and following the expiry.
Problem Statement
Currently, when troubleshooting Coder deployments, license status information is not readily available to support engineers or administrators through the support bundle. This creates the following challenges:
- Limited visibility: The
coderd
logs do not include license status alerts or warnings - User awareness gap: End-users (non-admin) cannot detect license-related issues that may affect their experience
- Inefficient troubleshooting: Support cases require additional manual steps to gather license information, increasing resolution time
Proposed Solution
Include the output ofcoder license list
command in the support bundle as a dedicated text file.
Technical Requirements
- Add license status collection to the support bundle generation process
- Store license information in a structured text file (e.g.,
license-status.txt
) - Ensure sensitive license details are appropriately sanitized or redacted (UID or details of the licensee may not be appropriate)
- Handle cases where license information is unavailable or inaccessible
Implementation Considerations
- Permissions: Ensure the support bundle collection process has appropriate permissions to read license information
- Error handling: Gracefully handle scenarios where license data cannot be retrieved
- Data privacy: Consider redacting sensitive license details (e.g., license UID or components activated) while preserving diagnostic information
- Format consistency: Use a standardized format that matches the CLI output for familiarity
Expected Outcome
Support bundles will include alicense-status.txt
file containing the equivalent output ofcoder license list
, enabling:
- Faster identification of license-related issues
- Improved troubleshooting efficiency for support teams
- Better visibility into license status during incident response
Acceptance Criteria
- Support bundle includes license status information in a dedicated file
- License information is properly formatted and readable
- Sensitive data is appropriately handled/redacted
- Implementation gracefully handles permission or access errors
- Documentation is updated to reflect the new support bundle contents
Metadata
Metadata
Assignees
Labels
No labels