Troubleshooting service for plug-ins

This document contains information about how the troubleshooting service provides a consistent framework and helper methods for plug-ins to create a simplified and pleasant user experience. The troubleshooting service is a guide to help map the recommended design for a plug-in to create troubleshooting operations. Each plug-in contains the list of troubleshooting operations for the specific role. You can access the troubleshooting operations though the user interface deployment inlet on the Operation tab. The troubleshooting service uses the deployment inlet operation capabilities with a recommended structure to provide consistency and reduce the work that is required by the plug-in to add troubleshooting operations. The troubleshooting operation is managed by python lifecycle scripts that the deployment inlet operation starts as the entry and exit point of the operation. The troubleshooting python lifecycle script can start other scripts that the plug-in needs, but it must be clear that the scripts were successful or not and provide the compressed file that is expected from the action. The troubleshooting python lifecycle script can take advantage of helper methods that are provided by the troubleshooting service plug-in to make common actions easier. Examples of the type of actions these methods can provide are mechanisms for returning the data to the user through the deployment inlet and interacting with the logging service to store historical troubleshooting information.