sonar-widgets
로그프레소 소나에 등록된 모든 위젯 목록을 조회합니다. 각 위젯의 GUID, 이름, 렌더링 타입, 갱신 간격, 소유자, 공유 대상 등 속성을 함께 반환합니다.
명령어 속성
| 항목 | 설명 |
|---|---|
| 명령어 유형 | 드라이버 쿼리 |
| 필요 권한 | 관리자 |
| 라이선스 사용량 | 집계함 |
| 병렬 실행 | 미지원 |
| 분산 실행 | 미지원 |
문법
sonar-widgets
옵션
옵션 없음
출력 필드
| 필드 | 타입 | 설명 |
|---|---|---|
| guid | 문자열 | 위젯 GUID |
| name | 문자열 | 위젯 이름 |
| description | 문자열 | 위젯 설명 |
| render_type | 문자열 | 위젯 렌더링 타입 |
| interval | 32비트 정수 | 위젯 갱신 간격 |
| owner_guid | 문자열 | 위젯 소유자 GUID. 현재 구현에서는 값이 출력되지 않습니다 |
| owner_name | 문자열 | 위젯 소유자 이름 |
| shared_users | 배열 | 공유된 사용자 목록. 각 항목은 guid, name, type, read_only, created 필드를 가진 객체이며, created는 날짜 값이 아니라 yyyy-MM-dd HH:mm:ssZ 형식의 문자열입니다 |
| shared_groups | 배열 | 공유된 사용자 그룹 목록. 각 항목은 guid, name, type, read_only, created 필드를 가진 객체이며, created는 날짜 값이 아니라 yyyy-MM-dd HH:mm:ssZ 형식의 문자열입니다 |
| created | 날짜 | 생성일 |
| updated | 날짜 | 마지막 수정일 |
오류 코드
파싱 오류
| 오류 코드 | 메시지 | 설명 |
|---|---|---|
| 300171 | 위젯 목록을 볼 권한이 없습니다 | 관리자 권한이 없는 계정으로 실행한 경우 |
런타임 오류
해당 사항 없음
설명
sonar-widgets 명령어는 필터 없이 같은 회사(테넌트)에 속한 모든 위젯을 조회 대상으로 삼습니다. 조회 쿼리가 탭을 조인하지 않으므로 대시보드에 배치되었는지 여부와 관계없이 전체 위젯이 대상이 되고, 관리자 권한으로 실행하므로 소유자나 공유 여부와도 관계없이 반환됩니다. 특정 위젯만 확인하려면 뒤에 search나 fields 명령어를 연결해 필터링해야 합니다.
조회한 위젯을 복제하려면 sonar-clone-widgets 명령어를 사용하세요.
사용 예
-
전체 위젯 목록 조회
sonar-widgets시스템에 등록된 모든 위젯의 속성을 반환합니다.
-
렌더링 타입별 위젯 개수 집계
sonar-widgets | stats count by render_type위젯을 렌더링 타입별로 그룹화하여 개수를 집계합니다.
-
특정 소유자가 만든 위젯만 조회
sonar-widgets | search owner_name == "관리자"소유자 표시 이름이
관리자인 위젯만 필터링합니다.owner_name은 로그인 이름이 아니라 계정의 표시 이름(성명)이므로, 로그인 이름과 다른 값을 사용하는 계정에서는 표시 이름을 기준으로 지정해야 합니다.
변경 이력
sonar-widgets 명령어는 소나 4.0.2609.0 버전부터 사용 가능합니다.
이 명령어는 실험실(Lab) 앱이 제공하던 것을 소나 코어에 내장한 것입니다(SNR#3463). 내장되지 않은 버전에서는 실험실 앱을 설치해 사용할 수 있습니다.