az arcdata dc debug

Note

This reference is part of the arcdata extension for the Azure CLI (version 2.3.1 or higher). The extension will automatically install the first time you run an az arcdata dc debug command. Learn more about extensions.

Debug data controller.

Commands

az arcdata dc debug copy-logs

Copy logs.

az arcdata dc debug dump

Trigger memory dump.

az arcdata dc debug copy-logs

Copy logs.

Copy the debug logs from the data controller - Kubernetes configuration is required on your system.

az arcdata dc debug copy-logs --k8s-namespace
                              [--container]
                              [--exclude-dumps]
                              [--exclude-system-logs]
                              [--pod]
                              [--resource-kind]
                              [--resource-name]
                              [--skip-compress]
                              [--target-folder]
                              [--timeout]
                              [--use-k8s]

Required Parameters

--k8s-namespace -k

Kubernetes namespace of the data controller.

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.

--exclude-dumps

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

--exclude-system-logs

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

--pod

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.

--resource-kind

Copy the logs for the resource of a particular kind. Cannot specified multiple times. If specified multiple times, last one will be used. If specified, --resource-name should also be specified to identify the resource.

--resource-name

Copy the logs for the resource of the specified name. Cannot be specified multiple times. If specified multiple times, last one will be used. If specified, --resource-kind should also be specified to identify the resource.

--skip-compress

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

--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.

--timeout -t

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

--use-k8s

Use local Kubernetes APIs to perform this action.

az arcdata dc debug dump

Trigger memory dump.

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

az arcdata dc debug dump --k8s-namespace
                         [--container {controller}]
                         [--target-folder]
                         [--use-k8s]

Required Parameters

--k8s-namespace -k

Kubernetes namespace of the data controller.

Optional Parameters

--container -c

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

accepted values: controller
default value: controller
--target-folder -d

Target folder to copy the dump out.

default value: ./output/dump
--use-k8s

Use local Kubernetes APIs to perform this action.