Cloud Monitoring API 소개

이 페이지에서는 Cloud Monitoring API v3의 몇 가지 기능에 대해 설명합니다.

API 참고 문서는 다음 페이지를 확인하세요.

Monitoring API의 프로젝트 이름

Monitoring API의 모든 메서드에는 필수 name 매개변수가 있습니다. 이 매개변수의 설명은 일반적으로 다음과 같습니다.

필수입니다. 요청을 실행할 프로젝트입니다. 형식은 다음과 같습니다.
projects/[PROJECT_ID_OR_NUMBER]

Monitoring API에서 PROJECT_ID_OR_NUMBER 값은 다음 중 하나를 식별합니다.

Monitoring API의 일부 메서드는 프로젝트가 측정항목 범위의 범위 프로젝트가 되어야 하지만 일부 메서드는 그렇지 않습니다. 소수의 메서드에서는 프로젝트 유형에 따라 다른 결과를 반환할 수 있습니다.

이러한 메서드 클래스에 대해 설명하기 위해 이 논의에서는 metrics API라는 용어를 사용하여 Monitoring API의 다음 리소스를 참조합니다.

필요한 측정항목 범위의 범위 지정 프로젝트

측정항목 API의 일부가 아닌 모든 Monitoring API 메서드는 name 매개변수가 있어야 측정항목 범위의 범위 지정 프로젝트를 참조할 수 있습니다.

측정항목 범위의 범위 지정 프로젝트가 필요 없음

Metrics API의 메서드에 name 매개변수가 없어도 측정항목 범위의 범위 지정 프로젝트를 참조할 수 있지만 다음과 같은 상황에서 일부 메서드가 다르게 작동합니다.

  • Metrics API의 다음 메서드가 이름이 지정된 Google Cloud 프로젝트에서 작동합니다. 이 메서드는 측정항목 범위의 범위 지정 프로젝트인지 여부와 관계없이 이름이 지정된 프로젝트의 데이터에만 영향을 미칩니다.

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • Metrics API의 나머지 메서드는 다음과 같이 동작합니다.

    • 이름이 지정된 프로젝트가 측정항목 범위의 범위 지정 프로젝트가 아닌 경우에는 메서드가 이름이 지정된 프로젝트에서만 데이터를 검색합니다.
    • 이름이 지정된 프로젝트가 측정항목 범위의 범위 지정 프로젝트인 경우에는 메서드가 이름이 지정된 프로젝트와 모니터링되는 프로젝트에서 데이터를 가져옵니다.

    이 그룹의 메서드는 다음과 같습니다.

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

Google Cloud 프로젝트를 측정항목 범위의 범위 지정 프로젝트로 설정하는 방법에 대한 자세한 내용은 측정항목 범위 개요를 참조하세요.

API 리소스

측정항목

Monitoring API를 사용하면 Google Cloud와 Amazon Web Services에서 약 6,500개의 Cloud Monitoring 측정항목에 액세스할 수 있습니다. 사용자는 고유한 커스텀 측정항목을 만들고 그룹을 사용하여 클라우드 리소스를 구성할 수 있습니다.

측정항목 개념과 이를 나타내는 데이터 구조에 대한 소개는 측정항목, 시계열, 리소스를 참조하세요.

커스텀 측정항목 및 기본 제공 측정항목을 관리하는 방법은 사용자 정의 측정항목 개요를 참조하세요.

사용 가능한 측정항목의 전체 목록은 측정항목 목록을 참조하세요.

모니터링 리소스

모니터링 리소스는 수집되는 측정항목입니다. 예를 들어 VM 인스턴스 또는 하드웨어의 활동에 관심이 있을 수 있습니다.

사용할 수 있는 모니터링 리소스 목록은 모니터링 리소스 목록을 참조하세요.

모니터링 리소스 그룹

그룹은 모니터링 리소스의 동적 컬렉션입니다. 항상 Google Cloud 콘솔에서 직접 그룹을 만들 수 있으며 Cloud Monitoring API를 사용하여 그룹을 만들고 사용하는 코드를 작성할 수도 있습니다.

자세한 내용은 Group의 API 참조를 확인하세요.

알림 정책

알림 정책은 이슈를 생성하는 기준과 이슈가 생성될 때 이를 알리는 방법을 설명하는 구성 리소스입니다. 알림 개념은 알림 정책에 관한 기본적인 개념을 설명합니다. 자세한 내용은 AlertPolicy의 API 참조를 확인하세요.

또한 API를 사용하면 두 가지 측정항목의 비율에 따라 알림 정책을 만들 수도 있습니다. 현재는 Google Cloud 콘솔에서 Monitoring을 사용하여 비율을 생성할 수 없습니다. 자세한 내용은 AlertPolicy 참조의 MetricThreshold를 참조하세요.

알림 채널

알림 채널은 이슈가 발생할 때 이를 알리는 방법을 설명하는 구성 리소스입니다. 알림 채널은 다양한 종류의 통신 서비스 및 엔드포인트를 참조할 수 있으며 이러한 내용은 설명자에 명시됩니다. 설명자에 따라 채널 객체에 포함되는 구성 매개변수 집합이 결정됩니다.

자세한 내용은 NotificationChannel 참조 및 NotificationChannelDescriptor 참조를 확인하세요.

서비스 모니터링

서비스 모니터링 리소스는 서비스 상태를 모니터링하는 데 사용할 수 있는 서비스 수준 목표를 설정하는 데 사용됩니다.

서비스 모니터링은 Monitoring API에 다음 리소스를 추가합니다.

이러한 서비스 모니터링 개념과 API 사용에 대한 자세한 내용은 SLO 모니터링을 참조하세요.

대시보드

Dashboards 엔드포인트를 사용하여 프로그래매틱 방식으로 대시보드와 차트를 만들고 조작할 수 있습니다. 이 엔드포인트를 사용하여 대시보드 및 차트를 관리하는 방법은 API로 대시보드 관리를 참조하세요.

Monitoring Query Language

Monitoring Query Language(MQL)는 Cloud Monitoring 시계열 데이터를 쿼리하기 위한 텍스트 기반 인터페이스를 제공합니다. MQL은 파이프 쿼리 모델을 사용하며 Monitoring 필터보다 더 표현적입니다. Monitoring API 또는 코드 편집기에서 MQL 쿼리를 사용할 수 있습니다.

MQL에 대한 일반적인 내용은 Monitoring Query Language 사용을 참조하세요.

Monitoring API를 사용하여 시계열 데이터를 검색하기 위해 MQL을 사용하는 방법에 대한 자세한 내용은 timeSeries.query 메서드의 API 참조를 확인하세요.

필터

Monitoring API는 필터를 사용하여 측정항목을 선택하고 시계열 데이터를 가져오고 모니터링 리소스를 그룹으로 수집합니다. 자세한 내용은 Monitoring 필터를 참조하세요.

또한 Monitoring API는 필터를 사용하여 특정 list 작업의 결과 집합을 제한하기도 합니다. alertPolicies.list 및 notificationChannels.list 메서드의 결과 관리에 대한 자세한 내용은 정렬 및 필터링을 참조하세요.

다음 단계