로그프레소 API 사용 가이드

본 문서는 로그프레소 API 연동에 어려움을 겪는 사용자분들을 위해 제작된 튜토리얼 가이드입니다.

내용 중 수정이 필요한 사항이나 보완이 필요한 의견이 있으시면 언제든 피드백 부탁드립니다.

개요

  • 하기의 가이드를 통해 API로 수집기 목록을 간편하게 조회할 수 있습니다.

  • 추가적인 API 활용 방법은 /api/ 경로에 접속하시거나, 로그프레소 docs의 문서를 통해 확인하실 수 있습니다.

    • API 가이드 접속: https://<SNR IP>:<PORT>/api/ (SNR UI 접속 주소 뒤에 /api/ 추가)

    • 상세 문서: [로그프레소 API]를 확인해 주시기 바랍니다.

API 키 생성

  • SNR UI의 [계정] 메뉴에서 해당 계정을 선택 후, [API 키 발급] 버튼 클릭

수집기 목록 조회

  • 하기 쿼리 사용 시, 현재 등록된 수집기 목록 조회 가능

  • 예시) 수집기 목록 조회 쿼리

    # api 및 SNR url 입력(하기 값 변경 필요)
    | set api_key = "abcdefg-1234-abcd-1234-abcdefhigk" 
    | set base_url = "https://100.100.100.100" 
    
    | json "{}"
    | # API 호출
    | eval header = dict("Authorization", format("Bearer %s", $("api_key"))) 
    | eval url = format("%s/api/sonar/loggers", $("base_url")) 
    | wget header=header method=get
    
    | # 수집된 결과 파싱
    | parsejson line
    | explode loggers
    | parsemap field=loggers