sonar-log-schema-fields
지정한 로그 스키마에 정의된 필드 목록을 조회합니다. 필드별 이름, 표시 이름, 타입, 표시 순서를 확인할 수 있습니다.
명령어 속성
| 항목 | 설명 |
|---|---|
| 명령어 유형 | 드라이버 쿼리 |
| 필요 권한 | 관리자 |
| 라이선스 사용량 | 집계함 |
| 병렬 실행 | 미지원 |
| 분산 실행 | 수집 노드에서 실행 (mapper) |
문법
sonar-log-schema-fields schema=STR [locale=STR]
옵션
schema=STR(필수)- 필드 목록을 조회할 로그 스키마 코드
locale=STR- 표시 이름을 가져올 로케일.
ko,en,ja,zh중 하나를 지정합니다. 지정하지 않으면 세션에 설정된 로케일을 사용합니다.
입력 필드
없음 (드라이버 쿼리이므로 파이프라인에서 첫 번째 명령어로만 사용합니다)
출력 필드
| 필드 | 타입 | 설명 |
|---|---|---|
| name | 문자열 | 필드 이름 |
| display_name | 문자열 | 필드 표시 이름 (locale 옵션 적용 시 해당 언어의 표시 이름) |
| type | 문자열 | 필드 타입 (예: IP, STRING, DATE) |
| ordinal | 32비트 정수 | 표시 순서 |
오류 코드
파싱 오류
| 오류 코드 | 메시지 | 설명 |
|---|---|---|
| 300146 | 로그 스키마 목록 조회는 관리자 권한이 필요합니다. | 관리자 권한이 없는 계정으로 실행한 경우 |
| 300147 | schema 옵션을 지정하세요. | schema 옵션을 지정하지 않은 경우 |
런타임 오류
| 오류 코드 | 메시지 | 설명 | 후처리 동작 |
|---|---|---|---|
| - | Schema not found: [schema] | schema 옵션 값에 해당하는 로그 스키마를 찾을 수 없는 경우 | 쿼리 실행을 중단함 |
설명
sonar-log-schema-fields 명령어는 schema 옵션으로 지정한 로그 스키마에 정의된 필드를 조회하여 필드 이름, 표시 이름, 타입, 표시 순서(ordinal)를 반환합니다. 스키마에 필드가 정의되어 있지 않으면 결과 없이 종료합니다.
locale 옵션을 지정하면 display_name 필드 값을 해당 언어의 표시 이름으로 대체합니다. 지원하지 않는 로케일 값을 지정하면 무시되고 기본 표시 이름이 반환되며, 지원하는 로케일이라도 해당 언어의 번역이 없으면 기본 표시 이름으로 대체됩니다. locale 옵션을 지정하지 않으면 현재 세션의 로케일 설정을 따릅니다.
사용 예
-
스키마 필드 목록 조회
sonar-log-schema-fields schema="session" -
표시 이름을 영어로 조회
sonar-log-schema-fields schema="session" locale="en" -
표시 순서대로 필드 이름만 조회
sonar-log-schema-fields schema="session" | sort ordinal | fields name, display_name
변경 이력
sonar-log-schema-fields 명령어는 소나 4.0.2609.0 버전부터 사용 가능합니다.
이 명령어는 실험실(Lab) 앱이 제공하던 것을 소나 코어에 내장한 것입니다(SNR#3463). 내장되지 않은 버전에서는 실험실 앱을 설치해 사용할 수 있습니다.