sonar-loggers
로그프레소 소나에 등록된 수집기 목록을 조회합니다. 수집기별 실행 상태, 수집 건수, 연결된 수집 모델과 로그 스키마 등의 정보를 반환합니다.
명령어 속성
| 항목 | 설명 |
|---|---|
| 명령어 유형 | 드라이버 쿼리 |
| 필요 권한 | 관리자 |
| 라이선스 사용량 | 집계함 |
| 병렬 실행 | 미지원 |
| 분산 실행 | 수집 노드에서 실행 (mapper) |
문법
sonar-loggers [keywords=STR] [schema=STR]
옵션
keywords=STR- 수집기 이름 검색 키워드
schema=STR- 필터링할 로그 스키마 코드. 지정한 스키마를 사용하는 수집기만 반환합니다.
입력 필드
없음 (드라이버 쿼리이므로 파이프라인에서 첫 번째 명령어로만 사용합니다)
출력 필드
| 필드 | 타입 | 설명 |
|---|---|---|
| id | 32비트 정수 | 수집기 번호 |
| guid | 문자열 | 고유 식별자 |
| name | 문자열 | 수집기 이름 |
| model_name | 문자열 | 수집기가 사용하는 수집 모델 이름 |
| enabled | 불리언 | 수집기 활성화 여부 |
| status | 문자열 | 현재 동작 상태 |
| failure | 문자열 | 일시적 오류 메시지. 오류가 없으면 null |
| table_name | 문자열 | 수집 로그를 저장하는 테이블 이름 |
| group_name | 문자열 | 수집기가 속한 그룹 이름 |
| interval | 32비트 정수 | 수집기 실행 주기 (단위: 밀리초) |
| cron_schedule | 문자열 | 예약된 실행 일정 (cron 표현식) |
| hostname | 문자열 | 수집 대상 자산의 호스트 이름 |
| asset_ip | 문자열 | 수집 대상 자산의 IP 주소 |
| log_schemas | 배열 | 수집기가 사용하는 수집 모델에 연결된 로그 스키마 코드 목록 |
| log_count | 64비트 정수 | 수집된 로그 개수 |
| drop_count | 64비트 정수 | 드롭된 로그 건수 |
| log_volume | 64비트 정수 | 수집된 로그 데이터의 전체 용량 (단위: 바이트) |
| drop_volume | 64비트 정수 | 드롭된 로그 데이터의 전체 용량 (단위: 바이트) |
| node_pair_name | 문자열 | 연동된 노드 페어 이름 |
| sentry_guid | 문자열 | 센트리에서 수집되는 경우 해당 센트리의 GUID |
| configs | 맵 | 수집기 설정 키-값 쌍 |
| description | 문자열 | 수집기 설명 |
| asset_guid | 문자열 | 수집 대상 자산의 GUID |
| node_pair_guid | 문자열 | 연동된 노드 페어 GUID |
| model_guid | 문자열 | 수집기가 사용하는 수집 모델 GUID |
| group_guid | 문자열 | 수집기가 속한 그룹 GUID |
| crypto_profile_guid | 문자열 | 테이블 암호화에 사용하는 암호화 프로파일 GUID |
| encrypted | 불리언 | 저장 테이블의 암호화 사용 여부 |
| is_passive | 불리언 | 수동(passive) 수집기 여부 |
| created | 날짜 | 생성 시각 |
| updated | 날짜 | 마지막 갱신 시각 |
수집기가 사이트가 연결된 자산 IP에 등록되어 있으면 위 필드 외에 site_guid(문자열, 사이트 GUID)와 site_name(문자열, 사이트 이름)이 추가로 반환됩니다.
오류 코드
파싱 오류
| 오류 코드 | 메시지 | 설명 |
|---|---|---|
| 300144 | 수집기 목록 조회는 관리자 권한이 필요합니다. | 관리자 권한이 없는 계정으로 실행한 경우 |
런타임 오류
해당 사항 없음
설명
sonar-loggers 명령어는 최대 1,000건씩 페이지 단위로 조회하여 등록된 모든 수집기를 순차적으로 반환합니다. keywords 옵션을 지정하면 수집기 이름에서 검색하고, schema 옵션을 지정하면 해당 로그 스키마를 사용하는 수집기만 반환합니다.
log_schemas 필드는 수집기가 사용하는 수집 모델에 연결된 추출기(extractor)의 로그 스키마 코드를 모아서 반환합니다. 동일한 수집 모델을 사용하는 여러 수집기를 조회할 때는 모델별 로그 스키마 조회 결과를 캐시하여 반복 조회를 줄입니다.
사용 예
-
전체 수집기 목록 조회
sonar-loggers -
이름으로 검색
sonar-loggers keywords="fw-edge"이름에
fw-edge가 포함된 수집기만 반환합니다. -
로그 스키마로 필터링
sonar-loggers schema="session"session스키마를 사용하는 수집기만 반환합니다. -
비활성화된 수집기만 조회
sonar-loggers | search enabled == false
변경 이력
sonar-loggers 명령어는 소나 4.0.2609.0 버전부터 사용 가능합니다.
이 명령어는 실험실(Lab) 앱이 제공하던 것을 소나 코어에 내장한 것입니다(SNR#3463). 내장되지 않은 버전에서는 실험실 앱을 설치해 사용할 수 있습니다.