보고서

개요

보고서 서식 작성 및 생성 기능은 정기적인 데이터 보고, 분석 결과 요약, 그리고 의사결정 지원 자료를 손쉽게 생성하는 데 활용됩니다.

사용자는 미리 정의된 보고서 서식을 통해 원하는 형태의 보고서를 손쉽게 제작할 수 있습니다. 쿼리문을 활용하여 데이터를 가공한 뒤, 해당 데이터를 기반으로 표, 차트, 텍스트 등의 항목을 배치하여 보고서 서식을 구성할 수 있습니다.

이 기능을 통해 반복적인 보고 작업을 자동화하고, 일관된 형식의 분석 결과를 신속하게 공유할 수 있습니다.

보고서 서식 목록을 조회하려면 보고서 조회(REPORT_VIEW) 권한이, 보고서 서식의 상세 내용을 열어 보려면 보고서 서식 조회(REPORT_TEMPLATE_VIEW) 권한이, 보고서 서식과 보고서 서식 그룹을 추가·수정·삭제·이동하려면 보고서 서식 관리(REPORT_TEMPLATE_EDIT) 권한이 필요합니다. 생성한 보고서를 파일로 내려받으려면 보고서 다운로드(REPORT_DOWNLOAD) 권한이 필요합니다. 목록의 추가·삭제·이동 버튼, 그룹 트리의 추가·편집·삭제 버튼, 보기 열, 보고서 조회 패널의 기간 선택·실행·다운로드 도구는 클러스터 관리자 또는 회사 관리자 권한이 있는 계정에만 표시됩니다.

보고서 서식 목록 조회/검색

분석 > 보고서에서 보고서 서식 목록을 조회하거나 검색할 수 있습니다. 좌측 사이드바에는 보고서 서식 그룹 트리가 표시되고, 오른쪽에는 선택한 그룹과 그 하위 그룹에 속한 보고서 서식 목록이 표시됩니다. 트리 상단의 전체를 선택하면 모든 보고서 서식이 표시됩니다.

• 그룹: 보고서 서식이 속한 보고서 서식 그룹. 어느 그룹에도 속하지 않은 서식은 이 열이 비어 있습니다.
• 이름: 보고서 서식의 이름
• 설명: 보고서 서식에 대한 설명
• 소유자: 보고서 서식을 추가한 계정
• 수정일: 보고서 서식이 마지막으로 수정된 날짜(yyyy-MM-dd 형식)
• 보기: 보고서 서식으로 지정한 기간의 보고서를 생성해 조회합니다.

보고서 서식 목록에서 특정 서식을 찾으려면 도구 모음에 있는 검색 도구를 사용하세요. 검색 도구는 입력한 단어가 보고서 서식의 이름 또는 설명에 포함된 서식을 찾아서 보여줍니다. 여러 단어를 공백으로 구분해 입력하면 모든 단어가 포함된 서식만 표시되며, 대소문자는 구분하지 않습니다. 도구 모음의 다운로드()를 클릭하면 보고서 서식 목록 다운로드 대화상자에서 파일 형식과 내려받을 열을 선택해 현재 목록을 파일로 내려받을 수 있습니다.

보고서 서식 그룹 트리는 다음과 같이 다룹니다.

• 트리 상단의 검색 상자에 그룹 이름을 입력하면 트리에서 해당 그룹만 표시됩니다.
• 그룹 트리와 보고서 서식 목록 사이의 경계를 마우스로 드래그하여 사이드바 너비를 조정할 수 있습니다. 그룹 이름이 길어 잘려 보이거나 반대로 목록을 더 넓게 보고 싶을 때 활용하세요.
• 트리 도구 모음 맨 오른쪽의 접기 버튼을 클릭하거나 경계를 왼쪽으로 충분히 드래그하면 트리가 아이콘 막대로 접힙니다. 접힌 상태에서 펼치기 버튼을 클릭하면 다시 펼쳐집니다.

보고서 서식 생성

보고서 서식을 생성하려면,

1. 보고서 서식 목록의 도구 모음에서 추가를 클릭하세요.
2. 보고서 서식 추가 패널에서 공통 설정 및 항목 설정을 완료한 후 패널 상단의 저장을 클릭하세요.

공통 설정

패널 상단에서 보고서 서식의 기본 정보를 설정하세요.

• 이름: 보고서 서식의 이름(필수, 최대 50자)
• 설명: 보고서 서식에 대한 설명(최대 2,000자)

항목 설정

보고서 서식을 구성하는 항목을 추가하세요. 새 보고서 서식에는 항목 1이 미리 하나 만들어져 있습니다. 항목을 더 추가하려면 각 항목 우측 도구 모음의 항목 추가를 클릭하세요. 새 항목은 그 항목 아래에 추가됩니다. 항목을 모두 지운 경우에는 패널 가운데에 표시되는 항목 추가를 클릭하세요.

• 유형: 항목의 유형
  • 단락: 보고서에 텍스트 형태의 내용을 삽입합니다. 쿼리 결과의 line 필드 값을 문단 텍스트로 표시합니다. 레코드가 여러 개일 경우, 각 문단이 연속적으로 출력됩니다.
  • 표: 보고서에 표 형태의 내용을 삽입합니다. 쿼리 결과를 표 형태로 표시합니다. 출력 순서는 쿼리 결과 창에서 조회되는 열 순서와 동일하며, fields나 order 명령어로 지정된 순서대로 열이 출력됩니다.
  • 그래프: 보고서에 차트를 삽입합니다.
    • 차트는 쿼리 결과에 따라 독립 변수 필드(X축)와 종속 변수 필드(Y축)를 자동으로 인식해 생성됩니다.
      • 독립 변수 필드: 차트의 기준 필드(날짜, 문자열, IP 주소 유형 필드)
      • 종속 변수 필드: 독립 변수에 대해 표시할 값 필드(정수, 실수 유형 필드)
    • 쿼리 결과에서 독립 변수가 될 수 있는 필드는 반드시 1개만 존재해야 하며, 종속 변수로 지정 가능한 필드는 1개 이상 있어야 합니다.
    • 단, 파이 차트의 경우 종속 변수 필드는 반드시 1개이어야 합니다.
  • 메모: 보고서에 메모 형태의 내용을 삽입합니다. 쿼리 결과의 line 필드 값을 외곽선 상자 안의 메모 텍스트로 표시합니다. 레코드가 여러 개일 경우, 각 메모가 연속적으로 출력됩니다.
• 차트: 유형이 그래프인 경우에만 표시됩니다. 차트 종류를 선택하세요.
  • 라인: 시간에 따른 변화를 선으로 표시합니다.
  • 가로 막대: 데이터를 가로 방향 막대로 표시합니다.
  • 세로 막대: 데이터를 세로 방향 막대로 표시합니다.
  • 누적 영역: 여러 시리즈를 영역으로 누적하여 표시합니다.
  • 파이: 전체에 대한 비율을 원형으로 표시합니다.
  • 누적 가로 막대: 여러 시리즈를 가로 막대에 누적하여 표시합니다.
  • 누적 세로 막대: 여러 시리즈를 세로 막대에 누적하여 표시합니다.
• 차트 설정: 유형이 그래프인 경우에만 표시됩니다. 차트 종류에 따라 선택할 수 있는 옵션이 다르며, 차트 종류를 바꾸면 옵션 선택이 초기화됩니다.
  • 로그 스케일: Y축 눈금을 로그 스케일로 표시합니다. 라인, 가로 막대, 세로 막대, 누적 영역, 누적 가로 막대, 누적 세로 막대 차트에서 사용할 수 있습니다.
  • 백분율: 종속 변수 축을 0에서 100까지로 고정하여 백분율 데이터를 표시합니다. 라인, 가로 막대, 세로 막대, 누적 영역, 누적 가로 막대, 누적 세로 막대 차트에서 사용할 수 있습니다.
  • 도넛: 파이 차트의 중앙을 비워 도넛 형태로 표시합니다. 파이 차트에서만 사용할 수 있습니다.
  • 라벨: 각 데이터 영역 위에 값 레이블을 표시합니다. 가로 막대, 세로 막대, 누적 가로 막대, 누적 세로 막대, 파이 차트에서 사용할 수 있습니다.
• 제목: 항목의 제목. 보고서의 소제목으로 표시되며, 필요에 따라 생략할 수 있습니다.
• 쿼리: 항목에 표시할 데이터를 만드는 쿼리문(필수, 최대 10,000자). 보고서에는 쿼리 결과의 처음 10,000개 레코드까지 담깁니다.
  • 보고서를 생성할 때 지정한 조회 기간의 시작과 끝 일시가 쿼리 매개변수 from, to로 전달됩니다. $("from"), $("to")를 활용하여 해당 기간의 데이터만 처리하도록 쿼리를 구성하세요. 예: table from=$("from") to=$("to") *:FW_FLOW | search action == "deny" | timechart span=1h count as blocked
  • 단락이나 메모 항목에는 line 필드를 만드는 쿼리를 작성하세요. 예: json "{}" | eval line=concat("조회 기간: ", string($("from"), "yyyy-MM-dd HH:mm"), " - ", string($("to"), "yyyy-MM-dd HH:mm"))
  • 쿼리문을 입력하면 테스트가 활성화됩니다. 유형이 그래프인 항목에서 테스트를 클릭하면 차트 테스트 대화상자에 차트 이미지가 표시되고, 그 외 유형에서는 새 창의 쿼리 뷰어에서 쿼리 실행 결과를 확인할 수 있습니다. 새 창에서 테스트할 수 있는 쿼리는 2,000자까지입니다.

도구 모음

각 항목의 오른쪽 위에 있는 도구 모음으로 항목을 관리할 수 있습니다.

왼쪽부터 서식 도구는 다음과 같습니다.

• 항목 추가: 새 항목을 이 항목 아래에 추가합니다.
• 표시/숨김(): 항목을 보고서에 포함할지 선택합니다. 숨긴 항목은 편집 화면에서 접히고, 보고서 생성 시 포함되지 않습니다.
• 위로/아래로 화살표: 항목의 순서를 위/아래로 한 칸 옮깁니다. Alt 키를 누른 채 클릭하면 맨 위/맨 아래로 옮깁니다.
• 삭제(): 확인 대화상자에서 확인을 클릭하면 항목을 삭제합니다. Alt 키를 누른 채 클릭하면 보고서 서식의 모든 항목을 삭제할지 묻는 대화상자가 표시됩니다.

보고서 서식 수정

보고서 서식을 수정하려면,

1. 보고서 서식 목록에서 수정할 보고서 서식의 행을 클릭하세요.

   

2. 보고서 서식 수정 패널에서 공통 설정, 항목 설정을 수정하고 저장을 클릭하세요. 보고서 서식을 수정하지 않으려면 패널 상단의 닫기()를 클릭하세요.

   

보고서 서식 관리 권한이 없는 계정으로 열면 패널이 읽기 전용으로 표시되고 저장이 나타나지 않습니다.

보고서 생성 및 조회

웹 콘솔에서 보고서 조회

추가한 보고서 서식으로 원하는 기간의 데이터를 보고서 형식으로 조회할 수 있습니다.

1. 보고서 서식 목록에서 원하는 보고서 서식의 보기를 클릭하세요.

   

2. 보고서 조회 패널 상단에서 조회 기간의 시작과 끝 일시를 설정한 후 실행을 클릭하세요. 기본 기간은 전일 0시부터 당일 0시까지입니다. 보고서를 생성하는 동안 실행이 중지로 바뀌며, 생성을 취소하려면 중지를 클릭하세요. 생성이 끝나면 보고서가 미리보기 화면에 표시됩니다.

   

3. 보고서 생성 완료 후 패널 오른쪽 위의 다운로드()를 클릭하고 원하는 형식(Word 문서 (docx), 한글 문서 (hwpx), 웹 문서 (html), PDF)을 선택하면 로컬 PC에 내려받을 수 있습니다. 다운로드 버튼은 보고서를 생성한 뒤에 활성화되며, 내려받으려면 보고서 다운로드(REPORT_DOWNLOAD) 권한이 필요합니다.

   

쿼리 기반 보고서 생성 및 조회

또 다른 방법으로 sonar-send-report를 이용해 보고서를 생성하고 메일로 받아볼 수 있습니다. 예약된 쿼리를 이용해 주기적으로 보고서를 생성하고 메일로 받아보도록 활용해보세요.

sonar-send-report 명령어를 사용하려면 보고서 서식의 GUID를 알아두어야 합니다. 보고서 서식 목록에서 보고서 서식의 행을 클릭하면 웹 브라우저의 주소 표시줄에서 GUID를 확인할 수 있습니다. 예를 들어 주소가 .../report/a6e2d9f1-5b74-4c38-8e91-0d2f6a4b7c53 형태라면 GUID는 a6e2d9f1-5b74-4c38-8e91-0d2f6a4b7c53입니다.

보고서 서식 삭제

보고서 서식을 삭제하려면,

1. 보고서 서식 목록에서 삭제할 보고서 서식의 정보가 있는 행의 체크박스를 선택하세요.

   

2. 도구 모음에서 삭제를 클릭하세요.

3. 보고서 서식 삭제 대화상자에서 삭제할 보고서 서식의 이름과 설명을 확인하고 삭제를 클릭하세요. 보고서 서식을 삭제하지 않으려면 취소를 클릭하세요.

   

보고서 서식 그룹 관리

보고서 서식 그룹은 등록한 보고서 서식을 관리하고 분류하기 위해 사용됩니다. 그룹은 상위 그룹 아래에 하위 그룹을 두는 계층 구조로 만들 수 있습니다.

보고서 서식 그룹 추가

보고서 서식 그룹을 추가하려면,

1. 분석 > 보고서에서 보고서 서식 그룹 트리 위에 있는 추가()를 클릭하세요.

2. 보고서 서식 그룹 추가 대화상자에서 보고서 서식 그룹 정보를 입력하고 확인을 클릭하세요. 보고서 서식 그룹을 추가하지 않으려면 취소를 클릭하세요.

   

   • 이름(필수): 보고서 서식 그룹의 이름(최대 50자, 공백만으로는 지정할 수 없음)
   • 설명: 보고서 서식 그룹에 대한 설명(최대 2,000자)
   • 상위 그룹: 새 그룹을 둘 상위 그룹. 선택 안 함으로 두면 최상위 그룹이 됩니다. 트리에서 그룹을 선택한 상태로 대화상자를 열면 그 그룹이 상위 그룹으로 미리 선택됩니다.

보고서 서식 그룹 수정

보고서 서식 그룹을 수정하려면,

1. 분석 > 보고서의 보고서 서식 그룹 트리에서 수정할 보고서 서식 그룹을 클릭하세요.

   

2. 트리 위에 있는 편집()을 클릭하세요.

3. 보고서 서식 그룹 편집 대화상자에서 수정할 사항을 반영하고 확인을 클릭하세요. 보고서 서식 그룹을 수정하지 않으려면 취소를 클릭하세요.

   

보고서 서식 그룹 삭제

보고서 서식 그룹을 삭제하려면,

1. 분석 > 보고서의 보고서 서식 그룹 트리에서 삭제할 보고서 서식 그룹을 클릭하세요.

   

2. 트리 위에 있는 삭제()를 클릭하세요.

3. 보고서 서식 그룹 삭제 대화상자에서 삭제할 보고서 서식 그룹이 맞는지 확인하고 삭제를 클릭하세요. 보고서 서식 그룹을 삭제하지 않으려면 취소를 클릭하세요.

   

   • 하위 그룹 모두 제거를 체크하면 하위 그룹이 모두 삭제되며, 삭제된 그룹들에 속해 있던 보고서 서식은 삭제한 그룹의 상위 그룹으로 이동됩니다. 상위 그룹이 없으면 보고서 서식 목록에서 그룹 열이 비어 있습니다.
   • 하위 그룹 모두 제거를 체크하지 않고 삭제하면 하위 그룹과 해당 그룹에 속해 있던 보고서 서식이 모두 상위 그룹으로 이동됩니다.

보고서 서식 그룹 이동

보고서 서식 목록에서 특정 보고서 서식의 그룹을 변경하려면,

1. 보고서 서식 목록에서 그룹을 변경할 보고서 서식의 정보가 있는 행의 체크박스를 선택하세요.

   

2. 도구 모음에서 이동을 클릭하세요.

3. 보고서 서식 이동 대화상자의 보고서 서식 그룹에서 이동할 그룹을 선택하고 확인을 클릭하세요. 보고서 서식 그룹 선택 목록에는 현재 트리에서 선택한 그룹이 표시되지 않으며, 선택 안 함을 고르면 그룹 지정이 해제됩니다. 이동하지 않으려면 취소를 클릭하세요.