-
인쇄
-
PDF
관리
-
인쇄
-
PDF
Classic/VPC 환경에서 이용 가능합니다.
관리에서는 콘솔의 프로젝트 및 그룹 메뉴와 연동된 프로젝트 및 그룹 관리 방법, 알림 설정 방법, 저장된 검색(쿼리) 관리 방법을 설명합니다.
프로젝트 관리
콘솔의 프로젝트 메뉴와 연동된 프로젝트 정보를 확인거나 로그 필드를 관리할 수 있습니다.
프로젝트 화면
Web App의 관리 > 프로젝트 메뉴의 기본적인 설명은 다음과 같습니다.
영역 | 설명 |
---|---|
① 팀명 검색창 | 팀명으로 프로젝트 검색 |
② 플랫폼 | 플랫폼을 선택 또는 선택 해제하여 프로젝트 필터링 |
③ 장기 미사용 보기 | 장기 미사용 프로젝트 보기 선택 또는 선택 해제하여 프로젝트 필터링 |
④ 보기 방식 | 위젯 또는 표로 보기 |
⑤ 정렬 방식 | 정렬 방식 선택 |
⑥ 검색창 | 프로젝트명 또는 txtToken을 기준으로 프로젝트 검색 |
⑦ 프로젝트 목록 | 보기 방식에 따라 위젯 또는 표로 프로젝트 표시
|
프로젝트 상세 정보 확인
Web App의 관리 > 프로젝트 메뉴에서 프로젝트의 상세 정보를 확인하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 프로젝트 메뉴를 클릭해 주십시오.
- 목록(위젯 또는 표)에서 확인할 프로젝트 이름을 클릭해 주십시오.
- 검색 및 필터링 기능을 활용해 프로젝트를 검색할 수 있습니다.
- 프로젝트의 상세 정보를 확인해 주십시오.
- 우측 상단의 [검색] 버튼을 클릭하면 해당 프로젝트에 대한 로그 검색을 실행할 수 있습니다.(로그 검색 참고)
- 기본 정보: 콘솔에서 생성한 해당 프로젝트의 정보 표시
- 일일 로그 사용량: 콘솔에서 설정한 일 최대 수집 Log 용량을 기준으로 현재 상태를 차트로 표시
- 지난 30일간 요청 상태: 콘솔에서 설정한 Log 보관 기간을 기준으로 검색 횟수와 검색 범위를 차트로 표시
- 로그 샘플링: 콘솔에서 설정한 Log 샘플링을 기준으로 현재 상태를 표시
- 로그 알람: 현재 준비 중
- 지난 30일간의 사용량: 콘솔에서 설정한 Log 보관 기간을 기준으로 로그 사용량을 차트로 표시
- 스키마: 로그 전송 및 검색에 사용되는 스키마를 확인하거나 신규 추가 및 관리(스키마 추가 및 관리 참고)
스키마 추가 및 관리
Web App의 관리 > 프로젝트 메뉴에서 프로젝트의 스키마를 추가, 수정, 삭제하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 프로젝트 메뉴를 클릭해 주십시오.
- 목록(위젯 또는 표)에서 프로젝트 이름을 클릭해 주십시오.
- 검색 및 필터링 기능을 활용해 프로젝트를 검색할 수 있습니다.
- 프로젝트 상세 정보 화면의 스키마 영역에서 [스키마 추가] 버튼을 클릭해 주십시오.
- 필드 추가 팝업 창에서 필드 정보를 입력 및 선택한 후 [저장] 버튼을 클릭해 주십시오.
- field name: 생성할 필드의 이름 입력
- data type: 데이터 타입 선택
- data format: 데이터 타입을 date로 선택했을 때 표시
- 필드가 생성되어 목록에 표시됩니다.
- 필요에 따라, 추가한 필드를 수정 또는 삭제해 주십시오.
- 프로젝트의 기본 필드는 수정하거나 삭제할 수 없습니다.
- 추가한 필드를 편집하려면 을 클릭한 후 필드를 수정하고 [저장] 버튼을 클릭해 주십시오.
- 추가한 필드를 삭제하려면 을 클릭한 후 [확인] 버튼을 클릭해 주십시오.
- 스키마 목록의 검색 창에서 필드 이름으로 필드를 검색할 수도 있습니다.
- 수집된 로그에서 새로운 필드가 발견될 경우 스키마에 해당 필드가 추가됩니다. 추가된 필드는 기본으로
String
타입을 가집니다. 데이터 연산이 필요할 경우 스키마에 추가된 필드를 연산에 알맞는 타입으로 변경해야 합니다. - 20시 45분 이전에 필드 타입을 변경할 경우 변경일 다음 날 수집되는 데이터부터 변경된 타입이 적용됩니다. 이후에 필드 타입을 변경할 경우 변경일 이틀 후 수집되는 데이터부터 적용됩니다.
- 스키마는 일 단위로 적용되기 때문에 적용 이전에 수집된 데이터는 타입 변경이 되지 않습니다.
그룹 관리
콘솔의 그룹 메뉴와 연동된 그룹 정보를 확인할 수 있습니다.
- 대부분의 NELO 기능이 프로젝트 기준으로 제공되지만 키바나의 대시보드 기능은 그룹 단위를 사용합니다.
- 기본 그룹을 설정하는 방법은 시스템 설정을 참고해 주십시오.
그룹 화면
Web App의 관리 > 그룹 메뉴의 기본적인 설명은 다음과 같습니다.
영역 | 설명 |
---|---|
① 보기 방식 | 위젯 또는 표로 보기 |
② 정렬 방식 | 정렬 방식 선택 |
③ 검색창 | 그룹 이름을 기준으로 프로젝트 검색 |
④ 그룹 목록 | 보기 방식에 따라 위젯 또는 표로 그룹 표시
|
그룹 상세 정보 확인
Web App의 관리 > 그룹 메뉴에서 그룹의 상세 정보를 확인하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 그룹 메뉴를 클릭해 주십시오.
- 목록(위젯 또는 표)에서 확인할 그룹 이름을 클릭해 주십시오.
- 검색 및 필터링 기능을 활용해 그룹을 검색할 수 있습니다.
- 그룹의 상세 정보를 확인해 주십시오.
알람 관리
알람 기능을 통해 특정 루씬 쿼리를 만족하는 로그의 수가 일정 기준치 이상 검출 시, 사용자가 설정한 방법으로 알람을 보내도록 설정할 수 있습니다.
알람 화면
Web App의 관리 > 알람 메뉴의 기본적인 설명은 다음과 같습니다.
영역 | 설명 |
---|---|
① 검색 | 알람 검색 조건 설정
|
② 긴급도 | 긴급도 레벨을 기준으로 알람 필터링 |
③ 마지막 상태 변화 | 시간 범위를 직접 입력해 알람 필터링
|
④ 프로젝트 | 프로젝트를 검색 및 선택해 알람 필터링 |
⑤ 보기 방식 | 위젯 또는 표로 보기 |
⑥ 알람 추가 | 신규 알람 추가 |
⑦ 정렬 방식 | 정렬 방식 선택 |
⑧ 검색창 | 알람 이름을 기준으로 알람 검색 |
⑨ 알람 목록 | 보기 방식에 따라 위젯 또는 표로 표시 |
알람 상세 정보 확인
Web App의 관리 > 알람 메뉴에서 알람의 상세 정보를 확인하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 알람 메뉴를 클릭해 주십시오.
- 목록(위젯 또는 표)에서 확인할 알람 이름을 클릭해 상세 정보를 확인해 주십시오.
- 검색 및 필터링 기능을 활용해 프로젝트를 검색할 수 있습니다.
- 알람의 상세 정보에 대한 자세한 내용은 알람 추가를 참고해 주십시오.
- 기본 정보: 알람 생성 시 설정한 알람의 정보 표시
- 조건: 알람 생성 시 설정한 해당 알람의 조건 및 설명 표시
- Detail Setting: 알람 생성 시 설정한 상세 설정 옵션
- 세션: 세션 데이터 및 상태 표시
- 히스토리: 해당 알람 작업 내역 표시
알람 추가
Web App의 관리 > 알람 메뉴에서 알람을 추가하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 알람 메뉴를 클릭해 주십시오.
- [알람 추가] 버튼을 클릭해 주십시오.
- 알람 추가 팝업 창에서 알람 추가 정보를 입력해 주십시오.
- 기본 정보
- 이름: 생성할 알람 이름 입력
- 긴급도: 긴급도 레벨 선택
- 프로젝트: 알람 대상 프로젝트 선택
- 쿼리: 알람 실행할 쿼리 입력
- 조건
- 임곗값: Window에서 설정한 Range와 Every 조건에서 이상이 탐지되는 임곗값(로그 수)을 입력
- >=: 입력한 로그 수 이상인 경우 선택
- <=: 입력한 로그 수 이하인 경우 선택
- 시간 및 요일에 따라 임곗값을 변경하려면 시간 및 요일에 따라 임계값이 바뀌기를 원하시나요?를 선택해 활성화한 후 추가 표시된 Variable threshold 항목을 설정해 주십시오.
- Window: Range와 Every 조건을 입력
- 최종 알람 설정: 설정한 임곗값 및 Window에 대한 설명 표시
- 임곗값: Window에서 설정한 Range와 Every 조건에서 이상이 탐지되는 임곗값(로그 수)을 입력
- 상세 설정(상세 설정 더 보기 클릭 시)
- 그룹화할 필드: 그룹화할 필드 입력
- 그룹화는 >= 조건만 지원합니다.
- 콜백: 콜백 조건 설정
- [+] 버튼을 클릭해 콜백 추가 팝업 창에서 설정해 주십시오.
- Status: 콜백 적용 여부 선택
- URL: 이벤트 발생 시 호출할 콜백 URL 입력
- Headers: 이벤트 발생 시 콜백 URL로 전달할 헤더명 및 값 정보 입력
- 템플릿: 이벤트 발생 시 콜백 URL로 전달할 메시지를 JSON 타입으로 입력(단, 이벤트 정보를 전달하기 위해서는 ELSA2.0에서 지원하는 변수를 사용해야 함(템플릿 변수 일람표 참고))
- 설명: 상세 설정에 대한 설명 입력
- 그룹화할 필드: 그룹화할 필드 입력
- 기본 정보
- [저장] 버튼을 클릭해 주십시오.
- 알람이 생성되어 목록에 표시됩니다.
템플릿 변수 일람표
콜백 기능에서 사용하는 템플릿 변수는 다음과 같습니다.
일람표에서 형식이 N/A 표시된 변수는 문자열이지만, 특정한 포맷을 따를 것이 보장되지 않기 때문에 기계적으로 해석하기보다는 사용자에게 보여주기 위한 용도로만 사용되어야 합니다. 또한 형식이 N/A인 변수의 문자열 규격은 예고 없이 변경될 수 있습니다.
알람의 명세(Specification) 관련 변수
- 다음 일람표에 나열된 변숫값은 사용자가 알람 규칙을 업데이트하지 않는 한 일정합니다. 다만 시간표 기능이 켜진 경우
threshold
계열 변수는 요일과 시각에 따라 다른 값으로 치환될 수 있습니다. {{summary.template}}
변수는 콜백 알람의 JSON 템플릿으로만 사용할 수 있고, 요약문 생성을 위한 템플릿 처리에는 무시됩니다.
변수 | 형식 | 설명 |
---|---|---|
{{id}} |
integer | 알람의 ID (NELO에서 이 알람을 지칭하는 식별자) |
{{url}} |
string(URL) | 알람 상세 페이지 URL |
{{name}} |
string | 알람의 이름 |
{{level}} |
integer | 알람의 긴급도 레벨(urgent level) |
{{description}} |
string | 알람에 대해 사용자가 적어둔 설명 (설명이 없다면 빈 문자열) |
{{description.html_escaped}} |
string | HTML 태그가 이스케이핑된 {{description}} |
{{query}} |
string | 알람의 루씬 쿼리 |
{{url.search}} |
string(URL) | {{project.id}} 와 {{query}} 에 대해 최근 로그를 확인할 수 있는 URL |
{{project.id}} |
integer | 알람과 관련된 프로젝트의 ID(NELO에서 프로젝트를 지칭하는 식별자) |
{{project.key}} |
알람 관련 프로젝트의 프로젝트 키(projectKey) | |
{{project.name}} |
string | 알람 관련 프로젝트의 이름 |
{{project.url}} |
string(URL) | 알람 관련 프로젝트의 상세 페이지 URL |
{{range.seconds}} |
integer | 검색 범위(단위: 초) |
{{interval.seconds}} |
integer | 검색 주기(단위: 초) |
{{group_by}} |
string | 그룹화 조건이 있다면 그룹화에 이용되는 필드 이름, 그룹화 조건이 없다면 빈 문자열 |
{{threshold.value}} |
integer | 임곗값(시간표 기능에 의해 알람이 꺼진 경우 -1) |
{{threhsold.operator}} |
string(off, le, ge 중 하나) | 임곗값 비교 조건이 '이상'인 경우 ge , '이하'인 경우 le . 단, 시간표 기능에 의해 알람이 꺼진 경우 off |
{{threshold.pretty}} |
N/A | {{threshold.operator}} 와 {{threshold.value}} 에 대한 설명문 |
{{threshold.pretty.range}} |
N/A | {{threshold.operator}} 와 {{threshold.value}} 및 {{window.range}} 에 대한 설명문 |
{{summary.template}} |
string | 사용자가 요약문 템플릿을 정의한 경우 해당 템플릿(그렇지 않으면 빈 문자열) |
알람의 상태(Status) 관련 변수
{{summary}}
변수는 콜백 알람의 JSON 템플릿으로만 사용할 수 있고, 요약문 생성을 위한 템플릿 처리에는 무시됩니다.
변수 | 형식 | 설명 |
---|---|---|
{{status}} |
string(firing 또는 resolved) | 알람의 현재 상태 |
{{status.previous}} |
string(firing 또는 resolved) | 알람의 직전 상태 |
{{status.emoji}} |
N/A | 알람의 현재 상태와 시급도에 맞는 이모지(emoji) 문자열 |
{{status.color}} |
string (#으로 시작하는 RGB 컬러 코드) | 알람의 현재 상태에 어울리는 색깔 코드 |
{{status.since}} |
integer(Unixepoch 시간, 단위: 초) | 알람이 현재 상태를 획득한 것이 언제인지를 알려주는 정수 |
{{status.since.pretty}} |
N/A | {{status.since}} 에 대해 사용자가 파악하기 쉬운 문자열(템플릿이 처리될 때를 기준으로 한 상대 시각) |
{{summary}} |
string | 사용자가 요약문 템플릿을 정의했고, {{status}} 가 firing 이면 해당 템플릿으로부터 만든 요약문, 그렇지 않으면 NELO 시스템에 내장된 규칙으로 생성한 요약문 |
{{session.duration}} |
integer (단위: 초) | 이 알람과 관련된 세션의 현재 길이(firing 일 경우 현재 활성화(active)된 세션, resolved 일 경우 닫힌 세션) |
{{session.duration.pretty}} |
N/A | {{session.duration}} 에 대해 사람이 읽기 쉬운 설명 |
최근 이벤트의 로그 검색 결과와 관련된 변수
변수 | 형식 | 설명 |
---|---|---|
{{window.start}} |
integer(Unixepoch 시간, 단위: 초) | 검색 범위의 시작 시각 |
{{window.end}} |
integer(Unixepoch시간, 단위: 초) | 검색 범위의 끝 시각 |
{{window.url}} |
string(URL) | 검색 화면으로 가는 URL |
{{window.logs}} |
integer | 검색 화면 내에 검출된 로그 개수 |
{{last_log}} |
string(JSON) | 검색 화면 내에 있는 가장 최근 로그 (JSON 형식) |
{{fields.user}} 등 fields. 으로 시작하는 변수 |
string | 안에 있는 특정 필드 값 |
기타 변수
변수 | 형식 | 설명 |
---|---|---|
{{reigon.pretty}} |
N/A | NELO 인스턴스를 나타내는 문자열 |
{{region.host}} |
string(domainname) | NELO 인스턴스의 주소 |
{{region.url}} |
string (URL) | NELO 인스턴스의 URL |
{{{{ |
string | {{ 로 항상 치환됨 |
}}}} |
string | }} 로 항상 치환됨 |
알람 수정
Web App의 관리 > 알람 메뉴에서 알람을 수정하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 알람 메뉴를 클릭해 주십시오.
- 목록(위젯 또는 표)에서 확인할 알람 이름을 클릭해 주십시오.
- 검색 및 필터링 기능을 활용해 프로젝트를 검색할 수 있습니다.
- [편집] 버튼을 클릭해 주십시오.
- 기본 정보와 조건 및 상세 설정 옵션을 수정해 주십시오.
- 자세한 내용은 알람 추가를 참고해 주십시오.
- [저장] 버튼을 클릭해 주십시오.
알람 삭제
Web App의 관리 > 알람 메뉴에서 알람을 삭제하는 방법은 다음과 같습니다.
알람 삭제 시 알람에 저장된 모든 내용이 삭제되며 복구할 수 없습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 알람 메뉴를 클릭해 주십시오.
- 목록(위젯 또는 표)에서 확인할 알람 이름을 클릭해 주십시오.
- 검색 및 필터링 기능을 활용해 프로젝트를 검색할 수 있습니다.
- [삭제] 버튼을 클릭해 주십시오.
- 삭제 확인 팝업 창에서 [확인] 버튼을 클릭해 주십시오.
- 알람이 삭제되어 목록에서 사라집니다.
저장된 검색 관리
Web App의 관리 > 저장된 검색 메뉴에서 저장된 쿼리를 확인하거나 추가, 수정, 삭제 등의 관리를 할 수 있습니다.
저장된 검색 화면
Web App의 관리 > 저장된 검색 메뉴의 기본적인 설명은 다음과 같습니다.
영역 | 설명 |
---|---|
① 삭제 | 목록에서 선택한 검색 삭제 |
② 검색 추가 | 신규 검색 추가 |
③ 검색창 | 제목을 기준으로 제목 검색 |
④ 목록 | 저장한 검색 항목을 목록으로 표시 |
검색 추가
Web App의 관리 > 저장된 검색 메뉴에서 검색을 추가하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 저장된 검색 메뉴를 클릭해 주십시오.
- [검색 추가] 버튼을 클릭해 주십시오.
- 검색 추가 팝업 창에서 검색 추가 정보를 입력해 주십시오.
- 데이터 소스: 프로젝트 또는 그룹 이름을 검색해 선택
- 최근에 검색한 프로젝트 또는 그룹이 있는 경우 필드 클릭 시 해당 프로젝트와 그룹이 자동으로 표시됩니다.
- 제목: 추가할 검색 제목 입력
- 쿼리: 검색할 쿼리 구문을 입력
- 설명: 검색에 대한 설명을 입력
- 데이터 소스: 프로젝트 또는 그룹 이름을 검색해 선택
- [저장] 버튼을 클릭해 주십시오.
- 검색이 생성되어 목록에 표시됩니다.
Web App의 검색 메뉴에서 로그 검색 시 사용한 쿼리도 검색으로 저장할 수 있습니다. 자세한 내용은 검색 화면을 참고해 주십시오.
검색 수정
Web App의 관리 > 저장된 검색 메뉴에서 저장된 검색을 수정하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 저장된 검색 메뉴를 클릭해 주십시오.
- 목록에서 수정할 검색의 을 클릭해 주십시오.
- 검색 정보를 수정해 주십시오.
- 자세한 내용은 검색 추가를 참고해 주십시오.
- [저장] 버튼을 클릭해 주십시오.
검색 삭제
Web App의 관리 > 저장된 검색 메뉴에서 저장된 검색을 삭제하는 방법은 다음과 같습니다.
검색 삭제 시 검색에 저장된 모든 내용이 삭제되며 복구할 수 없습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 저장된 검색 메뉴를 클릭해 주십시오.
- 목록에서 삭제할 검색을 선택한 후 [삭제] 버튼을 클릭해 주십시오.
- 또는 각 검색 항목의 을 클릭해 주십시오.
- 삭제 확인 팝업 창에서 [확인] 버튼을 클릭해 주십시오.
- 검색이 삭제되어 목록에서 사라집니다.
검색 실행
Web App의 관리 > 저장된 검색 메뉴에서 저장된 검색으로 로그를 검색하는 방법은 다음과 같습니다.
- Web App에 접속해 주십시오.(Web App 접속 참고)
- 관리 > 저장된 검색 메뉴를 클릭해 주십시오.
- 목록에서 로그를 검색할 검색의 을 클릭해 주십시오.
- 로그 검색 화면으로 이동합니다. 로그 검색에 대한 자세한 내용은 검색을 참고해 주십시오.
키바나 > 대시보드 메뉴에서 저장한 쿼리는 검색 메뉴에서 사용할 수 없으며, 키바나 > 대시보드 또는 키바나 > 시각화 메뉴에서 새로운 위젯 추가 시 데이터 소스로 활용됩니다. 자세한 내용은 대시보드를 참고해 주십시오.