azdata bdc debug

Applies to: Azure Data CLI (azdata)

Note

Some scenarios previously handled by the Azure Data CLI (azdata) are now managed through Azure CLI (az) extensions and Azure Arc-based workflows. There is no single 1:1 replacement for all azdata commands. The following table highlights commonly related Azure CLI alternatives where they exist.

azdata command area	Azure CLI extension / command group	Azure CLI reference
azdata arc dc *	az arcdata	Azure Arc data CLI reference
azdata arc sql mi *	az arcdata sql mi	Manage Azure SQL Managed Instance with CLI
azdata arc postgres *	az arcdata postgres	Manage PostgreSQL server with CLI
azdata migrate *	az datamigration	Migrate using CLI
azdata extension *	az extension *	Azure CLI extensions overview
azdata login	az login	az login
azdata sql shell / azdata sql query	No Azure CLI equivalent (use sqlcmd, SSMS, or other SQL tools)	sqlcmd utility SQL Server Management Studio

For new automation and management scenarios, prefer Azure CLI (az), Azure CLI extensions, and Azure Arc portal experiences.

The following article provides reference for the sql commands in the azdata tool. For more information about other azdata commands, see azdata reference

Commands

Command	Description
azdata bdc debug copy-logs	Copy logs.
azdata bdc debug dump	Trigger memory dump.

azdata bdc debug copy-logs

Copy the debug logs from the Big Data Cluster - Kubernetes configuration is required on your system.

azdata bdc debug copy-logs --namespace -ns 
                           [--container -c]  
                           
[--target-folder -d]  
                           
[--pod -p]  
                           
[--timeout -t]  
                           
[--skip-compress -sc]  
                           
[--exclude-dumps -ed]  
                           
[--exclude-system-logs  -esl]

Required Parameters

--namespace -ns

Big data cluster name, used for kubernetes namespace.

Optional Parameters

--container -c

Copy the logs for the containers with similar name, Optional, by default copies logs for all containers. Cannot be specified multiple times. If specified multiple times, last one will be used

--target-folder -d

Target folder path to copy logs to. Optional, by default creates the result in the local folder. Cannot be specified multiple times. If specified multiple times, last one will be used

--pod -p

Copy the logs for the pods with similar name. Optional, by default copies logs for all pods. Cannot be specified multiple times. If specified multiple times, last one will be used

--timeout -t

The number of seconds to wait for the command to complete. The default value is 0 which is unlimited

--skip-compress -sc

Whether or not to skip compressing the result folder. The default value is False which compresses the result folder.

--exclude-dumps -ed

Whether or not to exclude dumps from result folder. The default value is False which includes dumps.

--exclude-system-logs -esl

Whether or not to exclude system logs from collection. The default value is False which includes system logs.

Global Arguments

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--output -o

Output format. Allowed values: json, jsonc, table, tsv. Default: json.

--query -q

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

azdata bdc debug dump

Trigger memory dump and copy it out from container - Kubernetes configuration is required on your system.

azdata bdc debug dump --namespace -ns 
                      [--container -c]  
                      
[--target-folder -d]

Required Parameters

--namespace -ns

Big data cluster name, used for kubernetes namespace.

Optional Parameters

--container -c

The target container to be triggered for dumping the running processes controller

--target-folder -d

Target folder to copy the dump out. ./output/dump

Global Arguments

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--output -o

Output format. Allowed values: json, jsonc, table, tsv. Default: json.

--query -q

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Next steps

For more information about other azdata commands, see azdata reference.

For more information about how to install the azdata tool, see Install azdata.