사용자 정의 지표와 로그
ServiceWatch는 사용자가 직접 정의한 사용자 정의 지표를 수집할 수 있고 사용자가 생성한 자원으로부터 로그 파일을 수집할 수 있습니다.
사용자 정의 지표와 로그를 수집할 수 있는 방법은 2가지로 제공됩니다.
첫번째는 ServiceWatch Agent를 자원에 직접 설치하여 수집할 자원을 설정하여 수집할 수 있습니다.
두번째는 ServiceWatch에서 제공하는 OpenAPI/CLI를 통해 사용자 정의 지표와 로그를 수집할 수 있습니다.
ServiceWatch의 지표 API는 호출에 대한 비용이 발생합니다. ServiceWatch Agent를 통한 지표 수집 역시 OpenAPI 기반으로 동작하기 때문에 지표 API 호출에 대한 비용이 발생합니다.
지표 및 로그 수집을 위해 과도하게 API 호출하지 않도록 주의가 필요합니다. 과금 대상 지표 API는 아래와 같습니다.
| API | 설명 |
|---|---|
| ListMetricData | 지표 데이터 목록 조회.
|
| DownloadMetricDataImage | 지표 데이터 위젯 이미지 다운로드.
|
| ListMetricInfos | 지표 데이터 조회.
|
| CreateCustomMetricMetas | 사용자 정의 지표 메타 데이터 생성
|
| CreateCustomMetrics | 사용자 정의 지표 데이터 생성(전송)
|
| ShowDashboard | 대시보드 조회
|
| ListDashboards | 대시보드 목록 조회
|
| CreateDashboard | 대시보드 생성
|
| SetDashboard | 대시보드 수정
|
| DeleteBulkDashboards | 대시보드 삭제
|
로그는 수집 용량에 따라 요금이 발생하기 때문에 API 호출에 대한 과금은 별도로 추가되지 않습니다.
※ 자세한 요금 정보는 Samsung Cloud Platform Service Portal에서 ServiceWatch 요금 정보를 참고하세요.
ServiceWatch Agent
사용자의 자원인 Virtual Server/GPU Server/Bare Metal Server 등에서 ServiceWatch Agent를 설치하여 사용자 정의 지표와 로그를 수집할 수 있습니다.
ServiceWatch Agent 제약 사항
ServiceWatch Agent 네트워크 환경
ServiceWatch Agent는 기본적으로 OpenAPI를 사용하여 수집하는 구조로 설계되었으며 따라서 서버 자원에 설치하여 사용하기 위해서는 인터넷 통한 외부 통신이 가능해야합니다. 자원이 위치한 VPC에 Internet Gateway를 생성하고 서버 자원에 NAT IP를 설정하여 외부와 통신할 수 있도록 설정하시기 바랍니다.
ServiceWatch Agent 지원 OS Image
ServiceWatch Agent를 사용 가능한 OS Image는 다음과 같습니다.
| OS Image 버전 | EOS Date |
|---|---|
| Alma Linux 8.10 | 2029-05-31 |
| Alma Linux 9.6 | 2025-11-17 |
| Oracle Linux 8.10 | 2029-07-31 |
| Oracle Linux 9.6 | 2025-11-25 |
| RHEL 8.10 | 2029-05-31 |
| RHEL 9.4 | 2026-04-30 |
| RHEL 9.6 | 2027-05-31 |
| Rocky Linux 8.10 | 2029-05-31 |
| Rocky Linux 9.6 | 2025-11-30 |
| Ubuntu 22.04 | 2027-06-30 |
| Ubuntu 24.04 | 2029-06-30 |
| Windows 2019 | 2029-01-09 |
| Windows 2022 | 2031-10-14 |
Virtual Server 제공 OS Image와 동일하게 제공합니다. Virtual Server > OS Image 제공 버전을 참고하세요.
ServiceWatch Agent 사용을 위한 Quick Guide
아래에서는 Linux 환경에서 Virtual Server의 OS 지표와 로그 수집을 위한 Quick guide를 소개합니다.
Node Exporter 설치 및 설정하기
- Node Exporter 설치를 참고하여 서버에 사용자 정의 지표 수집을 위한 Node Exporter를 설치합니다.
- Node Exporter를 설치하면 ServiceWatch에서 기본 모니터링으로 제공하는 지표 이외에 Node Exporter를 통해 OS 지표를 수집할 수 있습니다.
- ServiceWatch Agent 설정을 참고하여 ServiceWatch_Agent 압축파일을 다운로드 받은 뒤, ServiceWatch Manager 설정 및 실행합니다.
- 압축파일 내의 examples/os-metric-min-examples 폴더를 참고하면 최소(2개) 지표를 설정하여 ServiceWatch Agent를 실행할 수 있습니다.
ServiceWatch Agent를 통한 지표 수집은 사용자 정의 지표로 구분되어 각 서비스로부터 기본으로 수집되는 지표와는 달리 요금이 부과되므로, 불필요한 메트릭 수집 설정을 하지 않도록 주의해야 합니다. 반드시 수집이 필요한 지표만 수집될 수 있도록 설정하세요.
- 무료 제공은 Account/리전별 10개까지 제공됩니다.
ServiceWatch 사용자 정의 지표 및 로그 API
ServiceWatch에서 제공하는 OpenAPI/CLI를 통해 사용자 정의 지표와 로그를 수집할 수 있습니다.
사용자 정의 지표 데이터와 사용자 정의 로그를 ServiceWatch OpenAPI/CLI를 통해 ServiceWatch로 전달하여 Console에서 시각화된 정보를 확인할 수 있습니다.
ServiceWatch OpenAPI/CLI를 통한 지표 수집은 사용자 정의 지표로 구분되어 각 서비스로부터 기본으로 수집되는 지표와는 달리 요금이 부과되므로, 불필요한 메트릭 수집 설정을 하지 않도록 주의해야 합니다. 반드시 수집이 필요한 지표만 수집될 수 있도록 설정하세요.
- 무료 제공은 Account/리전별 10개까지 제공됩니다.
사용자 정의 지표 메타 데이터 생성
Samsung Cloud Platform의 서비스(예시: Virtual Server 등)에서 제공하는 지표가 아닌 사용자의 자원이나 애플리케이션에서 발생하는 지표 데이터를 ServiceWatch로 수집하기 위해서 사용자 정의 지표 메타 데이터를 생성해야 합니다.
| Parameter | 설명 |
|---|---|
| namespace | ServiceWatch에서 다른 지표들과 구분할 수 있는 네임스페이스를 사용자가 정의할 수 있음
|
| metricMetas > metricName | 수집하고자 하는 지표 이름 설정. 지표명은 영문, 숫자, 특수문자(_)를 포함하여 3~128자로 작성해야하며, 영문으로 시작해야 함.
|
| metricMetas > storageResolution | 해당하는 지표의 수집 주기를 설정. 기본값은 60(1분)으로 초단위로 설정 가능 |
| metricMetas > unit | 지표의 단위 설정 가능
|
| metricMetas > dimensions | 사용자 정의 지표 데이터의 식별하기 위해 차원을 설정하여 Console에서 시각화하여 보여줄 수 있음. 수집한 지표를 Console에 시각화하여 보여줄 때, 차원(dimensions) 설정에 따라 조합하여 표시 |
| metricMetas > descriptionKo | 수집하는 지표에 대한 국문 설명 |
| metricMetas > descriptionEn | 수집하는 지표에 대한 영문 설명 |
사용자 정의 지표 메타 데이터 생성을 위한 자세한 내용은 CreateCustomMetricMetas를 참고하세요.
사용자 정의 지표 생성
사용자 정의 지표 메타 데이터를 생성한 후 발생한 지표 데이터를 CreateCustomMetrics API를 사용하여 ServiceWatch로 전달할 수 있습니다.
전달된 지표 데이터는 설정한 네임스페이스로 구분되어 조회할 수 있습니다.
사용자 정의 지표 데이터 생성을 위한 자세한 내용은 CreateCustomMetrics를 참고하세요.
지표 데이터 조회
사용자 정의 지표를 포함한 지표 데이터 Console과 ListMetricInfos, ListMetricInfos API를 사용하여 조회할 수 있습니다.
지표 데이터 조회를를 위한 자세한 내용은 ListMetricInfos와 ListMetricData를 참고하세요.
로그 스트림 생성
사용자 정의 로그 수집을 위해서는 ServiceWatch 로그 그룹이 필요합니다. 로그 그룹은 Console에서만 생성할 수 있습니다. 미리 로그 그룹을 생성한 후 로그 스트림 생성 API를 사용하여 ServiceWatch로 전달할 로그 스트림을 생성할 수 있습니다.
로그 스트림 생성을 위한 자세한 내용은 CreateCustomLogStream을 참고하세요.
로그 이벤트 생성
사용자 정의 로그 수집을 위해 로그 그룹과 로그 스트림을 생성한 후 개별 로그 메시지(로그 이벤트)를 ServiceWatch로 전달하기 위해서 로그 이벤트 생성 API를 사용합니다.
로그 이벤트 생성을 위한 자세한 내용은 CreateCustomLogEvents을 참고하세요.