Device Update for IoT Hub를 사용하여 디바이스에서 원격으로 진단 로그 수집

Device Update for IoT Hub 로그 작업을 시작하고 Azure Blob Storage 내에서 수집된 로그를 확인하는 방법을 알아봅니다.

필수 조건

• IoT Hub용 디바이스 업데이트를 사용으로 설정하여 IoT Hub에 액세스합니다.
• IoT Hub 내에서 Device Update용으로 프로비저닝되고 진단 인터페이스를 구현하는 IoT 디바이스(또는 시뮬레이터)
• Device Update for IoT Hub 계정과 동일한 구독에 있는 Azure Blob Storage 계정

참고 항목

원격 로그 수집 기능은 현재 진단 인터페이스를 구현하고 Azure Blob Storage에 파일을 업로드할 수 있는 디바이스와만 호환됩니다. 또한 참조 에이전트 구현은 디바이스에서 사용자가 지정한 파일 경로에 로그 파일을 쓸 것으로 예상합니다.

Azure Portal

지원되는 브라우저:

• Microsoft Edge
• Google Chrome

Azure CLI

Azure CLI 환경:

• Azure Cloud Shell에서 Bash 환경을 사용합니다.

  

• 또는 CLI 참조 명령을 로컬에서 실행하려면 Azure CLI를 설치합니다.

  • az login 명령을 사용하여 Azure CLI에 로그인합니다.
  • az version을 실행하여 설치된 버전과 종속 라이브러리를 찾습니다. 최신 버전으로 업그레이드하려면 az upgrade를 실행합니다.
  • 메시지가 표시되면 처음 사용할 때 Azure CLI 확장을 설치합니다. 이 문서의 명령은 azure-iot 확장을 사용합니다. az extension update --name azure-iot를 실행하여 최신 버전의 확장을 사용하고 있는지 확인합니다.

팁

이 문서의 Azure CLI 명령은 명령 인수를 더 쉽게 읽을 수 있도록 줄 연속에 백슬래시 \ 문자를 사용합니다. 이 구문은 Bash 환경에서 작동합니다. PowerShell에서 이 명령을 실행하는 경우 각 백슬래시를 백틱(```)으로 바꾸거나 완전히 제거합니다.

Device Update 인스턴스에 Azure Blob Storage 계정 연결

원격 로그 수집 기능을 사용하려면 먼저 Azure Blob Storage 계정을 Device Update 인스턴스와 연결해야 합니다. 이 Azure Blob Storage 계정은 디바이스가 진단 로그를 업로드하는 위치입니다.

Azure Portal

1. Azure Portal에서 Device Update for IoT Hub 계정으로 이동합니다.

2. 탐색 창의 인스턴스 관리 섹션에서 인스턴스를 선택합니다.

3. 목록에서 디바이스 업데이트 인스턴스를 선택한 후 진단 구성을 선택합니다.

4. 고객 진단 탭을 선택한 후 Azure Storage 계정 선택을 선택합니다.

5. 목록에서 원하는 스토리지 계정을 선택한 후 저장을 선택합니다.

6. 인스턴스 목록으로 돌아가면 인스턴스의 프로비전 상태가 ‘성공’으로 표시될 때까지 주기적으로 새로 고침을 선택합니다. 이 프로세스는 보통 2~3분 정도 걸립니다.

Azure CLI

az iot du instance create 명령을 사용하여 디바이스 업데이트 인스턴스에 대한 진단을 구성합니다.

팁

기존 디바이스 업데이트 인스턴스에서 az iot du instance create 명령을 사용할 수 있으며, 업데이트된 매개 변수를 사용하여 인스턴스를 구성합니다.

다음 자리 표시자를 사용자 고유의 정보로 바꿉니다.

• <account_name>: 디바이스 업데이트 계정의 이름입니다.
• <instance_name>: 디바이스 업데이트 인스턴스의 이름입니다.
• <storage_id>: 진단 로그가 저장될 스토리지 계정의 리소스 ID입니다. az storage show 명령을 사용하고 ID 값(az storage account show -n <storage_name> --query id)을 쿼리하여 리소스 ID를 검색할 수 있습니다.

az iot du instance update --account <account_name> --instance <instance_name> --set enableDiagnostics=true diagnosticStorageProperties.resourceId=<storage_id>

로그 수집 구성

디바이스 업데이트 에이전트는 참조 에이전트의 /etc/adu/du-diagnostics-config.json에 있는 디바이스의 구성 파일을 참조합니다.

로그 수집 파일 경로

디바이스의 Device Update 에이전트는 Device Update 서비스에서 로그 업로드 시작 신호를 받으면 디바이스의 특정 파일 경로에서 파일을 수집합니다. 이러한 파일 경로는 진단 구성 파일에 정의되어 있습니다.

구성 파일 내에서 수집하고 업로드할 각 로그 파일은 componentName 및 logPath 속성이 있는 logComponent 개체로 표시됩니다. 이 구성은 필요에 따라 수정할 수 있습니다.

최대 로그 파일 크기

Device Update 에이전트는 특정 파일 크기 미만의 로그 파일만 수집합니다. 이 최대 파일 크기는 진단 구성 파일에 정의되어 있습니다.

관련 매개 변수 ‘maxKilobytesToUploadPerLogPath’는 각 logComponent 개체에 적용되며 원하는 대로 수정할 수 있습니다.

로그 작업 만들기

로그 작업은 디바이스 업데이트 서비스를 통해 수행하도록 IoT 디바이스에 지시할 수 있는 새로운 서비스 기반 작업입니다. 로그 작업이 작동하는 방법에 대한 자세한 설명은 디바이스 업데이트 진단을 참조하세요.

Azure Portal

1. IoT Hub로 이동하여 탐색 창의 디바이스 관리 섹션에서 업데이트 탭을 선택합니다.

2. UI에서 진단 탭을 선택합니다. 진단 탭이 표시되지 않으면 Device Update for IoT Hub 사용자 인터페이스의 최신 버전을 사용하고 있는지 확인합니다. ‘이 Device Update 인스턴스에 대해 진단을 사용하도록 설정해야 함’이 표시되는 경우, Azure Blob Storage 계정을 Device Update 인스턴스와 연결했는지 확인합니다.

3. 로그 업로드 작업 추가를 선택하여 로그 작업 만들기 페이지로 이동합니다.

4. 새 로그 작업의 이름(ID)과 설명을 입력한 후 디바이스 추가를 선택하여 진단 로그를 수집할 IoT 디바이스를 선택합니다.

5. 추가를 선택합니다.

6. 진단 탭으로 돌아가면 작업 테이블에 나열된 로그 작업이 표시될 때까지 새로 고침을 선택합니다.

7. 작업 상태가 성공 또는 실패이면 작업 이름을 선택하여 세부 정보를 확인합니다. 모든 대상 디바이스가 로그 업로드를 성공적으로 완료한 경우에만 작업이 ‘성공’으로 표시됩니다. 일부 대상 디바이스가 성공하고 일부 디바이스가 실패한 경우 로그 작업이 ‘실패’로 표시됩니다. 로그 작업 세부 정보 페이지를 사용하여 성공한 디바이스와 실패한 디바이스를 확인할 수 있습니다.

8. 로그 작업 세부 정보에서 디바이스별 상태를 보고 로그 위치 경로를 확인할 수 있습니다. 이 경로는 진단 로그가 업로드된 Azure Blob Storage 계정 내의 가상 디렉터리 경로에 해당합니다.

Azure CLI

az iot du device log collect 명령을 사용하여 진단 로그 수집 작업을 구성합니다.

device log collect 명령은 다음과 같은 인수를 사용합니다.

• --account: 디바이스 업데이트 계정 이름입니다.
• --instance: 디바이스 업데이트 인스턴스 이름입니다.
• --log-collection-id: 로그 수집 작업의 이름입니다.
• --agent-id: 이 로그 수집 작업의 대상 디바이스 업데이트 에이전트를 식별하는 키=값 쌍입니다. 에이전트에 디바이스 ID가 있는 경우 deviceId=<device name>을(를) 사용합니다. 에이전트에 모듈 ID가 있는 경우 deviceId=<device name> moduleId=<module name>을(를) 사용합니다. --agent-id 매개 변수를 여러 번 사용하여 여러 디바이스를 대상으로 지정할 수 있습니다.

예시:

az iot du device log collect \
    --account <Device Update account name> \
    --instance <Device Update instance name> \
    --log-collection-id <log collection name} \
    --agent-id deviceId=<device name> \
    --agent-id deviceId=<device name> moduleId=<module name>

az iot du device log show를 사용하여 특정 진단 로그 수집 작업의 세부 정보를 볼 수 있습니다.

az iot du device log show \
    --account <Device Update account name> \
    --instance <Device Update instance name> \
    --log-collection-id <log collection name>

수집된 진단 로그 보기 및 내보내기

1. 로그 작업이 성공하면 Azure Blob Storage 계정으로 이동합니다.

2. 탐색 창의 데이터 저장소 섹션에서 컨테이너를 선택합니다.

3. Device Update 인스턴스와 이름이 같은 컨테이너를 선택합니다.

4. 로그 작업 세부 정보에서 로그 위치 경로를 사용하여 로그를 포함하는 올바른 디렉터리로 이동합니다. 기본적으로 원격 로그 수집 기능은 대상 디바이스에 Blob Storage 컨테이너/대상 디바이스 ID/로그 작업 ID/디바이스 내 로그 경로와 같은 디렉터리 경로 모델을 사용하여 진단 로그를 업로드하도록 지시합니다.

5. 디바이스 업데이트 에이전트의 진단 구성 요소를 수정하지 않은 경우 디바이스는 디바이스 업데이트 에이전트 진단 로그("aduc.log") 및 DO 에이전트 진단 로그("do-agent.log")라는 두 개의 일반 텍스트 로그 파일을 업로드하려고 시도함으로써 로그 작업에 응답합니다. 디바이스 업데이트 진단 개념 페이지를 참조하여 디바이스 업데이트 참조 에이전트가 수집하는 로그 파일에 대해 자세히 알아볼 수 있습니다.

6. 파일 이름을 선택한 후 메뉴 요소(줄임표)를 선택하고 보기/편집을 클릭하여 로그 파일의 내용을 볼 수 있습니다. 각각 레이블이 지정된 옵션을 선택하여 로그 파일을 다운로드하거나 삭제할 수도 있습니다.

   

다음 단계

디바이스 업데이트의 진단 기능에 대해 자세히 알아보려면 디바이스 업데이트 진단 기능 개요를 참조하세요.