-
Notifications
You must be signed in to change notification settings - Fork 347
Description
Currently, the cli prints out the tool description. This description may include information for the human user and/or include information for a host/client.
Because these are in a single description field in the CLI, a human is required to review the description and remove the content that is meant just for the host/client.
Can you provide either separate fields in the CLI or syntax within the single description field which indicates the two types of information?
Example cli json output:
{
"id": "92fb5b7d-f1d7-4834-a61a-e170ad8594ac",
"name": "diagnose",
"description": "Get diagnostic help from App Lens for Azure application and service issues to identify what’s wrong with a service. Ask questions about performance, slowness, failures, errors, application state, availability to receive expert analysis and solutions which can help when performing diagnostics and to address issues about performance and failures. Returns insights, recommended solutions, and analysis. Always use this tool before manually checking metrics or logs when users report performance or functionality issues. Use Azure CLI to find the subscription, resourceGroup, and resourceType if not provided. If given a resourceId, parse it to extract subscription, resourceGroup, and resourceType (format: /subscriptions/{subscription}/resourceGroups/{resourceGroup}/providers/{resourceType}/{resource}). This tool can be used to ask questions about application state, diagnose performance problems, and address service failures.",
"command": "applens resource diagnose",This is the part that I think is for the host/client, and not the human:
Always use this tool before manually checking metrics or logs when users report performance or functionality issues. Use Azure CLI to find the subscription, resourceGroup, and resourceType if not provided. If given a resourceId, parse it to extract subscription, resourceGroup, and resourceType (format: /subscriptions/{subscription}/resourceGroups/{resourceGroup}/providers/{resourceType}/{resource}). This tool can be used to ask questions about application state, diagnose performance problems, and address service failures.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status